io.netty.channel

Class SingleThreadEventLoop

java.lang.Object

java.util.concurrent.AbstractExecutorService

io.netty.util.concurrent.AbstractEventExecutor

io.netty.util.concurrent.AbstractScheduledEventExecutor

io.netty.util.concurrent.SingleThreadEventExecutor

io.netty.channel.SingleThreadEventLoop

All Implemented Interfaces:

EventLoop, EventLoopGroup, EventExecutor, EventExecutorGroup, OrderedEventExecutor, Iterable<EventExecutor>, Executor, ExecutorService, ScheduledExecutorService

Direct Known Subclasses:

DefaultEventLoop, EpollEventLoop, NioEventLoop, ThreadPerChannelEventLoop

public abstract class SingleThreadEventLoop
extends SingleThreadEventExecutor
implements EventLoop

Abstract base class for EventLoops that execute all its submitted tasks in a single thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SingleThreadEventLoop.ChannelsReadOnlyIterator<T extends Channel>

Nested classes/interfaces inherited from class io.netty.util.concurrent.SingleThreadEventExecutor

SingleThreadEventExecutor.NonWakeupRunnable

Nested classes/interfaces inherited from class io.netty.util.concurrent.AbstractEventExecutor

AbstractEventExecutor.LazyRunnable

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_MAX_PENDING_TASKS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SingleThreadEventLoop(EventLoopGroup parent, Executor executor, boolean addTaskWakesUp)
protected	SingleThreadEventLoop(EventLoopGroup parent, Executor executor, boolean addTaskWakesUp, int maxPendingTasks, RejectedExecutionHandler rejectedExecutionHandler)
protected	SingleThreadEventLoop(EventLoopGroup parent, Executor executor, boolean addTaskWakesUp, Queue<Runnable> taskQueue, Queue<Runnable> tailTaskQueue, RejectedExecutionHandler rejectedExecutionHandler)
protected	SingleThreadEventLoop(EventLoopGroup parent, ThreadFactory threadFactory, boolean addTaskWakesUp)
protected	SingleThreadEventLoop(EventLoopGroup parent, ThreadFactory threadFactory, boolean addTaskWakesUp, int maxPendingTasks, RejectedExecutionHandler rejectedExecutionHandler)

Method Summary

Modifier and Type	Method and Description
protected void	afterRunningAllTasks() Invoked before returning from SingleThreadEventExecutor.runAllTasks() and SingleThreadEventExecutor.runAllTasks(long).
void	executeAfterEventLoopIteration(Runnable task) Adds a task to be run once at the end of next (or current) eventloop iteration.
protected boolean	hasTasks()
EventLoop	next() Returns a reference to itself.
EventLoopGroup	parent() Return the EventExecutorGroup which is the parent of this EventExecutor,
int	pendingTasks() Return the number of tasks that are pending for processing.
ChannelFuture	register(Channel channel) Register a Channel with this EventLoop.
ChannelFuture	register(Channel channel, ChannelPromise promise) Deprecated.
ChannelFuture	register(ChannelPromise promise) Register a Channel with this EventLoop using a ChannelFuture.
int	registeredChannels() Returns the number of Channels registered with this EventLoop or -1 if operation is not supported.
Iterator<Channel>	registeredChannelsIterator()

Methods inherited from class io.netty.util.concurrent.SingleThreadEventExecutor

addShutdownHook, addTask, awaitTermination, cleanup, confirmShutdown, deadlineNanos, delayNanos, execute, inEventLoop, interruptThread, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isShuttingDown, isTerminated, lazyExecute, newTaskQueue, newTaskQueue, peekTask, pollTask, pollTaskFrom, reject, reject, removeShutdownHook, removeTask, run, runAllTasks, runAllTasks, runAllTasksFrom, runScheduledAndExecutorTasks, shutdown, shutdownGracefully, takeTask, terminationFuture, threadProperties, updateLastExecutionTime, wakesUpForTask, wakeup

Methods inherited from class io.netty.util.concurrent.AbstractScheduledEventExecutor

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

Methods inherited from class io.netty.util.concurrent.AbstractEventExecutor

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

