Netty 4.1.107.Final · io.netty.util.concurrent.GlobalEventExecutor

Modifier and Type	Class and Description
pack-priv class	GlobalEventExecutor.TaskRunner

Modifier and Type	Field and Description
public static final GlobalEventExecutor	INSTANCE
private static final InternalLogger	logger Hides io.netty.util.concurrent.AbstractEventExecutor.logger.
pack-priv final ScheduledFutureTask<Void>	quietPeriodTask
private static final long	SCHEDULE_QUIET_PERIOD_INTERVAL
private final AtomicBoolean	started
pack-priv final BlockingQueue<Runnable>	taskQueue
private final GlobalEventExecutor.TaskRunner	taskRunner
private final Future<?>	terminationFuture
pack-priv volatile Thread	thread
pack-priv final ThreadFactory	threadFactory

Access	Constructor and Description
private	GlobalEventExecutor()

Method Summary

Modifier and Type	Method and Description
private void	addTask(Runnable task) Add a task to the task queue, or throws a `RejectedExecutionException` if this instance was shutdown before.
public boolean	Returns: `true` if and only if the worker thread has been terminated awaitInactivity(long timeout, TimeUnit unit) Waits until the worker thread of this executor has no tasks left in its task queue and terminates itself.
public boolean	awaitTermination(long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.ExecutorService.awaitTermination. Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.
public void	execute(Runnable the runnable task task) Implements java.util.concurrent.Executor.execute. Executes the given command at some time in the future.
private void	execute0(Runnable task)
private void	fetchFromScheduledTaskQueue()
public boolean	inEventLoop(Thread thread) Implements io.netty.util.concurrent.EventExecutor.inEventLoop. Return `true` if the given `Thread` is executed in the event loop, `false` otherwise.
public boolean	isShutdown() Implements java.util.concurrent.ExecutorService.isShutdown. Returns `true` if this executor has been shut down.
public boolean	isShuttingDown() Implements io.netty.util.concurrent.EventExecutorGroup.isShuttingDown. Returns `true` if and only if all `EventExecutor`s managed by this `EventExecutorGroup` are being shut down gracefully or was shut down.
public boolean	isTerminated() Implements java.util.concurrent.ExecutorService.isTerminated. Returns `true` if all tasks have completed following shut down.
public int	pendingTasks() Return the number of tasks that are pending for processing.
public void	shutdown() Implements abstract io.netty.util.concurrent.AbstractEventExecutor.shutdown. Implements io.netty.util.concurrent.EventExecutorGroup.shutdown, java.util.concurrent.ExecutorService.shutdown. Deprecated Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
public Future<?>	shutdownGracefully(long the quiet period as described in the documentation quietPeriod, long the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period timeout, TimeUnit the unit of `quietPeriod` and `timeout` unit) Implements io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully. Signals this executor that the caller wants the executor to be shut down.
private void	startThread()
pack-priv Runnable	Returns: `null` if the executor thread has been interrupted or waken up. takeTask() Take the next `Runnable` from the task queue and so will block if no task is currently present.
public Future<?>	terminationFuture() Implements io.netty.util.concurrent.EventExecutorGroup.terminationFuture. Returns the `Future` which is notified when all `EventExecutor`s managed by this `EventExecutorGroup` have been terminated.

INSTANCE	back to summary
public static final GlobalEventExecutor INSTANCE

logger	back to summary
private static final InternalLogger logger Hides io.netty.util.concurrent.AbstractEventExecutor.logger.

quietPeriodTask	back to summary
pack-priv final ScheduledFutureTask<Void> quietPeriodTask

SCHEDULE_QUIET_PERIOD_INTERVAL	back to summary
private static final long SCHEDULE_QUIET_PERIOD_INTERVAL

started	back to summary
private final AtomicBoolean started

taskQueue	back to summary
pack-priv final BlockingQueue<Runnable> taskQueue

taskRunner	back to summary
private final GlobalEventExecutor.TaskRunner taskRunner

terminationFuture	back to summary
private final Future<?> terminationFuture

thread	back to summary
pack-priv volatile Thread thread

threadFactory	back to summary
pack-priv final ThreadFactory threadFactory

GlobalEventExecutor	back to summary
private GlobalEventExecutor()

Method Detail

addTask	back to summary
private void addTask(Runnable task) Add a task to the task queue, or throws a `RejectedExecutionException` if this instance was shutdown before.

awaitInactivity back to summary

awaitInactivity	back to summary
public boolean awaitInactivity(long timeout, TimeUnit unit) throws InterruptedException Waits until the worker thread of this executor has no tasks left in its task queue and terminates itself. Because a new worker thread will be started again when a new task is submitted, this operation is only useful when you want to ensure that the worker thread is terminated after your application is shut down and there's no chance of submitting a new task afterwards. Returns:boolean `true` if and only if the worker thread has been terminated

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

Waits until the worker thread of this executor has no tasks left in its task queue and terminates itself. Because a new worker thread will be started again when a new task is submitted, this operation is only useful when you want to ensure that the worker thread is terminated after your application is shut down and there's no chance of submitting a new task afterwards.

Returns:boolean: true if and only if the worker thread has been terminated

awaitTermination back to summary

awaitTermination	back to summary
public boolean awaitTermination(long timeout, TimeUnit unit) Implements java.util.concurrent.ExecutorService.awaitTermination. Doc from java.util.concurrent.ExecutorService.awaitTermination. Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Returns:boolean `true` if this executor terminated and `false` if the timeout elapsed before termination Annotations @Override

public boolean awaitTermination(long timeout, TimeUnit unit)

Implements java.util.concurrent.ExecutorService.awaitTermination.

Doc from java.util.concurrent.ExecutorService.awaitTermination.

Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:boolean

true if this executor terminated and false if the timeout elapsed before termination

Annotations

@Override

execute back to summary

execute	back to summary
public void execute(Runnable task) Implements java.util.concurrent.Executor.execute. Doc from java.util.concurrent.Executor.execute. Executes the given command at some time in the future. The command may execute in a new thread, in a pooled thread, or in the calling thread, at the discretion of the `Executor` implementation. Parameters task:Runnable the runnable task Annotations @Override

public void execute(Runnable task)

Implements java.util.concurrent.Executor.execute.

Doc from java.util.concurrent.Executor.execute.

Executes the given command at some time in the future. The command may execute in a new thread, in a pooled thread, or in the calling thread, at the discretion of the Executor implementation.

Parameters

task:Runnable: the runnable task

Annotations

@Override

execute0	back to summary
private void execute0(Runnable task)

fetchFromScheduledTaskQueue	back to summary
private void fetchFromScheduledTaskQueue()

inEventLoop back to summary

inEventLoop	back to summary
public boolean inEventLoop(Thread thread) Implements io.netty.util.concurrent.EventExecutor.inEventLoop. Doc from io.netty.util.concurrent.EventExecutor.inEventLoop. Return `true` if the given `Thread` is executed in the event loop, `false` otherwise. Annotations @Override

public boolean inEventLoop(Thread thread)

Implements io.netty.util.concurrent.EventExecutor.inEventLoop.

Doc from io.netty.util.concurrent.EventExecutor.inEventLoop.

Return true if the given Thread is executed in the event loop, false otherwise.

Annotations

@Override

isShutdown back to summary

isShutdown	back to summary
public boolean isShutdown() Implements java.util.concurrent.ExecutorService.isShutdown. Doc from java.util.concurrent.ExecutorService.isShutdown. Returns `true` if this executor has been shut down. Returns:boolean `true` if this executor has been shut down Annotations @Override

public boolean isShutdown()

Implements java.util.concurrent.ExecutorService.isShutdown.

Doc from java.util.concurrent.ExecutorService.isShutdown.

Returns true if this executor has been shut down.

Returns:boolean

true if this executor has been shut down

Annotations

@Override

isShuttingDown back to summary

isShuttingDown	back to summary
public boolean isShuttingDown() Implements io.netty.util.concurrent.EventExecutorGroup.isShuttingDown. Doc from io.netty.util.concurrent.EventExecutorGroup.isShuttingDown. Returns `true` if and only if all `EventExecutor`s managed by this `EventExecutorGroup` are being shut down gracefully or was shut down. Annotations @Override

public boolean isShuttingDown()

Implements io.netty.util.concurrent.EventExecutorGroup.isShuttingDown.

Doc from io.netty.util.concurrent.EventExecutorGroup.isShuttingDown.

Returns true if and only if all EventExecutors managed by this EventExecutorGroup are being shut down gracefully or was shut down.

Annotations

@Override

isTerminated back to summary

isTerminated	back to summary
public boolean isTerminated() Implements java.util.concurrent.ExecutorService.isTerminated. Doc from java.util.concurrent.ExecutorService.isTerminated. Returns `true` if all tasks have completed following shut down. Note that `isTerminated` is never `true` unless either `shutdown` or `shutdownNow` was called first. Returns:boolean `true` if all tasks have completed following shut down Annotations @Override

public boolean isTerminated()

Implements java.util.concurrent.ExecutorService.isTerminated.

Doc from java.util.concurrent.ExecutorService.isTerminated.

Returns true if all tasks have completed following shut down. Note that isTerminated is never true unless either shutdown or shutdownNow was called first.

Returns:boolean

true if all tasks have completed following shut down

Annotations

@Override

pendingTasks	back to summary
public int pendingTasks() Return the number of tasks that are pending for processing.

shutdown back to summary

shutdown	back to summary
public void shutdown() Implements abstract io.netty.util.concurrent.AbstractEventExecutor.shutdown. Implements io.netty.util.concurrent.EventExecutorGroup.shutdown, java.util.concurrent.ExecutorService.shutdown. Doc from java.util.concurrent.ExecutorService.shutdown. Deprecated Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down. This method does not wait for previously submitted tasks to complete execution. Use `awaitTermination` to do that. Annotations @Override @Deprecated

public void shutdown()

Implements abstract io.netty.util.concurrent.AbstractEventExecutor.shutdown.

Implements io.netty.util.concurrent.EventExecutorGroup.shutdown, java.util.concurrent.ExecutorService.shutdown.

Doc from java.util.concurrent.ExecutorService.shutdown.

Deprecated

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down.

This method does not wait for previously submitted tasks to complete execution. Use awaitTermination to do that.

Annotations

@Override
@Deprecated

shutdownGracefully back to summary

shutdownGracefully	back to summary
public Future<?> shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Implements io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully. Doc from io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully. Signals this executor that the caller wants the executor to be shut down. Once this method is called, `isShuttingDown()` starts to return `true`, and the executor prepares to shut itself down. Unlike `shutdown()`, graceful shutdown ensures that no tasks are submitted for 'the quiet period' (usually a couple seconds) before it shuts itself down. If a task is submitted during the quiet period, it is guaranteed to be accepted and the quiet period will start over. Parameters quietPeriod:long the quiet period as described in the documentation timeout:long the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period unit:TimeUnit the unit of `quietPeriod` and `timeout` Returns:Future<?> the `terminationFuture()` Annotations @Override

public Future<?> shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit)

