Module io.netty5.common

Package io.netty5.util.concurrent

Class NonStickyEventExecutorGroup

java.lang.Object

io.netty5.util.concurrent.NonStickyEventExecutorGroup

All Implemented Interfaces:

EventExecutorGroup, Iterable<EventExecutor>, Executor

@UnstableApi
public final class NonStickyEventExecutorGroup
extends Object
implements EventExecutorGroup

EventExecutorGroup which will preserve Runnable execution order but makes no guarantees about what EventExecutor (and therefore Thread) will be used to execute the Runnables.

The EventExecutorGroup.next() for the wrapped EventExecutorGroup must NOT return executors of type OrderedEventExecutor.

Constructor Summary

Constructors

Constructor	Description
NonStickyEventExecutorGroup(EventExecutorGroup group)	Creates a new instance.
NonStickyEventExecutorGroup(EventExecutorGroup group, int maxTaskExecutePerRun)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long timeout, TimeUnit unit)	Wait for this EventExecutorGroup to terminate, up to the given timeout.
void	execute(Runnable task)
boolean	isShutdown()	Returns true if all EventExecutors managed by this EventExecutorGroup have been shut down gracefully and moved past the grace period so that they are no longer accepting any new tasks.
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()	Returns true if all EventExecutors managed by this EventExecutorGroup are shut down, and all of their tasks have completed.
Iterator<EventExecutor>	iterator()
EventExecutor	next()	Returns one of the EventExecutors managed by this EventExecutorGroup.
Future<Void>	schedule(Runnable task, long delay, TimeUnit unit)	Schedule the given task for execution after the given delay, in the next available EventExecutor in this group, and return a future that produces a null result when the task completes.
<V> Future<V>	schedule(Callable<V> task, long delay, TimeUnit unit)	Schedule the given task for execution after the given delay, in the next available EventExecutor in this group, and return a future that will return the result of the callable when the task completes.
Future<Void>	scheduleAtFixedRate(Runnable task, long initialDelay, long period, TimeUnit unit)	Schedule the given task for periodic execution in the next available EventExecutor.
Future<Void>	scheduleWithFixedDelay(Runnable task, long initialDelay, long delay, TimeUnit unit)	Schedule the given task for periodic execution in the next available EventExecutor.
Future<Void>	shutdownGracefully()	Shortcut method for EventExecutorGroup.shutdownGracefully(long, long, TimeUnit) with sensible default values.
Future<Void>	shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit)	Signals this executor that the caller wants the executor to be shut down.
Future<Void>	submit(Runnable task)	Submit the given task for execution in the next available EventExecutor in this group, and return a future that produces a null result when the task completes.
<T> Future<T>	submit(Runnable task, T result)	Submit the given task for execution in the next available EventExecutor in this group, and return a future that produces the given result when the task completes.
<T> Future<T>	submit(Callable<T> task)	Submit the given task for execution in the next available EventExecutor in this group, and return a future that will return the result of the callable when the task completes.
Future<Void>	terminationFuture()	Returns the Future which is notified when all EventExecutors managed by this EventExecutorGroup have been terminated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

NonStickyEventExecutorGroup

public NonStickyEventExecutorGroup(EventExecutorGroup group)

Creates a new instance. Be aware that the given EventExecutorGroup MUST NOT contain any OrderedEventExecutors.

NonStickyEventExecutorGroup

public NonStickyEventExecutorGroup(EventExecutorGroup group,
                                   int maxTaskExecutePerRun)

Creates a new instance. Be aware that the given EventExecutorGroup MUST NOT contain any OrderedEventExecutors.

Method Detail

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.

An executor group that "is shutting down" can still accept new tasks for a little while (the grace period), but will eventually start rejecting new tasks. At that point, the executor group will be shut down.

Specified by:

isShuttingDown in interface EventExecutorGroup

Returns:

true if all executors in this group have at least started shutting down, otherwise false.

shutdownGracefully

public Future<Void> 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<Void> 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. This method 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 shutting down regardless if a task was submitted during the quiet period.

unit - the unit of quietPeriod and timeout

Returns:

the EventExecutorGroup.terminationFuture()

terminationFuture

public Future<Void> 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

Returns:

The Future representing the termination of this EventExecutorGroup.

next

public EventExecutor next()

Description copied from interface: EventExecutorGroup

Returns one of the EventExecutors managed by this EventExecutorGroup.

Specified by:

next in interface EventExecutorGroup

iterator

public Iterator<EventExecutor> iterator()

Specified by:

iterator in interface EventExecutorGroup

Specified by:

iterator in interface Iterable<EventExecutor>

submit

public Future<Void> submit(Runnable task)

Description copied from interface: EventExecutorGroup

Submit the given task for execution in the next available EventExecutor in this group, and return a future that produces a null result when the task completes.

Specified by:

submit in interface EventExecutorGroup

Parameters:

task - The task that should be executed in this EventExecutorGroup.

Returns:

A future that represents the completion of the submitted task.

submit

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

Description copied from interface: EventExecutorGroup

Submit the given task for execution in the next available EventExecutor in this group, and return a future that produces the given result when the task completes.

Specified by:

submit in interface EventExecutorGroup

Type Parameters:

T - The type of the future result.

Parameters:

task - The task that should be executed in this EventExecutorGroup.

result - The value that the returned future will complete with, if the task completes successfully.

