io.netty.util.concurrent

类 SingleThreadEventExecutor

java.lang.Object

java.util.concurrent.AbstractExecutorService

io.netty.util.concurrent.AbstractEventExecutor

io.netty.util.concurrent.AbstractScheduledEventExecutor

io.netty.util.concurrent.SingleThreadEventExecutor

所有已实现的接口:

EventExecutor, EventExecutorGroup, OrderedEventExecutor, java.lang.Iterable<EventExecutor>, java.util.concurrent.Executor, java.util.concurrent.ExecutorService, java.util.concurrent.ScheduledExecutorService

直接已知子类:

DefaultEventExecutor, SingleThreadEventLoop

public abstract class SingleThreadEventExecutor
extends AbstractScheduledEventExecutor
implements OrderedEventExecutor

Abstract base class for OrderedEventExecutor's that execute all its submitted tasks in a single thread.

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static interface	SingleThreadEventExecutor.NonWakeupRunnable 已过时。 override wakesUpForTask(java.lang.Runnable) to re-create this behaviour

从类继承的嵌套类/接口 io.netty.util.concurrent.AbstractEventExecutor

AbstractEventExecutor.LazyRunnable

构造器概要

构造器

限定符	构造器和说明
protected	SingleThreadEventExecutor(EventExecutorGroup parent, java.util.concurrent.Executor executor, boolean addTaskWakesUp) Create a new instance
protected	SingleThreadEventExecutor(EventExecutorGroup parent, java.util.concurrent.Executor executor, boolean addTaskWakesUp, int maxPendingTasks, RejectedExecutionHandler rejectedHandler) Create a new instance
protected	SingleThreadEventExecutor(EventExecutorGroup parent, java.util.concurrent.Executor executor, boolean addTaskWakesUp, java.util.Queue<java.lang.Runnable> taskQueue, RejectedExecutionHandler rejectedHandler)
protected	SingleThreadEventExecutor(EventExecutorGroup parent, java.util.concurrent.ThreadFactory threadFactory, boolean addTaskWakesUp) Create a new instance
protected	SingleThreadEventExecutor(EventExecutorGroup parent, java.util.concurrent.ThreadFactory threadFactory, boolean addTaskWakesUp, int maxPendingTasks, RejectedExecutionHandler rejectedHandler) Create a new instance

方法概要

限定符和类型	方法和说明
void	addShutdownHook(java.lang.Runnable task) Add a Runnable which will be executed on shutdown of this instance
protected void	addTask(java.lang.Runnable task) Add a task to the task queue, or throws a RejectedExecutionException if this instance was shutdown before.
protected void	afterRunningAllTasks() Invoked before returning from runAllTasks() and runAllTasks(long).
boolean	awaitTermination(long timeout, java.util.concurrent.TimeUnit unit)
protected void	cleanup() Do nothing, sub-classes may override
protected boolean	confirmShutdown() Confirm that the shutdown if the instance should be done now!
protected long	deadlineNanos() Returns the absolute point in time (relative to AbstractScheduledEventExecutor.getCurrentTimeNanos()) at which the next closest scheduled task should run.
protected long	delayNanos(long currentTimeNanos) Returns the amount of time left until the scheduled task with the closest dead line is executed.
void	execute(java.lang.Runnable task)
protected boolean	hasTasks()
boolean	inEventLoop(java.lang.Thread thread) Return true if the given Thread is executed in the event loop, false otherwise.
protected void	interruptThread() Interrupt the current running Thread.
<T> java.util.List<java.util.concurrent.Future<T>>	invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
<T> java.util.List<java.util.concurrent.Future<T>>	invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks, long timeout, java.util.concurrent.TimeUnit unit)
<T> T	invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
<T> T	invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks, long timeout, java.util.concurrent.TimeUnit unit)
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()
void	lazyExecute(java.lang.Runnable task) Like Executor.execute(Runnable) but does not guarantee the task will be run until either a non-lazy task is executed or the executor is shut down.
protected java.util.Queue<java.lang.Runnable>	newTaskQueue() 已过时。 Please use and override newTaskQueue(int).
protected java.util.Queue<java.lang.Runnable>	newTaskQueue(int maxPendingTasks) Create a new Queue which will holds the tasks to execute.
protected java.lang.Runnable	peekTask()
int	pendingTasks() Return the number of tasks that are pending for processing.
protected java.lang.Runnable	pollTask()
protected static java.lang.Runnable	pollTaskFrom(java.util.Queue<java.lang.Runnable> taskQueue)
protected static void	reject()
protected void	reject(java.lang.Runnable task) Offers the task to the associated RejectedExecutionHandler.
void	removeShutdownHook(java.lang.Runnable task) Remove a previous added Runnable as a shutdown hook
protected boolean	removeTask(java.lang.Runnable task)
protected abstract void	run() Run the tasks in the taskQueue
protected boolean	runAllTasks() Poll all tasks from the task queue and run them via Runnable.run() method.
protected boolean	runAllTasks(long timeoutNanos) Poll all tasks from the task queue and run them via Runnable.run() method.
protected boolean	runAllTasksFrom(java.util.Queue<java.lang.Runnable> taskQueue) Runs all tasks from the passed taskQueue.
protected boolean	runScheduledAndExecutorTasks(int maxDrainAttempts) Execute all expired scheduled tasks and all current tasks in the executor queue until both queues are empty, or maxDrainAttempts has been exceeded.
void	shutdown() 已过时。
Future<?>	shutdownGracefully(long quietPeriod, long timeout, java.util.concurrent.TimeUnit unit) Signals this executor that the caller wants the executor to be shut down.
protected 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.
ThreadProperties	threadProperties() Returns the ThreadProperties of the Thread that powers the SingleThreadEventExecutor.
protected void	updateLastExecutionTime() Updates the internal timestamp that tells when a submitted task was executed most recently.
protected boolean	wakesUpForTask(java.lang.Runnable task) Can be overridden to control which tasks require waking the EventExecutor thread if it is waiting so that they can be run immediately.
protected void	wakeup(boolean inEventLoop)