Implements io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully.

Doc from io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully.

Signals this executor that the caller wants the executor to be shut down. Once this method is called, isShuttingDown() starts to return true, and the executor prepares to shut itself down. Unlike shutdown(), graceful shutdown ensures that no tasks are submitted for 'the quiet period' (usually a couple seconds) before it shuts itself down. If a task is submitted during the quiet period, it is guaranteed to be accepted and the quiet period will start over.

Parameters

quietPeriod:long: the quiet period as described in the documentation
timeout:long: the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period
unit:TimeUnit: the unit of quietPeriod and timeout

Returns:Future<?>

the terminationFuture()

Annotations

@Override

startThread	back to summary
private void startThread()

takeTask back to summary

takeTask	back to summary
pack-priv Runnable takeTask() Take the next `Runnable` from the task queue and so will block if no task is currently present. Returns:Runnable `null` if the executor thread has been interrupted or waken up.

pack-priv Runnable takeTask()

Take the next Runnable from the task queue and so will block if no task is currently present.

Returns:Runnable: null if the executor thread has been interrupted or waken up.

terminationFuture back to summary

terminationFuture	back to summary
public Future<?> terminationFuture() Implements io.netty.util.concurrent.EventExecutorGroup.terminationFuture. Doc from io.netty.util.concurrent.EventExecutorGroup.terminationFuture. Returns the `Future` which is notified when all `EventExecutor`s managed by this `EventExecutorGroup` have been terminated. Annotations @Override

public Future<?> terminationFuture()

Implements io.netty.util.concurrent.EventExecutorGroup.terminationFuture.

Doc from io.netty.util.concurrent.EventExecutorGroup.terminationFuture.

Returns the Future which is notified when all EventExecutors managed by this EventExecutorGroup have been terminated.

Annotations

@Override

public final Class GlobalEventExecutor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class GlobalEventExecutor.TaskRunner

Constructor Summary

Method Summary

Constructor Detail

Method Detail