org.elasticsearch.threadpool

Class ThreadPool

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.threadpool.ThreadPool

public class ThreadPool
extends AbstractComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ThreadPool.Cancellable This interface represents an object whose execution may be cancelled during runtime.
static class	ThreadPool.Info
static class	ThreadPool.Names
static class	ThreadPool.ThreadPoolType

Field Summary

Fields

Modifier and Type	Field and Description
static org.elasticsearch.threadpool.ThreadPool.ThreadPoolTypeSettingsValidator	THREAD_POOL_TYPE_SETTINGS_VALIDATOR
static Map<String,ThreadPool.ThreadPoolType>	THREAD_POOL_TYPES
static String	THREADPOOL_GROUP

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
ThreadPool(Settings settings)
ThreadPool(String name)

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	assertNotScheduleThread(String reason)
boolean	awaitTermination(long timeout, TimeUnit unit)
long	estimatedTimeInMillis()
org.apache.lucene.util.Counter	estimatedTimeInMillisCounter()
Executor	executor(String name)
Executor	generic()
ThreadPoolInfo	info()
ThreadPool.Info	info(String name)
ScheduledFuture<?>	schedule(TimeValue delay, String executor, Runnable command) Schedules a one-shot command to run after a given delay.
ScheduledExecutorService	scheduler()
ThreadPool.Cancellable	scheduleWithFixedDelay(Runnable command, TimeValue interval, String executor) Schedules a periodic action that runs on the specified thread pool.
void	setNodeSettingsService(NodeSettingsService nodeSettingsService)
void	shutdown()
void	shutdownNow()
ThreadPoolStats	stats()
static boolean	terminate(ExecutorService service, long timeout, TimeUnit timeUnit) Returns true if the given service was terminated successfully.
static boolean	terminate(ThreadPool pool, long timeout, TimeUnit timeUnit) Returns true if the given pool was terminated successfully.
void	updateSettings(Settings settings)

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

THREAD_POOL_TYPES

public static Map<String,ThreadPool.ThreadPoolType> THREAD_POOL_TYPES

THREADPOOL_GROUP

public static final String THREADPOOL_GROUP

See Also:

Constant Field Values

THREAD_POOL_TYPE_SETTINGS_VALIDATOR

public static org.elasticsearch.threadpool.ThreadPool.ThreadPoolTypeSettingsValidator THREAD_POOL_TYPE_SETTINGS_VALIDATOR

Constructor Detail

ThreadPool

public ThreadPool(String name)

ThreadPool

public ThreadPool(Settings settings)

Method Detail

setNodeSettingsService

public void setNodeSettingsService(NodeSettingsService nodeSettingsService)

estimatedTimeInMillis

public long estimatedTimeInMillis()

estimatedTimeInMillisCounter

public org.apache.lucene.util.Counter estimatedTimeInMillisCounter()

info

public ThreadPoolInfo info()

info

public ThreadPool.Info info(String name)

stats

public ThreadPoolStats stats()

generic

public Executor generic()

executor

public Executor executor(String name)

scheduler

public ScheduledExecutorService scheduler()

scheduleWithFixedDelay

public ThreadPool.Cancellable scheduleWithFixedDelay(Runnable command,
                                            TimeValue interval,
                                            String executor)

Schedules a periodic action that runs on the specified thread pool.

Parameters:

command - the action to take

interval - the delay interval

executor - The name of the thread pool on which to execute this task. ThreadPool.Names.SAME means "execute on the scheduler thread", which there is only one of. Executing blocking or long running code on the ThreadPool.Names.SAME thread pool should never be done as it can cause issues with the cluster

Returns:

a ThreadPool.Cancellable that can be used to cancel the subsequent runs of the command. If the command is running, it will not be interrupted.

schedule

public ScheduledFuture<?> schedule(TimeValue delay,
                          String executor,
                          Runnable command)

Schedules a one-shot command to run after a given delay. The command is not run in the context of the calling thread. To preserve the context of the calling thread you may call threadPool.getThreadContext().preserveContext on the runnable before passing it to this method.

Parameters:

delay - delay before the task executes

executor - the name of the thread pool on which to execute this task. SAME means "execute on the scheduler thread" which changes the meaning of the ScheduledFuture returned by this method. In that case the ScheduledFuture will complete only when the command completes.

command - the command to run

Returns:

a ScheduledFuture who's get will return when the task is has been added to its target thread pool and throw an exception if the task is canceled before it was added to its target thread pool. Once the task has been added to its target thread pool the ScheduledFuture will cannot interact with it.

Throws:

EsRejectedExecutionException - if the task cannot be scheduled for execution

shutdown

public void shutdown()

shutdownNow

public void shutdownNow()

awaitTermination

public boolean awaitTermination(long timeout,
                       TimeUnit unit)
                         throws InterruptedException

Throws:

InterruptedException

updateSettings

public void updateSettings(Settings settings)

terminate

public static boolean terminate(ExecutorService service,
                long timeout,
                TimeUnit timeUnit)

Returns true if the given service was terminated successfully. If the termination timed out, the service is null this method will return false.

terminate

public static boolean terminate(ThreadPool pool,
                long timeout,
                TimeUnit timeUnit)

Returns true if the given pool was terminated successfully. If the termination timed out, the service is null this method will return false.

assertNotScheduleThread

public static boolean assertNotScheduleThread(String reason)