Package org.apache.cassandra.concurrent

Interface ExecutorPlus

All Superinterfaces:

Executor, ExecutorService, ResizableThreadPool

All Known Subinterfaces:

LocalAwareExecutorPlus, LocalAwareSequentialExecutorPlus, ScheduledExecutorPlus, SequentialExecutorPlus

All Known Implementing Classes:

CompactionManager.ValidationExecutor, ImmediateExecutor, LocalAwareSingleThreadExecutorPlus, LocalAwareThreadPoolExecutorPlus, ScheduledThreadPoolExecutorPlus, SEPExecutor, SingleThreadExecutorPlus, ThreadPoolExecutorPlus, WrappedExecutorPlus

public interface ExecutorPlus
extends ExecutorService, ResizableThreadPool

Cassandra's extension of ExecutorService, using our own Future, supporting inExecutor(), and execution with associated resources execute(WithResources, Runnable) (which is primarily used for encapsulating ExecutorLocals without leaking implementing classes).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ExecutorPlus.MaximumPoolSizeListener

Method Summary

Modifier and Type	Method	Description
void	execute(WithResources withResources, Runnable task)	Invoke task.
boolean	inExecutor()
default <T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks)
default <T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
default <T> T	invokeAny(Collection<? extends Callable<T>> tasks)
default <T> T	invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
default void	maybeExecuteImmediately(Runnable task)	MAY execute task immediately, if the calling thread is permitted to do so.
Future<?>	submit(Runnable task)	Overrides ExecutorService.submit(Runnable) to return a Cassandra Future
<T> Future<T>	submit(Runnable task, T result)	Overrides ExecutorService.submit(Runnable, Object) to return a Cassandra Future
<T> Future<T>	submit(Callable<T> task)	Overrides ExecutorService.submit(Callable) to return a Cassandra Future
Future<?>	submit(WithResources withResources, Runnable task)	Invoke task, returning a future yielding null if successful, or the abnormal termination of task otherwise.
<T> Future<T>	submit(WithResources withResources, Runnable task, T result)	Invoke task, returning a future yielding result if successful, or the abnormal termination of task otherwise.
<T> Future<T>	submit(WithResources withResources, Callable<T> task)	Invoke task, returning a future representing this computation.

Methods inherited from interface java.util.concurrent.Executor

execute

Methods inherited from interface java.util.concurrent.ExecutorService

awaitTermination, isShutdown, isTerminated, shutdown, shutdownNow

Methods inherited from interface org.apache.cassandra.concurrent.ResizableThreadPool

getActiveTaskCount, getCompletedTaskCount, getCorePoolSize, getMaximumPoolSize, getMaxTasksQueued, getPendingTaskCount, oldestTaskQueueTime, setCorePoolSize, setMaximumPoolSize

Method Details

maybeExecuteImmediately

default void maybeExecuteImmediately(Runnable task)

MAY execute task immediately, if the calling thread is permitted to do so.

submit

<T> Future<T> submit(Callable<T> task)

Overrides ExecutorService.submit(Callable) to return a Cassandra Future

Specified by:

submit in interface ExecutorService

submit

<T> Future<T> submit(Runnable task,
 T result)

Overrides ExecutorService.submit(Runnable, Object) to return a Cassandra Future

Specified by:

submit in interface ExecutorService

submit

Future<?> submit(Runnable task)

Overrides ExecutorService.submit(Runnable) to return a Cassandra Future

Specified by:

submit in interface ExecutorService

execute

void execute(WithResources withResources,
 Runnable task)

Invoke task. The invoking thread will first instantiate the resources provided before invoking task, so that thread state may be modified and cleaned up. The invoking thread will execute something semantically equivlent to: try (Closeable close = withResources.get()) { task.run(); }

Parameters:

withResources - the resources to create and hold while executing task

task - the task to execute

submit

<T> Future<T> submit(WithResources withResources,
 Callable<T> task)

Invoke task, returning a future representing this computation. The invoking thread will first instantiate the resources provided before invoking task, so that thread state may be modified and cleaned up. The invoking thread will execute something semantically equivlent to: try (Closeable close = withResources.get()) { return task.call(); }

Parameters:

withResources - the resources to create and hold while executing task

task - the task to execute

submit

Future<?> submit(WithResources withResources,
 Runnable task)

Invoke task, returning a future yielding null if successful, or the abnormal termination of task otherwise. The invoking thread will first instantiate the resources provided before invoking task, so that thread state may be modified and cleaned up try (Closeable close = withResources.get()) { task.run(); return null; }

Parameters:

withResources - the resources to create and hold while executing task

task - the task to execute

submit

<T> Future<T> submit(WithResources withResources,
 Runnable task,
 T result)

Invoke task, returning a future yielding result if successful, or the abnormal termination of task otherwise. The invoking thread will first instantiate the resources provided before invoking task, so that thread state may be modified and cleaned up. The invoking thread will execute something semantically equivlent to: try (Closeable close = withResources.get()) { task.run(); return result; }

Parameters:

withResources - the resources to create and hold while executing task

task - the task to execute

result - the result if successful

inExecutor

boolean inExecutor()

Returns:

true iff the caller is a worker thread actively serving this executor

invokeAll

default <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks)
                               throws InterruptedException

Specified by:

invokeAll in interface ExecutorService

Throws:

InterruptedException

invokeAll

default <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks,
 long timeout,
 TimeUnit unit)
                               throws InterruptedException

Specified by:

invokeAll in interface ExecutorService

Throws:

InterruptedException

invokeAny

default <T> T invokeAny(Collection<? extends Callable<T>> tasks)
                 throws InterruptedException,
ExecutionException

Specified by:

invokeAny in interface ExecutorService

Throws:

InterruptedException

ExecutionException

invokeAny

default <T> T invokeAny(Collection<? extends Callable<T>> tasks,
 long timeout,
 TimeUnit unit)
                 throws InterruptedException,
ExecutionException,
TimeoutException

Specified by:

invokeAny in interface ExecutorService

Throws:

InterruptedException

ExecutionException

TimeoutException