Netty/Transport 4.1.107.Final · io.netty.channel.embedded.EmbeddedEventLoop

Modifier and Type	Field and Description
private long	frozenTimestamp When time is frozen, the timestamp returned by `getCurrentTimeNanos()`.
private long	startTime When time is not `frozen`, the base time to subtract from `System#nanoTime()`.
private final Queue<Runnable>	tasks
private boolean	timeFrozen Whether time is currently frozen.

Access	Constructor and Description
pack-priv	EmbeddedEventLoop()

Modifier and Type	Method and Description
pack-priv void	advanceTimeBy(long nanos)
public boolean	awaitTermination(long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.ExecutorService.awaitTermination. Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.
protected void	cancelScheduledTasks() Overrides io.netty.util.concurrent.AbstractScheduledEventExecutor.cancelScheduledTasks. Cancel all scheduled tasks.
public void	execute(Runnable the runnable task command) Implements java.util.concurrent.Executor.execute. Executes the given command at some time in the future.
pack-priv void	freezeTime()
protected long	getCurrentTimeNanos() Overrides io.netty.util.concurrent.AbstractScheduledEventExecutor.getCurrentTimeNanos. Get the current time in nanoseconds by this executor's clock.
pack-priv boolean	hasPendingNormalTasks()
public boolean	inEventLoop() Overrides io.netty.util.concurrent.AbstractEventExecutor.inEventLoop. Implements io.netty.util.concurrent.EventExecutor.inEventLoop. Calls `inEventLoop(Thread)` with `Thread#currentThread()` as argument
public boolean	inEventLoop(Thread thread) Implements io.netty.util.concurrent.EventExecutor.inEventLoop. Return `true` if the given `Thread` is executed in the event loop, `false` otherwise.
public boolean	isShutdown() Implements java.util.concurrent.ExecutorService.isShutdown. Returns `true` if this executor has been shut down.
public boolean	isShuttingDown() Implements io.netty.util.concurrent.EventExecutorGroup.isShuttingDown. Returns `true` if and only if all `EventExecutor`s managed by this `EventExecutorGroup` are being shut down gracefully or was shut down.
public boolean	isTerminated() Implements java.util.concurrent.ExecutorService.isTerminated. Returns `true` if all tasks have completed following shut down.
public EventLoop	next() Overrides io.netty.util.concurrent.AbstractEventExecutor.next. Implements io.netty.util.concurrent.EventExecutor.next, io.netty.channel.EventLoopGroup.next. Return the next `EventLoop` to use
pack-priv long	nextScheduledTask()
public EventLoopGroup	parent() Overrides io.netty.util.concurrent.AbstractEventExecutor.parent. Implements io.netty.channel.EventLoop.parent, io.netty.util.concurrent.EventExecutor.parent. Return the `EventExecutorGroup` which is the parent of this `EventExecutor`,
public ChannelFuture	register(Channel channel) Implements io.netty.channel.EventLoopGroup.register. Register a `Channel` with this `EventLoop`.
public ChannelFuture	register(ChannelPromise promise) Implements io.netty.channel.EventLoopGroup.register. Register a `Channel` with this `EventLoop` using a `ChannelFuture`.
public ChannelFuture	register(Channel channel, ChannelPromise promise) Implements io.netty.channel.EventLoopGroup.register. Deprecated Register a `Channel` with this `EventLoop`.
pack-priv long	runScheduledTasks()
pack-priv void	runTasks()
public void	shutdown() Implements abstract io.netty.util.concurrent.AbstractEventExecutor.shutdown. Implements io.netty.util.concurrent.EventExecutorGroup.shutdown, java.util.concurrent.ExecutorService.shutdown. Deprecated Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
public Future<?>	shutdownGracefully(long the quiet period as described in the documentation quietPeriod, long the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period timeout, TimeUnit the unit of `quietPeriod` and `timeout` unit) Implements io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully. Signals this executor that the caller wants the executor to be shut down.
public Future<?>	terminationFuture() Implements io.netty.util.concurrent.EventExecutorGroup.terminationFuture. Returns the `Future` which is notified when all `EventExecutor`s managed by this `EventExecutorGroup` have been terminated.
pack-priv void	unfreezeTime()

frozenTimestamp	back to summary
private long frozenTimestamp When time is frozen, the timestamp returned by `getCurrentTimeNanos()`. When unfrozen, this is unused.

startTime	back to summary
private long startTime When time is not `frozen`, the base time to subtract from `System#nanoTime()`. When time is frozen, this variable is unused. Initialized to `initialNanoTime()` so that until one of the time mutator methods is called, `getCurrentTimeNanos()` matches the default behavior.

tasks	back to summary
private final Queue<Runnable> tasks

timeFrozen	back to summary
private boolean timeFrozen Whether time is currently frozen.

EmbeddedEventLoop	back to summary
pack-priv EmbeddedEventLoop()

Method Detail

advanceTimeBy	back to summary
pack-priv void advanceTimeBy(long nanos)

awaitTermination back to summary

awaitTermination	back to summary
public boolean awaitTermination(long timeout, TimeUnit unit) Implements java.util.concurrent.ExecutorService.awaitTermination. Doc from java.util.concurrent.ExecutorService.awaitTermination. Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Returns:boolean `true` if this executor terminated and `false` if the timeout elapsed before termination Annotations @Override

public boolean awaitTermination(long timeout, TimeUnit unit)

Implements java.util.concurrent.ExecutorService.awaitTermination.

Doc from java.util.concurrent.ExecutorService.awaitTermination.

Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:boolean

true if this executor terminated and false if the timeout elapsed before termination

Annotations

@Override

cancelScheduledTasks back to summary

cancelScheduledTasks	back to summary
protected void cancelScheduledTasks() Overrides io.netty.util.concurrent.AbstractScheduledEventExecutor.cancelScheduledTasks. Doc from io.netty.util.concurrent.AbstractScheduledEventExecutor.cancelScheduledTasks. Cancel all scheduled tasks. This method MUST be called only when `inEventLoop()` is `true`. Annotations @Override

protected void cancelScheduledTasks()

Overrides io.netty.util.concurrent.AbstractScheduledEventExecutor.cancelScheduledTasks.

Doc from io.netty.util.concurrent.AbstractScheduledEventExecutor.cancelScheduledTasks.

Cancel all scheduled tasks. This method MUST be called only when inEventLoop() is true.

Annotations

@Override

execute back to summary

execute	back to summary
public void execute(Runnable command) Implements java.util.concurrent.Executor.execute. Doc from java.util.concurrent.Executor.execute. Executes the given command at some time in the future. The command may execute in a new thread, in a pooled thread, or in the calling thread, at the discretion of the `Executor` implementation. Parameters command:Runnable the runnable task Annotations @Override

public void execute(Runnable command)

Implements java.util.concurrent.Executor.execute.

Doc from java.util.concurrent.Executor.execute.

Executes the given command at some time in the future. The command may execute in a new thread, in a pooled thread, or in the calling thread, at the discretion of the Executor implementation.

Parameters

command:Runnable: the runnable task

Annotations

@Override

freezeTime	back to summary
pack-priv void freezeTime()

getCurrentTimeNanos back to summary

getCurrentTimeNanos	back to summary
protected long getCurrentTimeNanos() Overrides io.netty.util.concurrent.AbstractScheduledEventExecutor.getCurrentTimeNanos. Doc from io.netty.util.concurrent.AbstractScheduledEventExecutor.getCurrentTimeNanos. Get the current time in nanoseconds by this executor's clock. This is not the same as `System#nanoTime()` for two reasons: We apply a fixed offset to the `nanoTime` Implementations (in particular EmbeddedEventLoop) may use their own time source so they can control time for testing purposes. Annotations @Override

protected long getCurrentTimeNanos()

Overrides io.netty.util.concurrent.AbstractScheduledEventExecutor.getCurrentTimeNanos.

Doc from io.netty.util.concurrent.AbstractScheduledEventExecutor.getCurrentTimeNanos.

Get the current time in nanoseconds by this executor's clock. This is not the same as System#nanoTime() for two reasons:

We apply a fixed offset to the nanoTime
Implementations (in particular EmbeddedEventLoop) may use their own time source so they can control time for testing purposes.

Annotations

@Override

hasPendingNormalTasks	back to summary
pack-priv boolean hasPendingNormalTasks()

inEventLoop back to summary

inEventLoop	back to summary
public boolean inEventLoop() Overrides io.netty.util.concurrent.AbstractEventExecutor.inEventLoop. Implements io.netty.util.concurrent.EventExecutor.inEventLoop. Doc from io.netty.util.concurrent.EventExecutor.inEventLoop. Calls `inEventLoop(Thread)` with `Thread#currentThread()` as argument Annotations @Override

public boolean inEventLoop()

Overrides io.netty.util.concurrent.AbstractEventExecutor.inEventLoop.

Implements io.netty.util.concurrent.EventExecutor.inEventLoop.

Doc from io.netty.util.concurrent.EventExecutor.inEventLoop.

Calls inEventLoop(Thread) with Thread#currentThread() as argument

Annotations

@Override

inEventLoop back to summary

inEventLoop	back to summary
public boolean inEventLoop(Thread thread) Implements io.netty.util.concurrent.EventExecutor.inEventLoop. Doc from io.netty.util.concurrent.EventExecutor.inEventLoop. Return `true` if the given `Thread` is executed in the event loop, `false` otherwise. Annotations @Override

public boolean inEventLoop(Thread thread)

Implements io.netty.util.concurrent.EventExecutor.inEventLoop.

Doc from io.netty.util.concurrent.EventExecutor.inEventLoop.

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

Annotations

@Override

isShutdown back to summary

isShutdown	back to summary
public boolean isShutdown() Implements java.util.concurrent.ExecutorService.isShutdown. Doc from java.util.concurrent.ExecutorService.isShutdown. Returns `true` if this executor has been shut down. Returns:boolean `true` if this executor has been shut down Annotations @Override

public boolean isShutdown()

Implements java.util.concurrent.ExecutorService.isShutdown.

Doc from java.util.concurrent.ExecutorService.isShutdown.

Returns true if this executor has been shut down.

Returns:boolean

true if this executor has been shut down

Annotations

@Override

isShuttingDown back to summary

isShuttingDown	back to summary
public boolean isShuttingDown() Implements io.netty.util.concurrent.EventExecutorGroup.isShuttingDown. Doc from io.netty.util.concurrent.EventExecutorGroup.isShuttingDown. Returns `true` if and only if all `EventExecutor`s managed by this `EventExecutorGroup` are being shut down gracefully or was shut down. Annotations @Override

public boolean isShuttingDown()

Implements io.netty.util.concurrent.EventExecutorGroup.isShuttingDown.

Doc from io.netty.util.concurrent.EventExecutorGroup.isShuttingDown.

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

Annotations

@Override

isTerminated back to summary

isTerminated	back to summary
public boolean isTerminated() Implements java.util.concurrent.ExecutorService.isTerminated. Doc from java.util.concurrent.ExecutorService.isTerminated. Returns `true` if all tasks have completed following shut down. Note that `isTerminated` is never `true` unless either `shutdown` or `shutdownNow` was called first. Returns:boolean `true` if all tasks have completed following shut down Annotations @Override

public boolean isTerminated()

Implements java.util.concurrent.ExecutorService.isTerminated.

Doc from java.util.concurrent.ExecutorService.isTerminated.

Returns true if all tasks have completed following shut down. Note that isTerminated is never true unless either shutdown or shutdownNow was called first.

Returns:boolean

true if all tasks have completed following shut down

Annotations

@Override

next back to summary

next	back to summary
public EventLoop next() Overrides io.netty.util.concurrent.AbstractEventExecutor.next. Implements io.netty.util.concurrent.EventExecutor.next, io.netty.channel.EventLoopGroup.next. Doc from io.netty.channel.EventLoopGroup.next. Return the next `EventLoop` to use Annotations @Override

public EventLoop next()

Overrides io.netty.util.concurrent.AbstractEventExecutor.next.

Implements io.netty.util.concurrent.EventExecutor.next, io.netty.channel.EventLoopGroup.next.

Doc from io.netty.channel.EventLoopGroup.next.

Return the next EventLoop to use

Annotations

@Override

nextScheduledTask	back to summary
pack-priv long nextScheduledTask()

parent back to summary

parent	back to summary
public EventLoopGroup parent() Overrides io.netty.util.concurrent.AbstractEventExecutor.parent. Implements io.netty.channel.EventLoop.parent, io.netty.util.concurrent.EventExecutor.parent. Doc from io.netty.util.concurrent.EventExecutor.parent. Return the `EventExecutorGroup` which is the parent of this `EventExecutor`, Annotations @Override

public EventLoopGroup parent()

Overrides io.netty.util.concurrent.AbstractEventExecutor.parent.

Implements io.netty.channel.EventLoop.parent, io.netty.util.concurrent.EventExecutor.parent.

Doc from io.netty.util.concurrent.EventExecutor.parent.

Return the EventExecutorGroup which is the parent of this EventExecutor,

Annotations

@Override

register	back to summary
public ChannelFuture register(Channel channel) Implements io.netty.channel.EventLoopGroup.register. Doc from io.netty.channel.EventLoopGroup.register. Register a `Channel` with this `EventLoop`. The returned `ChannelFuture` will get notified once the registration was complete. Annotations @Override

public ChannelFuture register(Channel channel)

Implements io.netty.channel.EventLoopGroup.register.

Doc from io.netty.channel.EventLoopGroup.register.

Register a Channel with this EventLoop. The returned ChannelFuture will get notified once the registration was complete.

Annotations

@Override

register	back to summary
public ChannelFuture register(ChannelPromise promise) Implements io.netty.channel.EventLoopGroup.register. Doc from io.netty.channel.EventLoopGroup.register. Register a `Channel` with this `EventLoop` using a `ChannelFuture`. The passed `ChannelFuture` will get notified once the registration was complete and also will get returned. Annotations @Override

public ChannelFuture register(ChannelPromise promise)

Implements io.netty.channel.EventLoopGroup.register.

Doc from io.netty.channel.EventLoopGroup.register.

Register a Channel with this EventLoop using a ChannelFuture. The passed ChannelFuture will get notified once the registration was complete and also will get returned.

Annotations

@Override

register	back to summary
public ChannelFuture register(Channel channel, ChannelPromise promise) Implements io.netty.channel.EventLoopGroup.register. Doc from io.netty.channel.EventLoopGroup.register. Deprecated Register a `Channel` with this `EventLoop`. The passed `ChannelFuture` will get notified once the registration was complete and also will get returned. Annotations @Deprecated @Override

public ChannelFuture register(Channel channel, ChannelPromise promise)

Implements io.netty.channel.EventLoopGroup.register.

Doc from io.netty.channel.EventLoopGroup.register.

Deprecated

Register a Channel with this EventLoop. The passed ChannelFuture will get notified once the registration was complete and also will get returned.

Annotations

@Deprecated
@Override

runScheduledTasks	back to summary
pack-priv long runScheduledTasks()

runTasks	back to summary
pack-priv void runTasks()

shutdown back to summary

shutdown	back to summary
public void shutdown() Implements abstract io.netty.util.concurrent.AbstractEventExecutor.shutdown. Implements io.netty.util.concurrent.EventExecutorGroup.shutdown, java.util.concurrent.ExecutorService.shutdown. Doc from java.util.concurrent.ExecutorService.shutdown. Deprecated Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down. This method does not wait for previously submitted tasks to complete execution. Use `awaitTermination` to do that. Annotations @Override @Deprecated

public void shutdown()

Implements abstract io.netty.util.concurrent.AbstractEventExecutor.shutdown.

Implements io.netty.util.concurrent.EventExecutorGroup.shutdown, java.util.concurrent.ExecutorService.shutdown.

Doc from java.util.concurrent.ExecutorService.shutdown.

Deprecated

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down.

This method does not wait for previously submitted tasks to complete execution. Use awaitTermination to do that.

Annotations

@Override
@Deprecated

shutdownGracefully back to summary

shutdownGracefully	back to summary
public Future<?> shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Implements io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully. Doc from io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully. Signals this executor that the caller wants the executor to be shut down. Once this method is called, `isShuttingDown()` starts to return `true`, and the executor prepares to shut itself down. Unlike `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:long the quiet period as described in the documentation timeout:long the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period unit:TimeUnit the unit of `quietPeriod` and `timeout` Returns:Future<?> the `terminationFuture()` Annotations @Override

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

Implements io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully.

Doc from io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully.

Signals this executor that the caller wants the executor to be shut down. Once this method is called, isShuttingDown() starts to return true, and the executor prepares to shut itself down. Unlike 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:long: the quiet period as described in the documentation
timeout:long: the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period
unit:TimeUnit: the unit of quietPeriod and timeout

Returns:Future<?>

the terminationFuture()

Annotations

@Override

terminationFuture back to summary

terminationFuture	back to summary
public Future<?> terminationFuture() Implements io.netty.util.concurrent.EventExecutorGroup.terminationFuture. Doc from io.netty.util.concurrent.EventExecutorGroup.terminationFuture. Returns the `Future` which is notified when all `EventExecutor`s managed by this `EventExecutorGroup` have been terminated. Annotations @Override

public Future<?> terminationFuture()

Implements io.netty.util.concurrent.EventExecutorGroup.terminationFuture.

Doc from io.netty.util.concurrent.EventExecutorGroup.terminationFuture.

Returns the Future which is notified when all EventExecutors managed by this EventExecutorGroup have been terminated.

Annotations

@Override

unfreezeTime	back to summary
pack-priv void unfreezeTime()

pack-priv final Class EmbeddedEventLoop

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail