Package io.netty.util.concurrent

Class UnorderedThreadPoolEventExecutor

java.lang.Object

java.util.concurrent.AbstractExecutorService

java.util.concurrent.ThreadPoolExecutor

java.util.concurrent.ScheduledThreadPoolExecutor

io.netty.util.concurrent.UnorderedThreadPoolEventExecutor

All Implemented Interfaces:

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

public final class UnorderedThreadPoolEventExecutor
extends ScheduledThreadPoolExecutor
implements EventExecutor

EventExecutor implementation which makes no guarantees about the ordering of task execution that are submitted because there may be multiple threads executing these tasks. This implementation is most useful for protocols that do not need strict ordering. Because it provides no ordering care should be taken when using it!

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ThreadPoolExecutor

ThreadPoolExecutor.AbortPolicy, ThreadPoolExecutor.CallerRunsPolicy, ThreadPoolExecutor.DiscardOldestPolicy, ThreadPoolExecutor.DiscardPolicy

Constructor Summary

Constructors

Constructor	Description
UnorderedThreadPoolEventExecutor(int corePoolSize)	Calls UnorderedThreadPoolEventExecutor(int, ThreadFactory) using DefaultThreadFactory.
UnorderedThreadPoolEventExecutor(int corePoolSize, RejectedExecutionHandler handler)	Calls UnorderedThreadPoolEventExecutor(int, ThreadFactory, java.util.concurrent.RejectedExecutionHandler) using DefaultThreadFactory.
UnorderedThreadPoolEventExecutor(int corePoolSize, ThreadFactory threadFactory)	See ScheduledThreadPoolExecutor(int, ThreadFactory)
UnorderedThreadPoolEventExecutor(int corePoolSize, ThreadFactory threadFactory, RejectedExecutionHandler handler)	See ScheduledThreadPoolExecutor(int, ThreadFactory, RejectedExecutionHandler)

Method Summary

Modifier and Type	Method	Description
protected <V> RunnableScheduledFuture<V>	decorateTask(Runnable runnable, RunnableScheduledFuture<V> task)
protected <V> RunnableScheduledFuture<V>	decorateTask(Callable<V> callable, RunnableScheduledFuture<V> task)
void	execute(Runnable command)
boolean	inEventLoop()	Calls EventExecutor.inEventLoop(Thread) with Thread.currentThread() as argument
boolean	inEventLoop(Thread thread)	Return true if the given Thread is executed in the event loop, false otherwise.
boolean	isShuttingDown()	Returns true if and only if all EventExecutors managed by this EventExecutorGroup are being shut down gracefully or was shut down.
Iterator<EventExecutor>	iterator()
<V> Future<V>	newFailedFuture(Throwable cause)	Create a new Future which is marked as failed already.
<V> ProgressivePromise<V>	newProgressivePromise()	Create a new ProgressivePromise.
<V> Promise<V>	newPromise()	Return a new Promise.
<V> Future<V>	newSucceededFuture(V result)	Create a new Future which is marked as succeeded already.
EventExecutor	next()	Returns one of the EventExecutors managed by this EventExecutorGroup.
EventExecutorGroup	parent()	Return the EventExecutorGroup which is the parent of this EventExecutor,
ScheduledFuture<?>	schedule(Runnable command, long delay, TimeUnit unit)
<V> ScheduledFuture<V>	schedule(Callable<V> callable, long delay, TimeUnit unit)
ScheduledFuture<?>	scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
ScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
void	shutdown()
Future<?>	shutdownGracefully()	Shortcut method for EventExecutorGroup.shutdownGracefully(long, long, TimeUnit) with sensible default values.
Future<?>	shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit)	Signals this executor that the caller wants the executor to be shut down.
List<Runnable>	shutdownNow()
Future<?>	submit(Runnable task)
<T> Future<T>	submit(Runnable task, T result)
<T> Future<T>	submit(Callable<T> task)
Future<?>	terminationFuture()	Returns the Future which is notified when all EventExecutors managed by this EventExecutorGroup have been terminated.