从类继承的方法 io.netty.util.concurrent.AbstractScheduledEventExecutor

afterScheduledTaskSubmitted, beforeScheduledTaskSubmitted, cancelScheduledTasks, deadlineToDelayNanos, getCurrentTimeNanos, hasScheduledTasks, initialNanoTime, nanoTime, nextScheduledTaskDeadlineNanos, nextScheduledTaskNano, pollScheduledTask, pollScheduledTask, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay, validateScheduled

从类继承的方法 io.netty.util.concurrent.AbstractEventExecutor

inEventLoop, iterator, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, newTaskFor, newTaskFor, next, parent, runTask, safeExecute, shutdownGracefully, shutdownNow, submit, submit, submit

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.util.concurrent.EventExecutor

inEventLoop, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, next, parent

从接口继承的方法 io.netty.util.concurrent.EventExecutorGroup

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

从接口继承的方法 java.lang.Iterable

forEach, spliterator

构造器详细资料

SingleThreadEventExecutor

protected SingleThreadEventExecutor(EventExecutorGroup parent,
                                    java.util.concurrent.ThreadFactory threadFactory,
                                    boolean addTaskWakesUp)

Create a new instance

参数:

parent - the EventExecutorGroup which is the parent of this instance and belongs to it

threadFactory - the ThreadFactory which will be used for the used Thread

addTaskWakesUp - true if and only if invocation of addTask(Runnable) will wake up the executor thread

SingleThreadEventExecutor

protected SingleThreadEventExecutor(EventExecutorGroup parent,
                                    java.util.concurrent.ThreadFactory threadFactory,
                                    boolean addTaskWakesUp,
                                    int maxPendingTasks,
                                    RejectedExecutionHandler rejectedHandler)

Create a new instance

参数:

parent - the EventExecutorGroup which is the parent of this instance and belongs to it

threadFactory - the ThreadFactory which will be used for the used Thread

addTaskWakesUp - true if and only if invocation of addTask(Runnable) will wake up the executor thread

maxPendingTasks - the maximum number of pending tasks before new tasks will be rejected.

rejectedHandler - the RejectedExecutionHandler to use.

SingleThreadEventExecutor

protected SingleThreadEventExecutor(EventExecutorGroup parent,
                                    java.util.concurrent.Executor executor,
                                    boolean addTaskWakesUp)

Create a new instance

参数:

parent - the EventExecutorGroup which is the parent of this instance and belongs to it

executor - the Executor which will be used for executing

addTaskWakesUp - true if and only if invocation of addTask(Runnable) will wake up the executor thread

SingleThreadEventExecutor

protected SingleThreadEventExecutor(EventExecutorGroup parent,
                                    java.util.concurrent.Executor executor,
                                    boolean addTaskWakesUp,
                                    int maxPendingTasks,
                                    RejectedExecutionHandler rejectedHandler)

