Package org.apache.cassandra.concurrent

Class ScheduledThreadPoolExecutorPlus

java.lang.Object

java.util.concurrent.AbstractExecutorService

java.util.concurrent.ThreadPoolExecutor

java.util.concurrent.ScheduledThreadPoolExecutor

org.apache.cassandra.concurrent.ScheduledThreadPoolExecutorPlus

All Implemented Interfaces:

Executor, ExecutorService, ScheduledExecutorService, ExecutorPlus, ResizableThreadPool, ScheduledExecutorPlus

public class ScheduledThreadPoolExecutorPlus
extends ScheduledThreadPoolExecutor
implements ScheduledExecutorPlus

Like ExecutorPlus, ScheduledThreadPoolExecutorPlus always logs exceptions from the tasks it is given, even if Future.get is never called elsewhere. Catches exceptions during Task execution so that they don't suppress subsequent invocations of the task. Finally, there is a special rejected execution handler for tasks rejected during the shutdown hook. - For fire and forget tasks (like ref tidy) we can safely ignore the exceptions. - For any callers that care to know their task was rejected we cancel passed task.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ThreadPoolExecutor

ThreadPoolExecutor.AbortPolicy, ThreadPoolExecutor.CallerRunsPolicy, ThreadPoolExecutor.DiscardOldestPolicy, ThreadPoolExecutor.DiscardPolicy

Nested classes/interfaces inherited from interface org.apache.cassandra.concurrent.ExecutorPlus

ExecutorPlus.MaximumPoolSizeListener

Field Summary

Fields

Modifier and Type	Field	Description
static final RejectedExecutionHandler	rejectedExecutionHandler

Method Summary

Modifier and Type	Method	Description
void	execute(Runnable run)
void	execute(WithResources withResources, Runnable run)	Invoke task.
int	getActiveTaskCount()	Returns the approximate number of threads that are actively executing tasks.
int	getCorePoolSize()	Returns core pool size of thread pool, the minimum number of workers (where that makes sense for a thread pool, SEPExecutor does not have a minimum size).
int	getMaximumPoolSize()	Returns maximum pool size of thread pool.
int	getMaxTasksQueued()
int	getPendingTaskCount()	Returns the approximate total of tasks waiting to be executed.
NamedThreadFactory	getThreadFactory()
boolean	inExecutor()
protected <T> RunnableFuture<T>	newTaskFor(Runnable runnable, T value)
protected <T> RunnableFuture<T>	newTaskFor(Callable<T> callable)
ScheduledFuture<?>	schedule(Runnable task, long delay, TimeUnit unit)
<V> ScheduledFuture<V>	schedule(Callable<V> task, long delay, TimeUnit unit)
ScheduledFuture<?>	scheduleAt(Runnable run, long deadline)	Schedule a timeout action.
ScheduledFuture<?>	scheduleAtFixedRate(Runnable task, long initialDelay, long period, TimeUnit unit)
ScheduledFuture<?>	scheduleSelfRecurring(Runnable run, long delay, TimeUnit units)	Schedule an action that is recurring but self-administered.
ScheduledFuture<?>	scheduleTimeoutAt(Runnable run, long deadline)	Schedule a timeout action.
ScheduledFuture<?>	scheduleTimeoutWithDelay(Runnable run, long delay, TimeUnit units)	Schedule a timeout action.
ScheduledFuture<?>	scheduleWithFixedDelay(Runnable task, long initialDelay, long delay, TimeUnit unit)
void	setCorePoolSize(int number)	Allows user to resize minimum size of the thread pool.
void	setMaximumPoolSize(int number)	Allows user to resize maximum size of the thread pool.
List<Runnable>	shutdownNow()
Future<?>	submit(Runnable run)	Overrides ExecutorService.submit(Runnable) to return a Cassandra Future
<T> Future<T>	submit(Runnable run, T result)	Overrides ExecutorService.submit(Runnable, Object) to return a Cassandra Future
<T> Future<T>	submit(Callable<T> call)	Overrides ExecutorService.submit(Callable) to return a Cassandra Future
Future<?>	submit(WithResources withResources, Runnable run)	Invoke task, returning a future yielding null if successful, or the abnormal termination of task otherwise.
<T> Future<T>	submit(WithResources withResources, Runnable run, 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> call)	Invoke task, returning a future representing this computation.
protected void	terminated()

Methods inherited from class java.util.concurrent.ScheduledThreadPoolExecutor

decorateTask, decorateTask, getContinueExistingPeriodicTasksAfterShutdownPolicy, getExecuteExistingDelayedTasksAfterShutdownPolicy, getQueue, getRemoveOnCancelPolicy, setContinueExistingPeriodicTasksAfterShutdownPolicy, setExecuteExistingDelayedTasksAfterShutdownPolicy, setRemoveOnCancelPolicy, shutdown

Methods inherited from class java.util.concurrent.ThreadPoolExecutor

afterExecute, allowCoreThreadTimeOut, allowsCoreThreadTimeOut, awaitTermination, beforeExecute, finalize, getActiveCount, getCompletedTaskCount, getKeepAliveTime, getLargestPoolSize, getPoolSize, getRejectedExecutionHandler, getTaskCount, isShutdown, isTerminated, isTerminating, prestartAllCoreThreads, prestartCoreThread, purge, remove, setKeepAliveTime, setRejectedExecutionHandler, setThreadFactory, toString

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

invokeAll, invokeAll, invokeAny, invokeAny, maybeExecuteImmediately

Methods inherited from interface java.util.concurrent.ExecutorService

awaitTermination, isShutdown, isTerminated, shutdown

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

getCompletedTaskCount, oldestTaskQueueTime

Field Details

rejectedExecutionHandler

public static final RejectedExecutionHandler rejectedExecutionHandler

Method Details

schedule

public ScheduledFuture<?> schedule(Runnable task,
 long delay,
 TimeUnit unit)

Specified by:

schedule in interface ScheduledExecutorService

Overrides:

schedule in class ScheduledThreadPoolExecutor

schedule

public <V> ScheduledFuture<V> schedule(Callable<V> task,
 long delay,
 TimeUnit unit)

Specified by:

schedule in interface ScheduledExecutorService

Overrides:

schedule in class ScheduledThreadPoolExecutor

scheduleAtFixedRate

public ScheduledFuture<?> scheduleAtFixedRate(Runnable task,
 long initialDelay,
 long period,
 TimeUnit unit)

Specified by:

scheduleAtFixedRate in interface ScheduledExecutorService

Overrides:

scheduleAtFixedRate in class ScheduledThreadPoolExecutor

scheduleWithFixedDelay

public ScheduledFuture<?> scheduleWithFixedDelay(Runnable task,
 long initialDelay,
 long delay,
 TimeUnit unit)

Specified by:

scheduleWithFixedDelay in interface ScheduledExecutorService

Overrides:

scheduleWithFixedDelay in class ScheduledThreadPoolExecutor

scheduleSelfRecurring

public ScheduledFuture<?> scheduleSelfRecurring(Runnable run,
 long delay,
 TimeUnit units)

Description copied from interface: ScheduledExecutorPlus

Schedule an action that is recurring but self-administered.

Specified by:

scheduleSelfRecurring in interface ScheduledExecutorPlus

scheduleAt

public ScheduledFuture<?> scheduleAt(Runnable run,
 long deadline)

Description copied from interface: ScheduledExecutorPlus

Schedule a timeout action. This method is primarily used by the Simulator to modify its scheduling behaviour with respect to this operation.

Specified by:

scheduleAt in interface ScheduledExecutorPlus

scheduleTimeoutAt

public ScheduledFuture<?> scheduleTimeoutAt(Runnable run,
 long deadline)

Description copied from interface: ScheduledExecutorPlus

Schedule a timeout action. This method is primarily used by the Simulator to modify its scheduling behaviour with respect to this operation.

Specified by:

scheduleTimeoutAt in interface ScheduledExecutorPlus

scheduleTimeoutWithDelay

public ScheduledFuture<?> scheduleTimeoutWithDelay(Runnable run,
 long delay,
 TimeUnit units)

Description copied from interface: ScheduledExecutorPlus

Schedule a timeout action. This method is primarily used by the Simulator to modify its scheduling behaviour with respect to this operation.

Specified by:

scheduleTimeoutWithDelay in interface ScheduledExecutorPlus

execute

public void execute(Runnable run)

Specified by:

execute in interface Executor

Overrides:

execute in class ScheduledThreadPoolExecutor

execute

public void execute(WithResources withResources,
 Runnable run)

Description copied from interface: ExecutorPlus

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(); }

Specified by:

execute in interface ExecutorPlus

Parameters:

withResources - the resources to create and hold while executing task

run - the task to execute

submit

public Future<?> submit(Runnable run)

Description copied from interface: ExecutorPlus

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

Specified by:

submit in interface ExecutorPlus

Specified by:

submit in interface ExecutorService

Overrides:

submit in class ScheduledThreadPoolExecutor

submit

public <T> Future<T> submit(Runnable run,
 T result)

Description copied from interface: ExecutorPlus

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

Specified by:

submit in interface ExecutorPlus

Specified by:

submit in interface ExecutorService

Overrides:

submit in class ScheduledThreadPoolExecutor

submit

public <T> Future<T> submit(Callable<T> call)

Description copied from interface: ExecutorPlus

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

Specified by:

submit in interface ExecutorPlus

Specified by:

submit in interface ExecutorService

Overrides:

submit in class ScheduledThreadPoolExecutor

submit

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

Description copied from interface: ExecutorPlus

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; }

Specified by:

submit in interface ExecutorPlus

Parameters:

withResources - the resources to create and hold while executing task

run - the task to execute

result - the result if successful

submit

public Future<?> submit(WithResources withResources,
 Runnable run)

Description copied from interface: ExecutorPlus

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; }

Specified by:

submit in interface ExecutorPlus

Parameters:

withResources - the resources to create and hold while executing task

run - the task to execute

submit

public <T> Future<T> submit(WithResources withResources,
 Callable<T> call)

Description copied from interface: ExecutorPlus

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(); }

Specified by:

submit in interface ExecutorPlus

Parameters:

withResources - the resources to create and hold while executing task

call - the task to execute

inExecutor

public boolean inExecutor()

Specified by:

inExecutor in interface ExecutorPlus

Returns:

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

newTaskFor

protected <T> RunnableFuture<T> newTaskFor(Runnable runnable,
 T value)

Overrides:

newTaskFor in class AbstractExecutorService

newTaskFor

protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable)

Overrides:

newTaskFor in class AbstractExecutorService

getThreadFactory

public NamedThreadFactory getThreadFactory()

Overrides:

getThreadFactory in class ThreadPoolExecutor

shutdownNow

public List<Runnable> shutdownNow()

Specified by:

shutdownNow in interface ExecutorService

Overrides:

shutdownNow in class ScheduledThreadPoolExecutor

terminated

protected void terminated()

Overrides:

terminated in class ThreadPoolExecutor

getActiveTaskCount

public int getActiveTaskCount()

Description copied from interface: ResizableThreadPool

Returns the approximate number of threads that are actively executing tasks.

Specified by:

getActiveTaskCount in interface ResizableThreadPool

Returns:

the number of threads

getPendingTaskCount

public int getPendingTaskCount()

Description copied from interface: ResizableThreadPool

Returns the approximate total of tasks waiting to be executed. Because the states of tasks and threads may change dynamically during computation, the returned value is only an approximation.

Specified by:

getPendingTaskCount in interface ResizableThreadPool

Returns:

the number of tasks

getCorePoolSize

public int getCorePoolSize()

Description copied from interface: ResizableThreadPool

Returns core pool size of thread pool, the minimum number of workers (where that makes sense for a thread pool, SEPExecutor does not have a minimum size).

Specified by:

getCorePoolSize in interface ResizableThreadPool

Overrides:

getCorePoolSize in class ThreadPoolExecutor

setCorePoolSize

public void setCorePoolSize(int number)

Description copied from interface: ResizableThreadPool

Allows user to resize minimum size of the thread pool.

Specified by:

setCorePoolSize in interface ResizableThreadPool

Overrides:

setCorePoolSize in class ThreadPoolExecutor

getMaximumPoolSize

public int getMaximumPoolSize()

Description copied from interface: ResizableThreadPool

Returns maximum pool size of thread pool.

Specified by:

getMaximumPoolSize in interface ResizableThreadPool

Overrides:

getMaximumPoolSize in class ThreadPoolExecutor

setMaximumPoolSize

public void setMaximumPoolSize(int number)

Description copied from interface: ResizableThreadPool

Allows user to resize maximum size of the thread pool.

Specified by:

setMaximumPoolSize in interface ResizableThreadPool

Overrides:

setMaximumPoolSize in class ThreadPoolExecutor

getMaxTasksQueued

public int getMaxTasksQueued()

Specified by:

getMaxTasksQueued in interface ResizableThreadPool