Package io.netty.channel

Class SingleThreadIoEventLoop

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

io.netty.channel.SingleThreadIoEventLoop

All Implemented Interfaces:

EventLoop, EventLoopGroup, IoEventLoop, IoEventLoopGroup, EventExecutor, EventExecutorGroup, OrderedEventExecutor, ThreadAwareExecutor, java.lang.Iterable<EventExecutor>, java.util.concurrent.Executor, java.util.concurrent.ExecutorService, java.util.concurrent.ScheduledExecutorService

Direct Known Subclasses:

EpollEventLoop, NioEventLoop

public class SingleThreadIoEventLoop
extends SingleThreadEventLoop
implements IoEventLoop

IoEventLoop implementation that execute all its submitted tasks in a single thread using the provided IoHandler.

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.SingleThreadEventLoop

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 inherited from class io.netty.channel.SingleThreadEventLoop

DEFAULT_MAX_PENDING_TASKS

Constructor Summary

Constructors

Modifier	Constructor	Description
	SingleThreadIoEventLoop(IoEventLoopGroup parent, java.util.concurrent.Executor executor, IoHandlerFactory ioHandlerFactory)	Creates a new instance
	SingleThreadIoEventLoop(IoEventLoopGroup parent, java.util.concurrent.Executor executor, IoHandlerFactory ioHandlerFactory, int maxPendingTasks, RejectedExecutionHandler rejectedExecutionHandler, long maxTaskProcessingQuantumMs)	Creates a new instance
protected	SingleThreadIoEventLoop(IoEventLoopGroup parent, java.util.concurrent.Executor executor, IoHandlerFactory ioHandlerFactory, java.util.Queue<java.lang.Runnable> taskQueue, java.util.Queue<java.lang.Runnable> tailTaskQueue, RejectedExecutionHandler rejectedExecutionHandler)	Creates a new instance
	SingleThreadIoEventLoop(IoEventLoopGroup parent, java.util.concurrent.ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory)	Creates a new instance
	SingleThreadIoEventLoop(IoEventLoopGroup parent, java.util.concurrent.ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory, int maxPendingTasks, RejectedExecutionHandler rejectedExecutionHandler, long maxTaskProcessingQuantumMs)	Creates a new instance

Method Summary

Modifier and Type	Method	Description
protected boolean	canSuspend(int state)	Returns true if this SingleThreadEventExecutor can be suspended at the moment, false otherwise.
protected void	cleanup()	Do nothing, sub-classes may override
protected int	getNumOfRegisteredChannels()	Returns the number of registered channels for auto-scaling related decisions.
protected IoHandler	ioHandler()
boolean	isCompatible(java.lang.Class<? extends IoHandle> handleType)	Returns true if the given type is compatible with this IoEventLoopGroup and so can be registered to the contained IoEventLoops, false otherwise.
boolean	isIoType(java.lang.Class<? extends IoHandler> handlerType)	Returns true if the given IoHandler type is used by this IoEventLoopGroup, false otherwise.
protected java.util.Queue<java.lang.Runnable>	newTaskQueue(int maxPendingTasks)	Create a new Queue which will holds the tasks to execute.
protected static java.util.Queue<java.lang.Runnable>	newTaskQueue0(int maxPendingTasks)
IoEventLoop	next()	Returns one of the EventExecutors managed by this EventExecutorGroup.
Future<IoRegistration>	register(IoHandle handle)	Register the IoHandle to the EventLoop for I/O processing.
protected void	run()	Run the tasks in the SingleThreadEventExecutor.taskQueue
protected int	runIo()	Called when IO will be processed for all the IoHandles on this SingleThreadIoEventLoop.
protected void	wakeup(boolean inEventLoop)

Methods inherited from class io.netty.channel.SingleThreadEventLoop

afterRunningAllTasks, executeAfterEventLoopIteration, hasTasks, parent, pendingTasks, register, register, register, registeredChannels, registeredChannelsIterator

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