Create a new instance

参数:

parent - the EventExecutorGroup which is the parent of this instance and belongs to it

executor - the Executor which will be used for executing

addTaskWakesUp - true if and only if invocation of addTask(Runnable) will wake up the executor thread

maxPendingTasks - the maximum number of pending tasks before new tasks will be rejected.

rejectedHandler - the RejectedExecutionHandler to use.

SingleThreadEventExecutor

protected SingleThreadEventExecutor(EventExecutorGroup parent,
                                    java.util.concurrent.Executor executor,
                                    boolean addTaskWakesUp,
                                    java.util.Queue<java.lang.Runnable> taskQueue,
                                    RejectedExecutionHandler rejectedHandler)

方法详细资料

newTaskQueue

@Deprecated
protected java.util.Queue<java.lang.Runnable> newTaskQueue()

已过时。 Please use and override newTaskQueue(int).

newTaskQueue

protected java.util.Queue<java.lang.Runnable> newTaskQueue(int maxPendingTasks)

Create a new Queue which will holds the tasks to execute. This default implementation will return a LinkedBlockingQueue but if your sub-class of SingleThreadEventExecutor will not do any blocking calls on the this Queue it may make sense to @Override this and return some more performant implementation that does not support blocking operations at all.

interruptThread

protected void interruptThread()

Interrupt the current running Thread.

pollTask

protected java.lang.Runnable pollTask()

另请参阅:

Queue.poll()

pollTaskFrom

protected static java.lang.Runnable pollTaskFrom(java.util.Queue<java.lang.Runnable> taskQueue)

takeTask

protected java.lang.Runnable takeTask()

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

Be aware that this method will throw an UnsupportedOperationException if the task queue, which was created via newTaskQueue(), does not implement BlockingQueue.

返回:

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

peekTask

protected java.lang.Runnable peekTask()

另请参阅:

Queue.peek()

hasTasks

protected boolean hasTasks()

另请参阅:

Collection.isEmpty()

pendingTasks

public int pendingTasks()

Return the number of tasks that are pending for processing.

addTask

protected void addTask(java.lang.Runnable task)

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

removeTask

protected boolean removeTask(java.lang.Runnable task)

另请参阅:

Collection.remove(Object)

runAllTasks

protected boolean runAllTasks()

Poll all tasks from the task queue and run them via Runnable.run() method.

返回:

true if and only if at least one task was run

runScheduledAndExecutorTasks

protected final boolean runScheduledAndExecutorTasks(int maxDrainAttempts)

Execute all expired scheduled tasks and all current tasks in the executor queue until both queues are empty, or maxDrainAttempts has been exceeded.

参数:

maxDrainAttempts - The maximum amount of times this method attempts to drain from queues. This is to prevent continuous task execution and scheduling from preventing the EventExecutor thread to make progress and return to the selector mechanism to process inbound I/O events.

返回:

true if at least one task was run.

runAllTasksFrom

protected final boolean runAllTasksFrom(java.util.Queue<java.lang.Runnable> taskQueue)

Runs all tasks from the passed taskQueue.

参数:

taskQueue - To poll and execute all tasks.

返回:

true if at least one task was executed.

runAllTasks

protected boolean runAllTasks(long timeoutNanos)

Poll all tasks from the task queue and run them via Runnable.run() method. This method stops running the tasks in the task queue and returns if it ran longer than timeoutNanos.

afterRunningAllTasks

@UnstableApi
protected void afterRunningAllTasks()

Invoked before returning from runAllTasks() and runAllTasks(long).

delayNanos

protected long delayNanos(long currentTimeNanos)

Returns the amount of time left until the scheduled task with the closest dead line is executed.

deadlineNanos

@UnstableApi
protected long deadlineNanos()

Returns the absolute point in time (relative to AbstractScheduledEventExecutor.getCurrentTimeNanos()) at which the next closest scheduled task should run.

updateLastExecutionTime

protected void updateLastExecutionTime()

Updates the internal timestamp that tells when a submitted task was executed most recently. runAllTasks() and runAllTasks(long) updates this timestamp automatically, and thus there's usually no need to call this method. However, if you take the tasks manually using takeTask() or pollTask(), you have to call this method at the end of task execution loop for accurate quiet period checks.

run

protected abstract void run()

Run the tasks in the taskQueue

cleanup

protected void cleanup()

Do nothing, sub-classes may override

wakeup

protected void wakeup(boolean inEventLoop)

inEventLoop

public boolean inEventLoop(java.lang.Thread thread)

从接口复制的说明: EventExecutor

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

指定者:

inEventLoop 在接口中 EventExecutor

addShutdownHook

public void addShutdownHook(java.lang.Runnable task)

Add a Runnable which will be executed on shutdown of this instance

removeShutdownHook

public void removeShutdownHook(java.lang.Runnable task)

Remove a previous added Runnable as a shutdown hook

shutdownGracefully

public Future<?> shutdownGracefully(long quietPeriod,
                                    long timeout,
                                    java.util.concurrent.TimeUnit unit)

从接口复制的说明: 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.

指定者:

shutdownGracefully 在接口中 EventExecutorGroup

参数:

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

返回:

the EventExecutorGroup.terminationFuture()

terminationFuture

public Future<?> terminationFuture()

从接口复制的说明: EventExecutorGroup

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

指定者:

terminationFuture 在接口中 EventExecutorGroup

shutdown

@Deprecated
public void shutdown()

已过时。

指定者:

shutdown 在接口中 EventExecutorGroup

指定者:

shutdown 在接口中 java.util.concurrent.ExecutorService

指定者:

shutdown 在类中 AbstractEventExecutor

isShuttingDown

public boolean isShuttingDown()

从接口复制的说明: EventExecutorGroup

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

指定者:

isShuttingDown 在接口中 EventExecutorGroup

isShutdown

public boolean isShutdown()

指定者:

isShutdown 在接口中 java.util.concurrent.ExecutorService

isTerminated

public boolean isTerminated()

指定者:

isTerminated 在接口中 java.util.concurrent.ExecutorService

confirmShutdown

protected boolean confirmShutdown()

Confirm that the shutdown if the instance should be done now!

awaitTermination

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

指定者:

awaitTermination 在接口中 java.util.concurrent.ExecutorService

抛出:

java.lang.InterruptedException

execute

public void execute(java.lang.Runnable task)

指定者:

execute 在接口中 java.util.concurrent.Executor

lazyExecute

public void lazyExecute(java.lang.Runnable task)

从类复制的说明: AbstractEventExecutor

Like Executor.execute(Runnable) but does not guarantee the task will be run until either a non-lazy task is executed or the executor is shut down.

The default implementation just delegates to Executor.execute(Runnable).

覆盖:

lazyExecute 在类中 AbstractEventExecutor

invokeAny

public <T> T invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
                throws java.lang.InterruptedException,
                       java.util.concurrent.ExecutionException

指定者:

invokeAny 在接口中 java.util.concurrent.ExecutorService

覆盖:

invokeAny 在类中 java.util.concurrent.AbstractExecutorService

抛出:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

invokeAny

public <T> T invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks,
                       long timeout,
                       java.util.concurrent.TimeUnit unit)
                throws java.lang.InterruptedException,
                       java.util.concurrent.ExecutionException,
                       java.util.concurrent.TimeoutException

指定者:

invokeAny 在接口中 java.util.concurrent.ExecutorService

覆盖:

invokeAny 在类中 java.util.concurrent.AbstractExecutorService

抛出:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

invokeAll

public <T> java.util.List<java.util.concurrent.Future<T>> invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
                                                             throws java.lang.InterruptedException

指定者:

invokeAll 在接口中 java.util.concurrent.ExecutorService

覆盖:

invokeAll 在类中 java.util.concurrent.AbstractExecutorService

抛出:

java.lang.InterruptedException

invokeAll

public <T> java.util.List<java.util.concurrent.Future<T>> invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks,
                                                                    long timeout,
                                                                    java.util.concurrent.TimeUnit unit)
                                                             throws java.lang.InterruptedException

指定者:

invokeAll 在接口中 java.util.concurrent.ExecutorService

覆盖:

invokeAll 在类中 java.util.concurrent.AbstractExecutorService

抛出:

java.lang.InterruptedException

threadProperties

public final ThreadProperties threadProperties()

Returns the ThreadProperties of the Thread that powers the SingleThreadEventExecutor. If the SingleThreadEventExecutor is not started yet, this operation will start it and block until it is fully started.

wakesUpForTask

protected boolean wakesUpForTask(java.lang.Runnable task)

Can be overridden to control which tasks require waking the EventExecutor thread if it is waiting so that they can be run immediately.

reject

protected static void reject()

reject

protected final void reject(java.lang.Runnable task)

Offers the task to the associated RejectedExecutionHandler.

参数:

task - to reject.