Methods inherited from class java.lang.Object

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

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

inEventLoop, inEventLoop, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture

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

isShuttingDown, iterator, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay, shutdown, shutdownGracefully, shutdownGracefully, shutdownNow, submit, submit, submit, terminationFuture

Methods inherited from interface java.util.concurrent.ExecutorService

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

Methods inherited from interface java.util.concurrent.Executor

execute

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_MAX_PENDING_TASKS

protected static final int DEFAULT_MAX_PENDING_TASKS

Constructor Detail

SingleThreadEventLoop

protected SingleThreadEventLoop(EventLoopGroup parent,
                                ThreadFactory threadFactory,
                                boolean addTaskWakesUp)

SingleThreadEventLoop

protected SingleThreadEventLoop(EventLoopGroup parent,
                                Executor executor,
                                boolean addTaskWakesUp)

SingleThreadEventLoop

protected SingleThreadEventLoop(EventLoopGroup parent,
                                ThreadFactory threadFactory,
                                boolean addTaskWakesUp,
                                int maxPendingTasks,
                                RejectedExecutionHandler rejectedExecutionHandler)

SingleThreadEventLoop

protected SingleThreadEventLoop(EventLoopGroup parent,
                                Executor executor,
                                boolean addTaskWakesUp,
                                int maxPendingTasks,
                                RejectedExecutionHandler rejectedExecutionHandler)

SingleThreadEventLoop

protected SingleThreadEventLoop(EventLoopGroup parent,
                                Executor executor,
                                boolean addTaskWakesUp,
                                Queue<Runnable> taskQueue,
                                Queue<Runnable> tailTaskQueue,
                                RejectedExecutionHandler rejectedExecutionHandler)

Method Detail

parent

public EventLoopGroup parent()

Description copied from interface: EventExecutor

Return the EventExecutorGroup which is the parent of this EventExecutor,

Specified by:

parent in interface EventLoop

Specified by:

parent in interface EventExecutor

Overrides:

parent in class AbstractEventExecutor

next

public EventLoop next()

Description copied from interface: EventExecutor

Returns a reference to itself.

Specified by:

next in interface EventLoopGroup

Specified by:

next in interface EventExecutor

Specified by:

next in interface EventExecutorGroup

Overrides:

next in class AbstractEventExecutor

register

public ChannelFuture register(Channel channel)

Description copied from interface: EventLoopGroup

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

Specified by:

register in interface EventLoopGroup

register

public ChannelFuture register(ChannelPromise promise)

Description copied from interface: EventLoopGroup

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.

Specified by:

register in interface EventLoopGroup

register

@Deprecated
public ChannelFuture register(Channel channel,
                                          ChannelPromise promise)

Deprecated.

Description copied from interface: EventLoopGroup

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

Specified by:

register in interface EventLoopGroup

executeAfterEventLoopIteration

public final void executeAfterEventLoopIteration(Runnable task)

Adds a task to be run once at the end of next (or current) eventloop iteration.

Parameters:

task - to be added.

afterRunningAllTasks

protected void afterRunningAllTasks()

Description copied from class: SingleThreadEventExecutor

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

Overrides:

afterRunningAllTasks in class SingleThreadEventExecutor

hasTasks

protected boolean hasTasks()

Overrides:

hasTasks in class SingleThreadEventExecutor

See Also:

Collection.isEmpty()

pendingTasks

public int pendingTasks()

Description copied from class: SingleThreadEventExecutor

Return the number of tasks that are pending for processing.

Overrides:

pendingTasks in class SingleThreadEventExecutor

registeredChannels

@UnstableApi
public int registeredChannels()

Returns the number of Channels registered with this EventLoop or -1 if operation is not supported. The returned value is not guaranteed to be exact accurate and should be viewed as a best effort.

registeredChannelsIterator

@UnstableApi
public Iterator<Channel> registeredChannelsIterator()

Returns:

read-only iterator of active Channels registered with this EventLoop. The returned value is not guaranteed to be exact accurate and should be viewed as a best effort. This method is expected to be called from within event loop.

Throws:

UnsupportedOperationException - if operation is not supported by implementation.