addShutdownHook, addTask, awaitTermination, canSuspend, confirmShutdown, deadlineNanos, delayNanos, execute, getAndIncrementBusyCycles, getAndIncrementIdleCycles, getAndResetAccumulatedActiveTimeNanos, getLastActivityTimeNanos, inEventLoop, interruptThread, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isShuttingDown, isSuspended, isSuspensionSupported, isTerminated, lazyExecute, newTaskQueue, peekTask, pollTask, pollTaskFrom, reject, reject, removeShutdownHook, removeTask, reportActiveIoTime, resetBusyCycles, resetIdleCycles, runAllTasks, runAllTasks, runAllTasksFrom, runScheduledAndExecutorTasks, shutdown, shutdownGracefully, takeTask, terminationFuture, threadProperties, trySuspend, updateLastExecutionTime, wakesUpForTask

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

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

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

iterator, 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, isExecutorThread, isSuspended, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, trySuspend

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

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

Methods inherited from interface io.netty.channel.EventLoop

parent

Methods inherited from interface io.netty.channel.EventLoopGroup

register

Methods inherited from interface java.util.concurrent.Executor

execute

Methods inherited from interface java.util.concurrent.ExecutorService

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

Methods inherited from interface io.netty.channel.IoEventLoopGroup

register, register

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SingleThreadIoEventLoop

public SingleThreadIoEventLoop(IoEventLoopGroup parent,
                               java.util.concurrent.ThreadFactory threadFactory,
                               IoHandlerFactory ioHandlerFactory)

Creates a new instance

Parameters:

parent - the parent that holds this IoEventLoop.

threadFactory - the ThreadFactory that is used to create the underlying Thread.

ioHandlerFactory - the IoHandlerFactory that should be used to obtain IoHandler to handle IO.

SingleThreadIoEventLoop

public SingleThreadIoEventLoop(IoEventLoopGroup parent,
                               java.util.concurrent.Executor executor,
                               IoHandlerFactory ioHandlerFactory)

Creates a new instance

Parameters:

parent - the parent that holds this IoEventLoop.

executor - the Executor that is used for dispatching the work.

ioHandlerFactory - the IoHandlerFactory that should be used to obtain IoHandler to handle IO.

SingleThreadIoEventLoop

public SingleThreadIoEventLoop(IoEventLoopGroup parent,
                               java.util.concurrent.ThreadFactory threadFactory,
                               IoHandlerFactory ioHandlerFactory,
                               int maxPendingTasks,
                               RejectedExecutionHandler rejectedExecutionHandler,
                               long maxTaskProcessingQuantumMs)

Creates a new instance

Parameters:

parent - the parent that holds this IoEventLoop.

threadFactory - the ThreadFactory that is used to create the underlying Thread.

ioHandlerFactory - the IoHandlerFactory that should be used to obtain IoHandler to handle IO.

maxPendingTasks - the maximum pending tasks that are allowed before RejectedExecutionHandler.rejected(Runnable, SingleThreadEventExecutor) is called to handle it.

rejectedExecutionHandler - the RejectedExecutionHandler that handles when more tasks are added then allowed per maxPendingTasks.

maxTaskProcessingQuantumMs - the maximum number of milliseconds that will be spent to run tasks before trying to run IO again.

SingleThreadIoEventLoop

public SingleThreadIoEventLoop(IoEventLoopGroup parent,
                               java.util.concurrent.Executor executor,
                               IoHandlerFactory ioHandlerFactory,
                               int maxPendingTasks,
                               RejectedExecutionHandler rejectedExecutionHandler,
                               long maxTaskProcessingQuantumMs)

Creates a new instance

Parameters:

parent - the parent that holds this IoEventLoop.

ioHandlerFactory - the IoHandlerFactory that should be used to obtain IoHandler to handle IO.

maxPendingTasks - the maximum pending tasks that are allowed before RejectedExecutionHandler.rejected(Runnable, SingleThreadEventExecutor) is called to handle it.

rejectedExecutionHandler - the RejectedExecutionHandler that handles when more tasks are added then allowed per maxPendingTasks.

maxTaskProcessingQuantumMs - the maximum number of milliseconds that will be spent to run tasks before trying to run IO again.

SingleThreadIoEventLoop

