com.lucidworks.apollo.component

Class ExecutorComponent.ListeningExecutorServiceBuilder

java.lang.Object

com.lucidworks.apollo.component.ExecutorComponent.ListeningExecutorServiceBuilder

Enclosing class:

ExecutorComponent

public class ExecutorComponent.ListeningExecutorServiceBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ListeningExecutorServiceBuilder()

Method Summary

Modifier and Type	Method and Description
ExecutorComponent.ListeningExecutorServiceBuilder	allowCoreThreadTimeOut(boolean timeout)
ListeningExecutorService	build() Build the ThreadPoolExecutor using the given configuration.
ExecutorComponent.ListeningExecutorServiceBuilder	setCorePoolSize(int corePoolSize)
ExecutorComponent.ListeningExecutorServiceBuilder	setHandler(java.util.concurrent.RejectedExecutionHandler handler)
ExecutorComponent.ListeningExecutorServiceBuilder	setKeepAliveTime(long keepAliveTime, java.util.concurrent.TimeUnit unit) The amount of time
ExecutorComponent.ListeningExecutorServiceBuilder	setMaximumPoolSize(int maximumPoolSize) The ExecutorService will always prefer adding tasks to the queue over adding threads beyond the core pool size.
ExecutorComponent.ListeningExecutorServiceBuilder	setThreadNameFormat(java.lang.String threadNameFormat)
ExecutorComponent.ListeningExecutorServiceBuilder	setThreadPoolName(java.lang.String threadPoolName) Set the name of this thread pool.
ExecutorComponent.ListeningExecutorServiceBuilder	setWithMetrics(boolean withMetrics)
ExecutorComponent.ListeningExecutorServiceBuilder	setWorkQueue(java.util.concurrent.BlockingQueue<java.lang.Runnable> workQueue) This will almost always be a SynchronousQueue or an ArrayBlockingQueue with a reasonable maximum size.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListeningExecutorServiceBuilder

public ListeningExecutorServiceBuilder()

Method Detail

setCorePoolSize

public ExecutorComponent.ListeningExecutorServiceBuilder setCorePoolSize(int corePoolSize)

setMaximumPoolSize

public ExecutorComponent.ListeningExecutorServiceBuilder setMaximumPoolSize(int maximumPoolSize)

The ExecutorService will always prefer adding tasks to the queue over adding threads beyond the core pool size. When maximumPoolSize > corePoolSize, it will add threads above corePoolSize up to maximumPoolSize only when the queue is full.

More specifically, from the ThreadPoolExecutor javadoc:

• If fewer than corePoolSize threads are running, the Executor always prefers adding a new thread rather than queuing.

• If corePoolSize or more threads are running, the Executor always prefers queuing a request rather than adding a new thread.

• If a request cannot be queued, a new thread is created unless this would exceed maximumPoolSize, in which case, the task will be rejected.

Parameters:

maximumPoolSize -

Returns:

setKeepAliveTime

public ExecutorComponent.ListeningExecutorServiceBuilder setKeepAliveTime(long keepAliveTime,
                                                                          java.util.concurrent.TimeUnit unit)

The amount of time

Parameters:

keepAliveTime -

unit -

Returns:

allowCoreThreadTimeOut

public ExecutorComponent.ListeningExecutorServiceBuilder allowCoreThreadTimeOut(boolean timeout)

setWithMetrics

public ExecutorComponent.ListeningExecutorServiceBuilder setWithMetrics(boolean withMetrics)

setWorkQueue

public ExecutorComponent.ListeningExecutorServiceBuilder setWorkQueue(java.util.concurrent.BlockingQueue<java.lang.Runnable> workQueue)

This will almost always be a SynchronousQueue or an ArrayBlockingQueue with a reasonable maximum size. An unbounded LinkedBlockingQueue is discouraged; you can easily run out of memory. Do note, though, that with a bounded number of threads and a bounded queue you can potentially have rejected tasks.

Parameters:

workQueue -

Returns:

setThreadNameFormat

public ExecutorComponent.ListeningExecutorServiceBuilder setThreadNameFormat(java.lang.String threadNameFormat)

Parameters:

threadNameFormat - a String.format(String, Object...)-compatible format String, to which a unique integer (0, 1, etc.) will be supplied as the single parameter. This integer will be unique to the built instance of the ThreadFactory and will be assigned sequentially. For example, "rpc-pool-%d" will generate thread names like "rpc-pool-0", "rpc-pool-1", "rpc-pool-2", etc.

Returns:

setThreadPoolName

public ExecutorComponent.ListeningExecutorServiceBuilder setThreadPoolName(java.lang.String threadPoolName)

Set the name of this thread pool. This is used in metrics about this thread pool, so something human-readable and understandable is preferred.

Parameters:

threadPoolName -

Returns:

setHandler

public ExecutorComponent.ListeningExecutorServiceBuilder setHandler(java.util.concurrent.RejectedExecutionHandler handler)

build

public ListeningExecutorService build()

Build the ThreadPoolExecutor using the given configuration.

Returns: