io.netty.channel

Class ThreadPerChannelEventLoopGroup

java.lang.Object

io.netty.util.concurrent.AbstractEventExecutorGroup

io.netty.channel.ThreadPerChannelEventLoopGroup

All Implemented Interfaces:

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

Direct Known Subclasses:

OioEventLoopGroup

Deprecated.

this will be remove in the next-major release.

@Deprecated
public class ThreadPerChannelEventLoopGroup
extends AbstractEventExecutorGroup
implements EventLoopGroup

An EventLoopGroup that creates one EventLoop per Channel.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long timeout, TimeUnit unit) Deprecated.
boolean	isShutdown() Deprecated.
boolean	isShuttingDown() Deprecated. Returns true if and only if all EventExecutors managed by this EventExecutorGroup are being shut down gracefully or was shut down.
boolean	isTerminated() Deprecated.
Iterator<EventExecutor>	iterator() Deprecated.
protected EventLoop	newChild(Object... args) Deprecated. Creates a new EventLoop.
EventLoop	next() Deprecated. Return the next EventLoop to use
ChannelFuture	register(Channel channel) Deprecated. Register a Channel with this EventLoop.
ChannelFuture	register(Channel channel, ChannelPromise promise) Deprecated.
ChannelFuture	register(ChannelPromise promise) Deprecated. Register a Channel with this EventLoop using a ChannelFuture.
void	shutdown() Deprecated.
Future<?>	shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Deprecated. Signals this executor that the caller wants the executor to be shut down.
Future<?>	terminationFuture() Deprecated. 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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ThreadPerChannelEventLoopGroup

protected ThreadPerChannelEventLoopGroup()

Deprecated.

Create a new ThreadPerChannelEventLoopGroup with no limit in place.

ThreadPerChannelEventLoopGroup

protected ThreadPerChannelEventLoopGroup(int maxChannels)

Deprecated.

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. on the register(Channel) and register(ChannelPromise) method. Use 0 to use no limit

ThreadPerChannelEventLoopGroup

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

Deprecated.

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 on the register(Channel) and register(ChannelPromise) method. 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)

Deprecated.

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 on the register(Channel) and register(ChannelPromise) method. 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)
                      throws Exception

Deprecated.

Creates a new EventLoop. The default implementation creates a new ThreadPerChannelEventLoop.

Throws:

Exception

iterator

public Iterator<EventExecutor> iterator()

Deprecated.

Specified by:

iterator in interface EventExecutorGroup

Specified by:

iterator in interface Iterable<EventExecutor>

next

public EventLoop next()

Deprecated.

Description copied from interface: EventLoopGroup

Return the next EventLoop to use

Specified by:

next in interface EventLoopGroup

Specified by:

next in interface EventExecutorGroup

shutdownGracefully

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

Deprecated.

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.

Specified by:

shutdownGracefully in interface EventExecutorGroup

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()

Deprecated.

Description copied from interface: EventExecutorGroup

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

Specified by:

terminationFuture in interface EventExecutorGroup

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()

Deprecated.

Description copied from interface: EventExecutorGroup

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

Specified by:

isShuttingDown in interface EventExecutorGroup

isShutdown

public boolean isShutdown()

Deprecated.

Specified by:

isShutdown in interface ExecutorService

isTerminated

public boolean isTerminated()

Deprecated.

Specified by:

isTerminated in interface ExecutorService

awaitTermination

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

Deprecated.

Specified by:

awaitTermination in interface ExecutorService

Throws:

InterruptedException

register

public ChannelFuture register(Channel channel)

Deprecated.

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)

Deprecated.

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