io.netty.util.concurrent

Class GlobalEventExecutor

java.lang.Object

java.util.concurrent.AbstractExecutorService

io.netty.util.concurrent.AbstractEventExecutor

io.netty.util.concurrent.AbstractScheduledEventExecutor

io.netty.util.concurrent.GlobalEventExecutor

All Implemented Interfaces:

EventExecutor, EventExecutorGroup, Iterable<EventExecutor>, Executor, ExecutorService, ScheduledExecutorService

public final class GlobalEventExecutor
extends AbstractScheduledEventExecutor

Single-thread singleton EventExecutor. It starts the thread automatically and stops it when there is no task pending in the task queue for 1 second. Please note it is not scalable to schedule large number of tasks to this executor; use a dedicated executor.

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalEventExecutor	INSTANCE

Method Summary

Modifier and Type	Method and Description
boolean	awaitInactivity(long timeout, TimeUnit unit) Waits until the worker thread of this executor has no tasks left in its task queue and terminates itself.
boolean	awaitTermination(long timeout, TimeUnit unit)
void	execute(Runnable task)
boolean	inEventLoop(Thread thread) Return true if the given Thread is executed in the event loop, false otherwise.
boolean	isShutdown()
boolean	isShuttingDown() Returns true if and only if this executor was started to be shut down gracefuclly or was shut down.
boolean	isTerminated()
EventExecutorGroup	parent() Return the EventExecutorGroup which is the parent of this EventExecutor,
int	pendingTasks() Return the number of tasks that are pending for processing.
void	shutdown() Deprecated.
Future<?>	shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Signals this executor that the caller wants the executor to be shut down.
Future<?>	terminationFuture() Returns the Future which is notified when this executor has been terminated.

Methods inherited from class io.netty.util.concurrent.AbstractScheduledEventExecutor

cancelScheduledTasks, hasScheduledTasks, nanoTime, nextScheduledTaskNano, pollScheduledTask, pollScheduledTask, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay

Methods inherited from class io.netty.util.concurrent.AbstractEventExecutor

inEventLoop, iterator, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, newTaskFor, newTaskFor, next, shutdownGracefully, shutdownNow, submit, submit, submit

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.ExecutorService

invokeAll, invokeAll, invokeAny, invokeAny

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

INSTANCE

public static final GlobalEventExecutor INSTANCE

Method Detail

parent

public EventExecutorGroup parent()

Description copied from interface: EventExecutor

Return the EventExecutorGroup which is the parent of this EventExecutor,

pendingTasks

public int pendingTasks()

Return the number of tasks that are pending for processing. Be aware that this operation may be expensive as it depends on the internal implementation of the SingleThreadEventExecutor. So use it was care!

inEventLoop

public boolean inEventLoop(Thread thread)

Description copied from interface: EventExecutor

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

shutdownGracefully

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

Description copied from interface: EventExecutorGroup

Signals this executor that the caller wants the executor to be shut down. Once this method is called, EventExecutorGroup.isShuttingDown() starts to return true, and the executor prepares to shut itself down. Unlike EventExecutorGroup.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 - the quiet period as described in the documentation

timeout - the maximum amount of time to wait until the executor is EventExecutorGroup.shutdown() regardless if a task was submitted during the quiet period

unit - the unit of quietPeriod and timeout

Returns:

the EventExecutorGroup.terminationFuture()

terminationFuture

public Future<?> terminationFuture()

Description copied from interface: EventExecutorGroup

Returns the Future which is notified when this executor has been terminated.

shutdown

@Deprecated
public void shutdown()

Deprecated.

Specified by:

shutdown in interface EventExecutorGroup

Specified by:

shutdown in interface ExecutorService

Specified by:

shutdown in class AbstractEventExecutor

isShuttingDown

public boolean isShuttingDown()

Description copied from interface: EventExecutorGroup

Returns true if and only if this executor was started to be shut down gracefuclly or was shut down.

isShutdown

public boolean isShutdown()

isTerminated

public boolean isTerminated()

awaitTermination

public boolean awaitTermination(long timeout,
                                TimeUnit unit)

awaitInactivity

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:

true if and only if the worker thread has been terminated

Throws:

InterruptedException

execute

public void execute(Runnable task)