Package org.apache.cassandra.concurrent

Class ThreadPoolExecutorBuilder<E extends ExecutorPlus>

java.lang.Object

org.apache.cassandra.concurrent.NamedThreadFactory.MetaFactory

org.apache.cassandra.concurrent.ThreadPoolExecutorBuilder<E>

All Implemented Interfaces:

ExecutorBuilder<E>

public class ThreadPoolExecutorBuilder<E extends ExecutorPlus>
extends NamedThreadFactory.MetaFactory
implements ExecutorBuilder<E>

Configure a ThreadPoolExecutorPlus, applying Cassandra's best practices by default

Core threads may timeout, and use a default keepAlive time in keepAliveUnits

Threads share the same ThreadGroup, which may be configurably a child of a specified ThreadGroup descended from the same parent of the NamedThreadFactory.MetaFactory

By default queues are unbounded in length

The default RejectedExecutionHandler is implementation dependent, but may be overridden

The default Thread.UncaughtExceptionHandler is inherited from NamedThreadFactory.MetaFactory, which in turn receives it from the ExecutorBuilderFactory

Field Summary

Fields inherited from class org.apache.cassandra.concurrent.NamedThreadFactory.MetaFactory

contextClassLoader, threadGroup, uncaughtExceptionHandler

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ThreadPoolExecutorBuilder(Function<ThreadPoolExecutorBuilder<E>,E> constructor, ClassLoader contextClassLoader, ThreadGroup overrideThreadGroup, Thread.UncaughtExceptionHandler uncaughtExceptionHandler, String name, int threads)

Method Summary

Modifier and Type	Method	Description
E	build()	Build the configured executor
ExecutorBuilder<E>	withDefaultThreadGroup()	Use the system default thread group for the threads we create.
ThreadPoolExecutorBuilder<E>	withKeepAlive()	Core threads for the executor built by this factory will never timeout (default for single threaded builders).
ThreadPoolExecutorBuilder<E>	withKeepAlive(long keepAlive, TimeUnit keepAliveUnits)	Threads for the executor built by this factory will timeout (terminate) after the specified period.
ThreadPoolExecutorBuilder<E>	withQueueLimit(int queueLimit)	The executor built by this factory will limit the number of queued tasks; default is unlimited.
ThreadPoolExecutorBuilder<E>	withRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler)	Set the RejectedExecutionHandler for the executor built by this factory.
ExecutorBuilder<E>	withThreadGroup(ThreadGroup threadGroup)	Threads for the executor built by this factory will all be (transitively) members of threadGroup, but may directly reside in a child thread group.
ThreadPoolExecutorBuilder<E>	withThreadPriority(int threadPriority)	Specify the priority of threads that service the executor built by this factory (default to Thread.NORM_PRIORITY)
ThreadPoolExecutorBuilder<E>	withUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)	Set the Thread.UncaughtExceptionHandler for threads that service executors built by this factory.

Methods inherited from class java.lang.Object

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

Constructor Details

ThreadPoolExecutorBuilder

protected ThreadPoolExecutorBuilder(Function<ThreadPoolExecutorBuilder<E>,E> constructor,
 ClassLoader contextClassLoader,
 ThreadGroup overrideThreadGroup,
 Thread.UncaughtExceptionHandler uncaughtExceptionHandler,
 String name,
 int threads)

Method Details

withKeepAlive

public ThreadPoolExecutorBuilder<E> withKeepAlive(long keepAlive,
 TimeUnit keepAliveUnits)

Description copied from interface: ExecutorBuilder

Threads for the executor built by this factory will timeout (terminate) after the specified period.

Specified by:

withKeepAlive in interface ExecutorBuilder<E extends ExecutorPlus>

withKeepAlive

public ThreadPoolExecutorBuilder<E> withKeepAlive()

Description copied from interface: ExecutorBuilder

Core threads for the executor built by this factory will never timeout (default for single threaded builders). Note that there is ordinarily no difference between core and non-core threads; only when the queue limit is zero do we create non-core threads.

Specified by:

withKeepAlive in interface ExecutorBuilder<E extends ExecutorPlus>

withThreadPriority

public ThreadPoolExecutorBuilder<E> withThreadPriority(int threadPriority)

Description copied from interface: ExecutorBuilder

Specify the priority of threads that service the executor built by this factory (default to Thread.NORM_PRIORITY)

Specified by:

withThreadPriority in interface ExecutorBuilder<E extends ExecutorPlus>

withThreadGroup

public ExecutorBuilder<E> withThreadGroup(ThreadGroup threadGroup)

Description copied from interface: ExecutorBuilder

Threads for the executor built by this factory will all be (transitively) members of threadGroup, but may directly reside in a child thread group.

Specified by:

withThreadGroup in interface ExecutorBuilder<E extends ExecutorPlus>

withDefaultThreadGroup

public ExecutorBuilder<E> withDefaultThreadGroup()

Description copied from interface: ExecutorBuilder

Use the system default thread group for the threads we create. This is used only for testing, so that we do not hold onto a transitive global reference to all threads.

Specified by:

withDefaultThreadGroup in interface ExecutorBuilder<E extends ExecutorPlus>

withQueueLimit

public ThreadPoolExecutorBuilder<E> withQueueLimit(int queueLimit)

Description copied from interface: ExecutorBuilder

The executor built by this factory will limit the number of queued tasks; default is unlimited. Once the queue limit is reached and all threads are executing tasks will be rejected (see ExecutorBuilder.withRejectedExecutionHandler(RejectedExecutionHandler))

Specified by:

withQueueLimit in interface ExecutorBuilder<E extends ExecutorPlus>

withRejectedExecutionHandler

public ThreadPoolExecutorBuilder<E> withRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler)

Description copied from interface: ExecutorBuilder

Set the RejectedExecutionHandler for the executor built by this factory. By default this is executor-specific, either:

ThreadPoolExecutorBase.blockingExecutionHandler

ScheduledThreadPoolExecutorPlus.rejectedExecutionHandler

and maybe wrapped by ThreadPoolExecutorJMXAdapter.rejectedExecutionHandler(org.apache.cassandra.metrics.ThreadPoolMetrics, java.util.concurrent.RejectedExecutionHandler)

Specified by:

withRejectedExecutionHandler in interface ExecutorBuilder<E extends ExecutorPlus>

withUncaughtExceptionHandler

public ThreadPoolExecutorBuilder<E> withUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)

Description copied from interface: ExecutorBuilder

Set the Thread.UncaughtExceptionHandler for threads that service executors built by this factory. By default JVMStabilityInspector.uncaughtException(Thread, Throwable)

Specified by:

withUncaughtExceptionHandler in interface ExecutorBuilder<E extends ExecutorPlus>

build

public E build()

Description copied from interface: ExecutorBuilder

Build the configured executor

Specified by:

build in interface ExecutorBuilder<E extends ExecutorPlus>