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, OrderedEventExecutor, ThreadAwareExecutor, java.lang.Iterable<EventExecutor>, java.util.concurrent.Executor, java.util.concurrent.ExecutorService, java.util.concurrent.ScheduledExecutorService

public final class GlobalEventExecutor
extends AbstractScheduledEventExecutor
implements OrderedEventExecutor

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	GlobalEventExecutor.StacklessUnsupportedOperationException
(package private) final class	GlobalEventExecutor.TaskRunner

Nested classes/interfaces inherited from class AbstractEventExecutor

AbstractEventExecutor.LazyRunnable

Field Summary

Fields

Modifier and Type	Field	Description
static final GlobalEventExecutor	INSTANCE
private static final InternalLogger	logger
(package private) final ScheduledFutureTask<java.lang.Void>	quietPeriodTask
private static final long	SCHEDULE_QUIET_PERIOD_INTERVAL
private final java.util.concurrent.atomic.AtomicBoolean	started
(package private) final java.util.concurrent.BlockingQueue<java.lang.Runnable>	taskQueue
private final GlobalEventExecutor.TaskRunner	taskRunner
private final Future<?>	terminationFuture
(package private) java.lang.Thread	thread
(package private) final java.util.concurrent.ThreadFactory	threadFactory

Fields inherited from class AbstractScheduledEventExecutor

nextTaskId, scheduledTaskQueue, WAKEUP_TASK

Fields inherited from class AbstractEventExecutor

DEFAULT_SHUTDOWN_QUIET_PERIOD, DEFAULT_SHUTDOWN_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor	Description
private	GlobalEventExecutor()

Method Summary

Modifier and Type	Method	Description
private void	addTask(java.lang.Runnable task)	Add a task to the task queue, or throws a RejectedExecutionException if this instance was shutdown before.
boolean	awaitInactivity(long timeout, java.util.concurrent.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, java.util.concurrent.TimeUnit unit)
void	execute(java.lang.Runnable task)
private void	execute0(java.lang.Runnable task)
private void	fetchFromScheduledTaskQueue()
boolean	inEventLoop(java.lang.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 all EventExecutors managed by this EventExecutorGroup are being shut down gracefully or was shut down.
boolean	isTerminated()
int	pendingTasks()	Return the number of tasks that are pending for processing.
private static void	setContextClassLoader(java.lang.Thread t, java.lang.ClassLoader cl)
void	shutdown()	Deprecated.
Future<?>	shutdownGracefully(long quietPeriod, long timeout, java.util.concurrent.TimeUnit unit)	Signals this executor that the caller wants the executor to be shut down.
private void	startThread()
(package private) java.lang.Runnable	takeTask()	Take the next Runnable from the task queue and so will block if no task is currently present.
Future<?>	terminationFuture()	Returns the Future which is notified when all EventExecutors managed by this EventExecutorGroup have been terminated.

Methods inherited from class AbstractScheduledEventExecutor

afterScheduledTaskSubmitted, beforeScheduledTaskSubmitted, cancelScheduledTasks, deadlineNanos, deadlineToDelayNanos, defaultCurrentTimeNanos, delayNanos, fetchFromScheduledTaskQueue, getCurrentTimeNanos, hasScheduledTasks, initialNanoTime, nanoTime, nextScheduledTaskDeadlineNanos, nextScheduledTaskNano, peekScheduledTask, pollScheduledTask, pollScheduledTask, removeScheduled, schedule, schedule, scheduleAtFixedRate, scheduledTaskQueue, scheduleFromEventLoop, scheduleRemoveScheduled, scheduleWithFixedDelay, ticker, validateScheduled

Methods inherited from class AbstractEventExecutor

iterator, lazyExecute, newTaskFor, newTaskFor, next, parent, runTask, safeExecute, 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 EventExecutor

inEventLoop, isExecutorThread, isSuspended, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, trySuspend

Methods inherited from interface EventExecutorGroup

iterator, next, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay, shutdownGracefully, shutdownNow, submit, submit, submit, ticker

Methods inherited from interface java.util.concurrent.ExecutorService

invokeAll, invokeAll, invokeAny, invokeAny

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

logger

private static final InternalLogger logger

SCHEDULE_QUIET_PERIOD_INTERVAL

private static final long SCHEDULE_QUIET_PERIOD_INTERVAL

INSTANCE

public static final GlobalEventExecutor INSTANCE

taskQueue

final java.util.concurrent.BlockingQueue<java.lang.Runnable> taskQueue

quietPeriodTask

final ScheduledFutureTask<java.lang.Void> quietPeriodTask

threadFactory

final java.util.concurrent.ThreadFactory threadFactory

taskRunner

private final GlobalEventExecutor.TaskRunner taskRunner

started

private final java.util.concurrent.atomic.AtomicBoolean started

thread

volatile java.lang.Thread thread

terminationFuture

private final Future<?> terminationFuture

Constructor Details

GlobalEventExecutor

private GlobalEventExecutor()

Method Details

takeTask

java.lang.Runnable takeTask()

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

Returns:

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

fetchFromScheduledTaskQueue

private void fetchFromScheduledTaskQueue()

pendingTasks

public int pendingTasks()

Return the number of tasks that are pending for processing.

addTask

private void addTask(java.lang.Runnable task)

Add a task to the task queue, or throws a RejectedExecutionException if this instance was shutdown before.

inEventLoop

public boolean inEventLoop(java.lang.Thread thread)

Description copied from interface: EventExecutor

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

Specified by:

inEventLoop in interface EventExecutor

shutdownGracefully

public Future<?> shutdownGracefully(long quietPeriod,
 long timeout,
 java.util.concurrent.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.

Specified by:

shutdownGracefully in interface EventExecutorGroup

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 all EventExecutors managed by this EventExecutorGroup have been terminated.

Specified by:

terminationFuture in interface EventExecutorGroup

shutdown

@Deprecated
public void shutdown()

Deprecated.

Specified by:

shutdown in interface EventExecutorGroup

Specified by:

shutdown in interface java.util.concurrent.ExecutorService

Specified by:

shutdown in class AbstractEventExecutor

isShuttingDown

public boolean isShuttingDown()

Description copied from interface: EventExecutorGroup

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

Specified by:

isShuttingDown in interface EventExecutorGroup

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface java.util.concurrent.ExecutorService

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface java.util.concurrent.ExecutorService

awaitTermination

public boolean awaitTermination(long timeout,
 java.util.concurrent.TimeUnit unit)

Specified by:

awaitTermination in interface java.util.concurrent.ExecutorService

awaitInactivity

public boolean awaitInactivity(long timeout,
 java.util.concurrent.TimeUnit unit)
                        throws java.lang.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:

java.lang.InterruptedException

execute

public void execute(java.lang.Runnable task)

Specified by:

execute in interface java.util.concurrent.Executor

execute0

private void execute0(java.lang.Runnable task)

startThread

private void startThread()

setContextClassLoader

private static void setContextClassLoader(java.lang.Thread t,
 java.lang.ClassLoader cl)