Returns:

A future that represents the completion of the submitted task.

submit

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

Description copied from interface: EventExecutorGroup

Submit the given task for execution in the next available EventExecutor in this group, and return a future that will return the result of the callable when the task completes.

Specified by:

submit in interface EventExecutorGroup

Type Parameters:

T - The type of the future result.

Parameters:

task - The task that should be executed in this EventExecutorGroup.

Returns:

A future that represents the completion of the submitted task.

schedule

public Future<Void> schedule(Runnable task,
                             long delay,
                             TimeUnit unit)

Description copied from interface: EventExecutorGroup

Schedule the given task for execution after the given delay, in the next available EventExecutor in this group, and return a future that produces a null result when the task completes.

Specified by:

schedule in interface EventExecutorGroup

Parameters:

task - The task that should be executed in this EventExecutorGroup after the given delay.

delay - A positive time delay, in the given time unit.

unit - The non-null time unit for the delay.

Returns:

A future that represents the completion of the scheduled task.

schedule

public <V> Future<V> schedule(Callable<V> task,
                              long delay,
                              TimeUnit unit)

Description copied from interface: EventExecutorGroup

Schedule the given task for execution after the given delay, in the next available EventExecutor in this group, and return a future that will return the result of the callable when the task completes.

Specified by:

schedule in interface EventExecutorGroup

Type Parameters:

V - The type of the future result.

Parameters:

task - The task that should be executed in this EventExecutorGroup after the given delay.

delay - A positive time delay, in the given time unit.

unit - The non-null time unit for the delay.

Returns:

A future that represents the completion of the scheduled task.

scheduleAtFixedRate

public Future<Void> scheduleAtFixedRate(Runnable task,
                                        long initialDelay,
                                        long period,
                                        TimeUnit unit)

Description copied from interface: EventExecutorGroup

Schedule the given task for periodic execution in the next available EventExecutor. The first execution will occur after the given initial delay, and the following repeated executions will occur with the given period of time between each execution is started. If the task takes longer to complete than the requested period, then the following executions will be delayed, rather than allowing multiple instances of the task to run concurrently.

The task will be executed repeatedly until it either fails with an exception, or its future is cancelled. The future thus will never complete successfully.

Specified by:

scheduleAtFixedRate in interface EventExecutorGroup

Parameters:

task - The task that should be scheduled to execute at a fixed rate in this EventExecutorGroup.

initialDelay - The positive initial delay for the first task execution, in terms of the given time unit.

period - The positive period for the execution frequency to use after the first execution has started, in terms of the given time unit.

unit - The non-null time unit for the delay and period.

Returns:

A future that represents the recurring task, and which can be cancelled to stop future executions.

scheduleWithFixedDelay

public Future<Void> scheduleWithFixedDelay(Runnable task,
                                           long initialDelay,
                                           long delay,
                                           TimeUnit unit)

Description copied from interface: EventExecutorGroup

Schedule the given task for periodic execution in the next available EventExecutor. The first execution will occur after the given initial delay, and the following repeated executions will occur with the given subsequent delay between one task completing and the next task starting. The delay from the completion of one task, to the start of the next, stays unchanged regardless of how long a task takes to complete.

This is in contrast to EventExecutorGroup.scheduleAtFixedRate(Runnable, long, long, TimeUnit) which varies the delays between the tasks in order to hit a given frequency.

The task will be executed repeatedly until it either fails with an exception, or its future is cancelled. The future thus will never complete successfully.

Specified by:

scheduleWithFixedDelay in interface EventExecutorGroup

Parameters:

task - The task that should be scheduled to execute with fixed delays in this EventExecutorGroup.

initialDelay - The positive initial delay for the first task execution, in terms of the given time unit.

delay - The positive subsequent delay between task, to use after the first execution has completed, in terms of the given time unit.

unit - The non-null time unit for the delays.

Returns:

A future that represents the recurring task, and which can be cancelled to stop future executions.

isShutdown

public boolean isShutdown()

Description copied from interface: EventExecutorGroup

Returns true if all EventExecutors managed by this EventExecutorGroup have been shut down gracefully and moved past the grace period so that they are no longer accepting any new tasks.

An executor group that "is shut down" might still be executing tasks that it has queued up, but it will no longer be accepting any new tasks. Once all running and queued tasks have completed, the executor group will be terminated.

Specified by:

isShutdown in interface EventExecutorGroup

Returns:

true if all executors in this group have shut down and are no longer accepting any new tasks.

isTerminated

public boolean isTerminated()

Description copied from interface: EventExecutorGroup

Returns true if all EventExecutors managed by this EventExecutorGroup are shut down, and all of their tasks have completed.

Specified by:

isTerminated in interface EventExecutorGroup

Returns:

true if all executors in this group have terminated.

awaitTermination

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

Description copied from interface: EventExecutorGroup

Wait for this EventExecutorGroup to terminate, up to the given timeout.

Specified by:

awaitTermination in interface EventExecutorGroup

Parameters:

timeout - The non-negative maximum amount of time to wait for the executor group to terminate.

unit - The non-null time unit of the timeout.

Returns:

true if the executor group terminated within the specific timeout.

Throws:

InterruptedException - If this thread was interrupted while waiting for executor group to terminate.

execute

public void execute(Runnable task)

Specified by:

execute in interface EventExecutorGroup

Specified by:

execute in interface Executor