Methods inherited from class java.util.concurrent.ScheduledThreadPoolExecutor

getContinueExistingPeriodicTasksAfterShutdownPolicy, getExecuteExistingDelayedTasksAfterShutdownPolicy, getQueue, getRemoveOnCancelPolicy, setContinueExistingPeriodicTasksAfterShutdownPolicy, setExecuteExistingDelayedTasksAfterShutdownPolicy, setRemoveOnCancelPolicy

Methods inherited from class java.util.concurrent.ThreadPoolExecutor

afterExecute, allowCoreThreadTimeOut, allowsCoreThreadTimeOut, awaitTermination, beforeExecute, finalize, getActiveCount, getCompletedTaskCount, getCorePoolSize, getKeepAliveTime, getLargestPoolSize, getMaximumPoolSize, getPoolSize, getRejectedExecutionHandler, getTaskCount, getThreadFactory, isShutdown, isTerminated, isTerminating, prestartAllCoreThreads, prestartCoreThread, purge, remove, setCorePoolSize, setKeepAliveTime, setMaximumPoolSize, setRejectedExecutionHandler, setThreadFactory, terminated, toString

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny, newTaskFor, newTaskFor

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.ExecutorService

awaitTermination, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isTerminated

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

UnorderedThreadPoolEventExecutor

public UnorderedThreadPoolEventExecutor(int corePoolSize)

Calls UnorderedThreadPoolEventExecutor(int, ThreadFactory) using DefaultThreadFactory.

UnorderedThreadPoolEventExecutor

public UnorderedThreadPoolEventExecutor(int corePoolSize,
                                        ThreadFactory threadFactory)

See ScheduledThreadPoolExecutor(int, ThreadFactory)

UnorderedThreadPoolEventExecutor

public UnorderedThreadPoolEventExecutor(int corePoolSize,
                                        RejectedExecutionHandler handler)

Calls UnorderedThreadPoolEventExecutor(int, ThreadFactory, java.util.concurrent.RejectedExecutionHandler) using DefaultThreadFactory.

UnorderedThreadPoolEventExecutor

public UnorderedThreadPoolEventExecutor(int corePoolSize,
                                        ThreadFactory threadFactory,
                                        RejectedExecutionHandler handler)

See ScheduledThreadPoolExecutor(int, ThreadFactory, RejectedExecutionHandler)

Method Detail

next

public EventExecutor next()

Description copied from interface: EventExecutorGroup

Returns one of the EventExecutors managed by this EventExecutorGroup.

Specified by:

next in interface EventExecutorGroup

parent

public EventExecutorGroup parent()

Description copied from interface: EventExecutor

Return the EventExecutorGroup which is the parent of this EventExecutor,

Specified by:

parent in interface EventExecutor

inEventLoop

public boolean inEventLoop()

Description copied from interface: EventExecutor

Calls EventExecutor.inEventLoop(Thread) with Thread.currentThread() as argument

Specified by:

inEventLoop in interface EventExecutor

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.

Specified by:

inEventLoop in interface EventExecutor

newPromise

public <V> Promise<V> newPromise()

Description copied from interface: EventExecutor

Return a new Promise.

Specified by:

newPromise in interface EventExecutor

newProgressivePromise

public <V> ProgressivePromise<V> newProgressivePromise()

Description copied from interface: EventExecutor

Create a new ProgressivePromise.

Specified by:

newProgressivePromise in interface EventExecutor

newSucceededFuture

public <V> Future<V> newSucceededFuture(V result)

Description copied from interface: EventExecutor

Create a new Future which is marked as succeeded already. So Future.isSuccess() will return true. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.

Specified by:

newSucceededFuture in interface EventExecutor

newFailedFuture

public <V> Future<V> newFailedFuture(Throwable cause)

