Package org.apache.cassandra.concurrent
Class SEPExecutor
- java.lang.Object
-
- org.apache.cassandra.concurrent.SEPExecutor
-
- All Implemented Interfaces:
java.util.concurrent.Executor,java.util.concurrent.ExecutorService,ExecutorPlus,LocalAwareExecutorPlus,ResizableThreadPool,SEPExecutorMBean
public class SEPExecutor extends java.lang.Object implements LocalAwareExecutorPlus, SEPExecutorMBean
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSEPExecutor.TakeTaskPermitResult-
Nested classes/interfaces inherited from interface org.apache.cassandra.concurrent.ExecutorPlus
ExecutorPlus.MaximumPoolSizeListener
-
-
Field Summary
Fields Modifier and Type Field Description ThreadPoolMetricsmetricsjava.lang.Stringnameprotected java.util.concurrent.ConcurrentLinkedQueue<java.lang.Runnable>tasks
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected <T extends java.lang.Runnable>
TaddTask(T task)booleanawaitTermination(long timeout, java.util.concurrent.TimeUnit unit)voidexecute(java.lang.Runnable run)voidexecute(WithResources withResources, java.lang.Runnable run)Invoketask.intgetActiveTaskCount()Returns the approximate number of threads that are actively executing tasks.longgetCompletedTaskCount()Returns the approximate total number of tasks that have completed execution.intgetCorePoolSize()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).intgetMaximumPoolSize()Returns maximum pool size of thread pool.intgetMaxTasksQueued()intgetPendingTaskCount()Returns the approximate total of tasks waiting to be executed.booleaninExecutor()booleanisShutdown()booleanisTerminated()voidmaybeExecuteImmediately(java.lang.Runnable task)MAY executetaskimmediately, if the calling thread is permitted to do so.longoldestTaskQueueTime()protected voidonCompletion()voidsetCorePoolSize(int newCorePoolSize)Allows user to resize minimum size of the thread pool.voidsetMaximumPoolSize(int newMaximumPoolSize)Allows user to resize maximum size of the thread pool.voidshutdown()java.util.List<java.lang.Runnable>shutdownNow()Future<?>submit(java.lang.Runnable run)OverridesExecutorService.submit(Runnable)to return a CassandraFuture<T> Future<T>submit(java.lang.Runnable run, T result)OverridesExecutorService.submit(Runnable, Object)to return a CassandraFuture<T> Future<T>submit(java.util.concurrent.Callable<T> call)OverridesExecutorService.submit(Callable)to return a CassandraFutureFuture<?>submit(WithResources withResources, java.lang.Runnable run)Invoketask, returning a future yieldingnullif successful, or the abnormal termination oftaskotherwise.<T> Future<T>submit(WithResources withResources, java.lang.Runnable run, T result)Invoketask, returning a future yieldingresultif successful, or the abnormal termination oftaskotherwise.<T> Future<T>submit(WithResources withResources, java.util.concurrent.Callable<T> call)Invoketask, returning a future representing this computation.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.cassandra.concurrent.ExecutorPlus
invokeAll, invokeAll, invokeAny, invokeAny
-
-
-
-
Field Detail
-
name
public final java.lang.String name
-
metrics
public final ThreadPoolMetrics metrics
-
tasks
protected final java.util.concurrent.ConcurrentLinkedQueue<java.lang.Runnable> tasks
-
-
Method Detail
-
onCompletion
protected void onCompletion()
-
oldestTaskQueueTime
public long oldestTaskQueueTime()
- Specified by:
oldestTaskQueueTimein interfaceResizableThreadPool
-
getMaxTasksQueued
public int getMaxTasksQueued()
- Specified by:
getMaxTasksQueuedin interfaceResizableThreadPool
-
addTask
protected <T extends java.lang.Runnable> T addTask(T task)
-
maybeExecuteImmediately
public void maybeExecuteImmediately(java.lang.Runnable task)
Description copied from interface:ExecutorPlusMAY executetaskimmediately, if the calling thread is permitted to do so.- Specified by:
maybeExecuteImmediatelyin interfaceExecutorPlus
-
execute
public void execute(java.lang.Runnable run)
- Specified by:
executein interfacejava.util.concurrent.Executor
-
execute
public void execute(WithResources withResources, java.lang.Runnable run)
Description copied from interface:ExecutorPlusInvoketask. The invoking thread will first instantiate the resources provided before invokingtask, 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:
executein interfaceExecutorPlus- Parameters:
withResources- the resources to create and hold while executingtaskrun- the task to execute
-
submit
public Future<?> submit(java.lang.Runnable run)
Description copied from interface:ExecutorPlusOverridesExecutorService.submit(Runnable)to return a CassandraFuture- Specified by:
submitin interfaceExecutorPlus- Specified by:
submitin interfacejava.util.concurrent.ExecutorService
-
submit
public <T> Future<T> submit(java.lang.Runnable run, T result)
Description copied from interface:ExecutorPlusOverridesExecutorService.submit(Runnable, Object)to return a CassandraFuture- Specified by:
submitin interfaceExecutorPlus- Specified by:
submitin interfacejava.util.concurrent.ExecutorService
-
submit
public <T> Future<T> submit(java.util.concurrent.Callable<T> call)
Description copied from interface:ExecutorPlusOverridesExecutorService.submit(Callable)to return a CassandraFuture- Specified by:
submitin interfaceExecutorPlus- Specified by:
submitin interfacejava.util.concurrent.ExecutorService
-
submit
public <T> Future<T> submit(WithResources withResources, java.lang.Runnable run, T result)
Description copied from interface:ExecutorPlusInvoketask, returning a future yieldingresultif successful, or the abnormal termination oftaskotherwise. The invoking thread will first instantiate the resources provided before invokingtask, 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:
submitin interfaceExecutorPlus- Parameters:
withResources- the resources to create and hold while executingtaskrun- the task to executeresult- the result if successful
-
submit
public Future<?> submit(WithResources withResources, java.lang.Runnable run)
Description copied from interface:ExecutorPlusInvoketask, returning a future yieldingnullif successful, or the abnormal termination oftaskotherwise. The invoking thread will first instantiate the resources provided before invokingtask, so that thread state may be modified and cleaned uptry (Closeable close = withResources.get()) { task.run(); return null; }- Specified by:
submitin interfaceExecutorPlus- Parameters:
withResources- the resources to create and hold while executingtaskrun- the task to execute
-
submit
public <T> Future<T> submit(WithResources withResources, java.util.concurrent.Callable<T> call)
Description copied from interface:ExecutorPlusInvoketask, returning a future representing this computation. The invoking thread will first instantiate the resources provided before invokingtask, 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:
submitin interfaceExecutorPlus- Parameters:
withResources- the resources to create and hold while executingtaskcall- the task to execute
-
inExecutor
public boolean inExecutor()
- Specified by:
inExecutorin interfaceExecutorPlus- Returns:
- true iff the caller is a worker thread actively serving this executor
-
shutdown
public void shutdown()
- Specified by:
shutdownin interfacejava.util.concurrent.ExecutorService
-
shutdownNow
public java.util.List<java.lang.Runnable> shutdownNow()
- Specified by:
shutdownNowin interfacejava.util.concurrent.ExecutorService
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdownin interfacejava.util.concurrent.ExecutorService
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminatedin interfacejava.util.concurrent.ExecutorService
-
awaitTermination
public boolean awaitTermination(long timeout, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException- Specified by:
awaitTerminationin interfacejava.util.concurrent.ExecutorService- Throws:
java.lang.InterruptedException
-
getPendingTaskCount
public int getPendingTaskCount()
Description copied from interface:ResizableThreadPoolReturns 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:
getPendingTaskCountin interfaceResizableThreadPool- Returns:
- the number of tasks
-
getCompletedTaskCount
public long getCompletedTaskCount()
Description copied from interface:ResizableThreadPoolReturns the approximate total number of tasks that have completed execution. Because the states of tasks and threads may change dynamically during computation, the returned value is only an approximation, but one that does not ever decrease across successive calls.- Specified by:
getCompletedTaskCountin interfaceResizableThreadPool- Returns:
- the number of tasks
-
getActiveTaskCount
public int getActiveTaskCount()
Description copied from interface:ResizableThreadPoolReturns the approximate number of threads that are actively executing tasks.- Specified by:
getActiveTaskCountin interfaceResizableThreadPool- Returns:
- the number of threads
-
getCorePoolSize
public int getCorePoolSize()
Description copied from interface:ResizableThreadPoolReturns 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:
getCorePoolSizein interfaceResizableThreadPool
-
setCorePoolSize
public void setCorePoolSize(int newCorePoolSize)
Description copied from interface:ResizableThreadPoolAllows user to resize minimum size of the thread pool.- Specified by:
setCorePoolSizein interfaceResizableThreadPool
-
getMaximumPoolSize
public int getMaximumPoolSize()
Description copied from interface:ResizableThreadPoolReturns maximum pool size of thread pool.- Specified by:
getMaximumPoolSizein interfaceResizableThreadPool
-
setMaximumPoolSize
public void setMaximumPoolSize(int newMaximumPoolSize)
Description copied from interface:ResizableThreadPoolAllows user to resize maximum size of the thread pool.- Specified by:
setMaximumPoolSizein interfaceResizableThreadPool
-
-