io.netty.channel

Class ThreadPerChannelEventLoopGroup

java.lang.Object

io.netty.util.concurrent.AbstractEventExecutorGroup

io.netty.channel.AbstractEventLoopGroup

io.netty.channel.ThreadPerChannelEventLoopGroup

All Implemented Interfaces:

EventLoopGroup, EventExecutorGroup, Executor, ExecutorService, ScheduledExecutorService

Direct Known Subclasses:

OioEventLoopGroup

public class ThreadPerChannelEventLoopGroup
extends AbstractEventLoopGroup

An EventLoopGroup that creates one EventLoop per Channel.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ThreadPerChannelEventLoopGroup() Create a new ThreadPerChannelEventLoopGroup with no limit in place.
protected	ThreadPerChannelEventLoopGroup(int maxChannels) Create a new ThreadPerChannelEventLoopGroup.
protected	ThreadPerChannelEventLoopGroup(int maxChannels, Executor executor, Object... args) Create a new ThreadPerChannelEventLoopGroup.
protected	ThreadPerChannelEventLoopGroup(int maxChannels, ThreadFactory threadFactory, Object... args) Create a new ThreadPerChannelEventLoopGroup.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	awaitTermination(long timeout, TimeUnit unit)
<E extends EventExecutor> Set<E>	children() Returns the unmodifiable set of EventExecutors managed by this EventExecutorGroup.
boolean	isShutdown()
boolean	isShuttingDown() Returns true if and only if all EventExecutors managed by this EventExecutorGroup are being shut down gracefuclly or was shut down.
boolean	isTerminated()
protected EventLoop	newChild(Object... args) Creates a new EventLoop.
EventLoop	next() Returns one of the EventExecutors managed by this EventExecutorGroup.
void	shutdown() Deprecated.
Future<?>	shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Signals this executor that the caller wants the executor to be shut down.
Future<?>	terminationFuture() Returns the Future which is notified when all EventExecutors managed by this EventExecutorGroup have been terminated.

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

execute, invokeAll, invokeAll, invokeAny, invokeAny, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay, 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.EventExecutorGroup

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

Methods inherited from interface java.util.concurrent.ExecutorService

invokeAll, invokeAll, invokeAny, invokeAny

Methods inherited from interface java.util.concurrent.Executor

execute

Constructor Detail

ThreadPerChannelEventLoopGroup

protected ThreadPerChannelEventLoopGroup()

Create a new ThreadPerChannelEventLoopGroup with no limit in place.

ThreadPerChannelEventLoopGroup

protected ThreadPerChannelEventLoopGroup(int maxChannels)

Create a new ThreadPerChannelEventLoopGroup.

Parameters:

maxChannels - the maximum number of channels to handle with this instance. Once you try to register a new Channel and the maximum is exceed it will throw an ChannelException. Use 0 to use no limit

ThreadPerChannelEventLoopGroup

protected ThreadPerChannelEventLoopGroup(int maxChannels,
                              ThreadFactory threadFactory,
                              Object... args)

Create a new ThreadPerChannelEventLoopGroup.

Parameters:

maxChannels - the maximum number of channels to handle with this instance. Once you try to register a new Channel and the maximum is exceed it will throw an ChannelException. Use 0 to use no limit

threadFactory - the ThreadFactory used to create new Thread instances that handle the registered Channels

args - arguments which will passed to each newChild(Object...) call.

ThreadPerChannelEventLoopGroup

protected ThreadPerChannelEventLoopGroup(int maxChannels,
                              Executor executor,
                              Object... args)

Create a new ThreadPerChannelEventLoopGroup.

Parameters:

maxChannels - the maximum number of channels to handle with this instance. Once you try to register a new Channel and the maximum is exceed it will throw an ChannelException. Use 0 to use no limit

executor - the Executor used to create new Thread instances that handle the registered Channels

args - arguments which will passed to each newChild(Object...) call.

Method Detail

newChild

protected EventLoop newChild(Object... args)

Creates a new EventLoop.

children

public <E extends EventExecutor> Set<E> children()

Description copied from interface: EventExecutorGroup

Returns the unmodifiable set of EventExecutors managed by this EventExecutorGroup.

next

public EventLoop next()

Description copied from interface: EventExecutorGroup

Returns one of the EventExecutors managed by this EventExecutorGroup.

Specified by:

next in interface EventLoopGroup

Specified by:

next in interface EventExecutorGroup

Specified by:

next in class AbstractEventLoopGroup

shutdownGracefully

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

Description copied from interface: 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.

Parameters:

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

Returns:

the EventExecutorGroup.terminationFuture()

terminationFuture

public Future<?> terminationFuture()

Description copied from interface: EventExecutorGroup

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

shutdown

@Deprecated
public void shutdown()

Deprecated.

Specified by:

shutdown in interface EventExecutorGroup

Specified by:

shutdown in interface ExecutorService

Specified by:

shutdown in class AbstractEventExecutorGroup

isShuttingDown

public boolean isShuttingDown()

Description copied from interface: EventExecutorGroup

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

isShutdown

public boolean isShutdown()

isTerminated

public boolean isTerminated()

awaitTermination

public boolean awaitTermination(long timeout,
                       TimeUnit unit)
                         throws InterruptedException

Throws:

InterruptedException