Description copied from interface: EventExecutor

Create a new Future which is marked as failed already. So Future.isSuccess() will return false. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.

Specified by:

newFailedFuture in interface EventExecutor

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

shutdownNow

public List<Runnable> shutdownNow()

Specified by:

shutdownNow in interface EventExecutorGroup

Specified by:

shutdownNow in interface ExecutorService

Overrides:

shutdownNow in class ScheduledThreadPoolExecutor

shutdown

public void shutdown()

Specified by:

shutdown in interface EventExecutorGroup

Specified by:

shutdown in interface ExecutorService

Overrides:

shutdown in class ScheduledThreadPoolExecutor

shutdownGracefully

public Future<?> shutdownGracefully()

Description copied from interface: EventExecutorGroup

Shortcut method for EventExecutorGroup.shutdownGracefully(long, long, TimeUnit) with sensible default values.

Specified by:

shutdownGracefully in interface EventExecutorGroup

Returns:

the EventExecutorGroup.terminationFuture()

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.

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

iterator

public Iterator<EventExecutor> iterator()

Specified by:

iterator in interface EventExecutorGroup

Specified by:

iterator in interface Iterable<EventExecutor>

decorateTask

protected <V> RunnableScheduledFuture<V> decorateTask(Runnable runnable,
                                                      RunnableScheduledFuture<V> task)

Overrides:

decorateTask in class ScheduledThreadPoolExecutor

decorateTask

protected <V> RunnableScheduledFuture<V> decorateTask(Callable<V> callable,
                                                      RunnableScheduledFuture<V> task)

Overrides:

decorateTask in class ScheduledThreadPoolExecutor

schedule

public ScheduledFuture<?> schedule(Runnable command,
                                   long delay,
                                   TimeUnit unit)

Specified by:

schedule in interface EventExecutorGroup

Specified by:

schedule in interface ScheduledExecutorService

Overrides:

schedule in class ScheduledThreadPoolExecutor

schedule

public <V> ScheduledFuture<V> schedule(Callable<V> callable,
                                       long delay,
                                       TimeUnit unit)

Specified by:

schedule in interface EventExecutorGroup

Specified by:

schedule in interface ScheduledExecutorService

Overrides:

schedule in class ScheduledThreadPoolExecutor

scheduleAtFixedRate

public ScheduledFuture<?> scheduleAtFixedRate(Runnable command,
                                              long initialDelay,
                                              long period,
                                              TimeUnit unit)

Specified by:

scheduleAtFixedRate in interface EventExecutorGroup

Specified by:

scheduleAtFixedRate in interface ScheduledExecutorService

Overrides:

scheduleAtFixedRate in class ScheduledThreadPoolExecutor

scheduleWithFixedDelay

public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
                                                 long initialDelay,
                                                 long delay,
                                                 TimeUnit unit)

Specified by:

scheduleWithFixedDelay in interface EventExecutorGroup

Specified by:

scheduleWithFixedDelay in interface ScheduledExecutorService

Overrides:

scheduleWithFixedDelay in class ScheduledThreadPoolExecutor

submit

public Future<?> submit(Runnable task)

Specified by:

submit in interface EventExecutorGroup

Specified by:

submit in interface ExecutorService

Overrides:

submit in class ScheduledThreadPoolExecutor

submit

public <T> Future<T> submit(Runnable task,
                            T result)

Specified by:

submit in interface EventExecutorGroup

Specified by:

submit in interface ExecutorService

Overrides:

submit in class ScheduledThreadPoolExecutor

submit

public <T> Future<T> submit(Callable<T> task)

Specified by:

submit in interface EventExecutorGroup

Specified by:

submit in interface ExecutorService

Overrides:

submit in class ScheduledThreadPoolExecutor

execute

public void execute(Runnable command)

Specified by:

execute in interface Executor

Overrides:

execute in class ScheduledThreadPoolExecutor