protected SingleThreadIoEventLoop(IoEventLoopGroup parent,
                                  java.util.concurrent.Executor executor,
                                  IoHandlerFactory ioHandlerFactory,
                                  java.util.Queue<java.lang.Runnable> taskQueue,
                                  java.util.Queue<java.lang.Runnable> tailTaskQueue,
                                  RejectedExecutionHandler rejectedExecutionHandler)

Creates a new instance

Parameters:

parent - the parent that holds this IoEventLoop.

executor - the Executor that is used for dispatching the work.

ioHandlerFactory - the IoHandlerFactory that should be used to obtain IoHandler to handle IO.

taskQueue - the Queue used for storing pending tasks.

tailTaskQueue - the Queue used for storing tail pending tasks.

rejectedExecutionHandler - the RejectedExecutionHandler that handles when more tasks are added then allowed.

Method Detail

run

protected void run()

Description copied from class: SingleThreadEventExecutor

Run the tasks in the SingleThreadEventExecutor.taskQueue

Specified by:

run in class SingleThreadEventExecutor

ioHandler

protected final IoHandler ioHandler()

canSuspend

protected boolean canSuspend(int state)

Description copied from class: SingleThreadEventExecutor

Returns true if this SingleThreadEventExecutor can be suspended at the moment, false otherwise. Subclasses might override this method to add extra checks.

Overrides:

canSuspend in class SingleThreadEventExecutor

Parameters:

state - the current internal state of the SingleThreadEventExecutor.

Returns:

if suspension is possible at the moment.

runIo

protected int runIo()

Called when IO will be processed for all the IoHandles on this SingleThreadIoEventLoop. This method returns the number of IoHandles for which IO was processed. This method must be called from the EventLoop thread.

next

public IoEventLoop next()

Description copied from interface: EventExecutorGroup

Returns one of the EventExecutors managed by this EventExecutorGroup.

Specified by:

next in interface EventExecutorGroup

Specified by:

next in interface EventLoopGroup

Specified by:

next in interface IoEventLoop

Specified by:

next in interface IoEventLoopGroup

Overrides:

next in class SingleThreadEventLoop

register

public final Future<IoRegistration> register(IoHandle handle)

Description copied from interface: IoEventLoop

Register the IoHandle to the EventLoop for I/O processing.

Specified by:

register in interface IoEventLoop

Specified by:

register in interface IoEventLoopGroup

Parameters:

handle - the IoHandle to register.

Returns:

the Future that is notified once the operations completes.

getNumOfRegisteredChannels

protected int getNumOfRegisteredChannels()

Description copied from class: SingleThreadEventExecutor

Returns the number of registered channels for auto-scaling related decisions. This is intended to be used by MultithreadEventExecutorGroup for dynamic scaling.

Overrides:

getNumOfRegisteredChannels in class SingleThreadEventExecutor

Returns:

The number of registered channels, or -1 if not applicable.

wakeup

protected final void wakeup(boolean inEventLoop)

Overrides:

wakeup in class SingleThreadEventExecutor

cleanup

protected final void cleanup()

Description copied from class: SingleThreadEventExecutor

Do nothing, sub-classes may override

Overrides:

cleanup in class SingleThreadEventExecutor

isCompatible

public boolean isCompatible(java.lang.Class<? extends IoHandle> handleType)

Description copied from interface: IoEventLoopGroup

Returns true if the given type is compatible with this IoEventLoopGroup and so can be registered to the contained IoEventLoops, false otherwise.

Specified by:

isCompatible in interface IoEventLoop

Specified by:

isCompatible in interface IoEventLoopGroup

Parameters:

handleType - the type of the IoHandle.

Returns:

if compatible of not.

isIoType

public boolean isIoType(java.lang.Class<? extends IoHandler> handlerType)

Description copied from interface: IoEventLoopGroup

Returns true if the given IoHandler type is used by this IoEventLoopGroup, false otherwise.

Specified by:

isIoType in interface IoEventLoop

Specified by:

isIoType in interface IoEventLoopGroup

Parameters:

handlerType - the type of the IoHandler.

Returns:

if used or not.

newTaskQueue

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

Description copied from class: SingleThreadEventExecutor

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.

Overrides:

newTaskQueue in class SingleThreadEventExecutor

newTaskQueue0

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