Module io.netty5.common

Package io.netty5.util.concurrent

Class AbstractEventExecutor

java.lang.Object

io.netty5.util.concurrent.AbstractEventExecutor

All Implemented Interfaces:

EventExecutor, EventExecutorGroup, FuturePromiseFactory, Iterable<EventExecutor>, Executor

Direct Known Subclasses:

AbstractScheduledEventExecutor, ImmediateEventExecutor

public abstract class AbstractEventExecutor
extends Object
implements EventExecutor

Abstract base class for EventExecutor implementations.

Constructor Summary

Constructors

Constructor	Description
AbstractEventExecutor()

Method Summary

Modifier and Type	Method	Description
<V> Future<V>	newSucceededFuture(V result)	Create a new Future which is marked as succeeded already.
protected <T> RunnableFuture<T>	newTaskFor(Runnable runnable, T value)	Decorate the given Runnable and its return value, as a RunnableFuture, such that the returned RunnableFuture completes with the given result at the end of executing its Runnable.run() method.
protected <T> RunnableFuture<T>	newTaskFor(Callable<T> callable)	Decorate the given Callable and its return value, as a RunnableFuture, such that the returned RunnableFuture completes with the returned result from the Callable at the end of executing its Runnable.run() method.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.util.concurrent.EventExecutor

execute, inEventLoop, inEventLoop, iterator, newFailedFuture, newPromise, next, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay

Methods inherited from interface io.netty5.util.concurrent.EventExecutorGroup

awaitTermination, isShutdown, isShuttingDown, isTerminated, shutdownGracefully, shutdownGracefully, terminationFuture

Methods inherited from interface io.netty5.util.concurrent.FuturePromiseFactory

newSucceededFuture

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractEventExecutor

public AbstractEventExecutor()

Method Detail

newSucceededFuture

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

Description copied from interface: EventExecutor

Create a new Future which is marked as succeeded already. So AsynchronousResult.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

Specified by:

newSucceededFuture in interface FuturePromiseFactory

submit

public final 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 EventExecutor

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 final <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 EventExecutor

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 final <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 EventExecutor

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.

newTaskFor

protected <T> RunnableFuture<T> newTaskFor(Runnable runnable,
                                           T value)

Decorate the given Runnable and its return value, as a RunnableFuture, such that the returned RunnableFuture completes with the given result at the end of executing its Runnable.run() method.

The returned RunnableFuture is the task that will actually be run by a thread in this executor.

This method can be overridden by sub-classes to hook into the life cycle of the given task.

Type Parameters:

T - The type of the result value.

Parameters:

runnable - The task to be decorated.

value - The value that the returned future will complete with, assuming the given Runnable doesn't throw an exception.

Returns:

The decorated Runnable that is now also a Future.

newTaskFor

protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable)

Decorate the given Callable and its return value, as a RunnableFuture, such that the returned RunnableFuture completes with the returned result from the Callable at the end of executing its Runnable.run() method.

The returned RunnableFuture is the task that will actually be run by a thread in this executor.

This method can be overridden by sub-classes to hook into the life cycle of the given task.

Type Parameters:

T - The type of the result value.

Parameters:

callable - The task to be decorated.

Returns:

The decorated Runnable that is now also a Future.