Uses of Interface
io.netty.channel.Channel

Packages that use Channel

Package	Description
io.netty.bootstrap	The helper classes with fluent API which enable an easy implementation of typical client side and server side channel initialization.
io.netty.channel	The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.
io.netty.channel.embedded	A virtual Channel that helps wrapping a series of handlers to unit test the handlers or use them in non-I/O context.
io.netty.channel.group	A channel registry which helps a user maintain the list of open Channels and perform bulk operations on them.
io.netty.channel.local	A virtual transport that enables the communication between the two parties in the same virtual machine.
io.netty.channel.nio	NIO-based channel API implementation - recommended for a large number of connections (>= 1000).
io.netty.channel.oio	Old blocking I/O based channel API implementation - recommended for a small number of connections (< 1000).
io.netty.channel.pool	Implementations and API for Channel pools.
io.netty.channel.socket	Abstract TCP and UDP socket interfaces which extend the core channel API.
io.netty.channel.socket.nio	NIO-based socket channel API implementation - recommended for a large number of connections (>= 1000).
io.netty.channel.socket.oio	Old blocking I/O based socket channel API implementation - recommended for a small number of connections (< 1000).

Uses of Channel in io.netty.bootstrap

Classes in io.netty.bootstrap with type parameters of type Channel

Modifier and Type	Class and Description
class	AbstractBootstrap<B extends AbstractBootstrap<B,C>,C extends Channel> AbstractBootstrap is a helper class that makes it easy to bootstrap a Channel.
class	AbstractBootstrapConfig<B extends AbstractBootstrap<B,C>,C extends Channel> Exposes the configuration of an AbstractBootstrap.
interface	ChannelFactory<T extends Channel> Deprecated. Use ChannelFactory instead.

Methods in io.netty.bootstrap with parameters of type Channel

Modifier and Type	Method and Description
void	ChannelInitializerExtension.postInitializeClientChannel(Channel channel) Called by Bootstrap after the initialization of the given client channel.
void	ChannelInitializerExtension.postInitializeServerChildChannel(Channel channel) Called by ServerBootstrap after the initialization of the given child channel.

Uses of Channel in io.netty.channel

Classes in io.netty.channel with type parameters of type Channel

Modifier and Type	Interface and Description
interface	ChannelFactory<T extends Channel> Creates a new Channel.
class	ChannelInitializer<C extends Channel> A special ChannelInboundHandler which offers an easy way to initialize a Channel once it was registered to its EventLoop.
class	ReflectiveChannelFactory<T extends Channel> A ChannelFactory that instantiates a new Channel by invoking its default constructor reflectively.
protected static class	SingleThreadEventLoop.ChannelsReadOnlyIterator<T extends Channel>

Subinterfaces of Channel in io.netty.channel

Modifier and Type	Interface and Description
interface	ServerChannel A Channel that accepts an incoming connection attempt and creates its child Channels by accepting them.

Classes in io.netty.channel that implement Channel

Modifier and Type	Class and Description
class	AbstractChannel A skeletal Channel implementation.
class	AbstractServerChannel A skeletal server-side Channel implementation.

Fields in io.netty.channel declared as Channel

Modifier and Type	Field and Description
protected Channel	DefaultChannelConfig.channel

Methods in io.netty.channel that return Channel

Modifier and Type	Method and Description
Channel	VoidChannelPromise.channel()
Channel	DefaultChannelPipeline.channel()
Channel	ChannelPromise.channel()
Channel	ChannelPipeline.channel() Returns the Channel that this pipeline is attached to.
Channel	DelegatingChannelPromiseNotifier.channel()
Channel	DefaultChannelProgressivePromise.channel()
Channel	ChannelFuture.channel() Returns a channel where the I/O operation associated with this future takes place.
Channel	DefaultChannelPromise.channel()
Channel	ChannelHandlerContext.channel() Return the Channel which is bound to the ChannelHandlerContext.
Channel	AbstractChannel.flush()
Channel	Channel.flush()
Channel	SingleThreadEventLoop.ChannelsReadOnlyIterator.next()
Channel	AbstractChannel.parent()
Channel	Channel.parent() Returns the parent of this channel.
Channel	AbstractChannel.read()
Channel	Channel.read()

Methods in io.netty.channel that return types with arguments of type Channel

Modifier and Type	Method and Description
Iterator<Channel>	SingleThreadEventLoop.registeredChannelsIterator()

Methods in io.netty.channel with parameters of type Channel

Modifier and Type	Method and Description
int	AbstractChannel.compareTo(Channel o)
ChannelFuture	EventLoopGroup.register(Channel channel) Register a Channel with this EventLoop.
ChannelFuture	SingleThreadEventLoop.register(Channel channel)
ChannelFuture	ThreadPerChannelEventLoopGroup.register(Channel channel) Deprecated.
ChannelFuture	MultithreadEventLoopGroup.register(Channel channel)
ChannelFuture	EventLoopGroup.register(Channel channel, ChannelPromise promise) Deprecated. Use EventLoopGroup.register(ChannelPromise) instead.
ChannelFuture	SingleThreadEventLoop.register(Channel channel, ChannelPromise promise) Deprecated.
ChannelFuture	ThreadPerChannelEventLoopGroup.register(Channel channel, ChannelPromise promise) Deprecated.
ChannelFuture	MultithreadEventLoopGroup.register(Channel channel, ChannelPromise promise) Deprecated.
ChannelFuture	ThreadPerChannelEventLoop.register(Channel channel, ChannelPromise promise) Deprecated.

Constructors in io.netty.channel with parameters of type Channel

Constructor and Description
AbstractChannel(Channel parent) Creates a new instance.
AbstractChannel(Channel parent, ChannelId id) Creates a new instance.
AbstractCoalescingBufferQueue(Channel channel, int initSize) Create a new instance.
CoalescingBufferQueue(Channel channel)
CoalescingBufferQueue(Channel channel, int initSize)
CoalescingBufferQueue(Channel channel, int initSize, boolean updateWritability)
DefaultChannelConfig(Channel channel)
DefaultChannelConfig(Channel channel, RecvByteBufAllocator allocator)
DefaultChannelPipeline(Channel channel)
DefaultChannelProgressivePromise(Channel channel) Creates a new instance.
DefaultChannelProgressivePromise(Channel channel, io.netty.util.concurrent.EventExecutor executor) Creates a new instance.
DefaultChannelPromise(Channel channel) Creates a new instance.
DefaultChannelPromise(Channel channel, io.netty.util.concurrent.EventExecutor executor) Creates a new instance.
PendingWriteQueue(Channel channel)
VoidChannelPromise(Channel channel, boolean fireException) Creates a new instance.

Uses of Channel in io.netty.channel.embedded

Classes in io.netty.channel.embedded that implement Channel

Modifier and Type	Class and Description
class	EmbeddedChannel Base class for Channel implementations that are used in an embedded fashion.

Methods in io.netty.channel.embedded that return Channel

Modifier and Type	Method and Description
Channel	EmbeddedChannel.flush()
Channel	EmbeddedChannel.read()

Constructors in io.netty.channel.embedded with parameters of type Channel

Constructor and Description
EmbeddedChannel(Channel parent, ChannelId channelId, boolean register, boolean hasDisconnect, ChannelHandler... handlers) Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.

Uses of Channel in io.netty.channel.group

Methods in io.netty.channel.group that return Channel

Modifier and Type	Method and Description
Channel	ChannelGroup.find(ChannelId id) Returns the Channel which has the specified ChannelId.
Channel	DefaultChannelGroup.find(ChannelId id)

Methods in io.netty.channel.group that return types with arguments of type Channel

Modifier and Type	Method and Description
Iterator<Map.Entry<Channel,Throwable>>	ChannelGroupException.iterator() Returns a Iterator which contains all the Throwable that was a cause of the failure and the related id of the Channel.
Iterator<Channel>	DefaultChannelGroup.iterator()

Methods in io.netty.channel.group with parameters of type Channel

Modifier and Type	Method and Description
boolean	DefaultChannelGroup.add(Channel channel)
ChannelFuture	ChannelGroupFuture.find(Channel channel) Returns the ChannelFuture of the individual I/O operation which is associated with the specified Channel.
static ChannelMatcher	ChannelMatchers.is(Channel channel) Returns a ChannelMatcher that matches the given Channel.
static ChannelMatcher	ChannelMatchers.isNot(Channel channel) Returns a ChannelMatcher that matches all Channels except the given.
boolean	ChannelMatcher.matches(Channel channel) Returns true if the operation should be also executed on the given Channel.

Method parameters in io.netty.channel.group with type arguments of type Channel

Modifier and Type	Method and Description
static ChannelMatcher	ChannelMatchers.isInstanceOf(Class<? extends Channel> clazz) Returns a ChannelMatcher that matches all Channels that are an instance of sub-type of the given class.
static ChannelMatcher	ChannelMatchers.isNotInstanceOf(Class<? extends Channel> clazz) Returns a ChannelMatcher that matches all Channels that are not an instance of sub-type of the given class.

Constructor parameters in io.netty.channel.group with type arguments of type Channel

Constructor and Description
ChannelGroupException(Collection<Map.Entry<Channel,Throwable>> causes)

Uses of Channel in io.netty.channel.local

Classes in io.netty.channel.local that implement Channel

Modifier and Type	Class and Description
class	LocalChannel A Channel for the local transport.
class	LocalServerChannel A ServerChannel for the local transport which allows in VM communication.

Uses of Channel in io.netty.channel.nio

Classes in io.netty.channel.nio that implement Channel

Modifier and Type	Class and Description
class	AbstractNioByteChannel AbstractNioChannel base class for Channels that operate on bytes.
class	AbstractNioChannel Abstract base class for Channel implementations which use a Selector based approach.
class	AbstractNioMessageChannel AbstractNioChannel base class for Channels that operate on messages.

Methods in io.netty.channel.nio that return types with arguments of type Channel

Modifier and Type	Method and Description
Iterator<Channel>	NioEventLoop.registeredChannelsIterator()

Constructors in io.netty.channel.nio with parameters of type Channel

Constructor and Description
AbstractNioByteChannel(Channel parent, SelectableChannel ch) Create a new instance
AbstractNioChannel(Channel parent, SelectableChannel ch, int readInterestOp) Create a new instance
AbstractNioMessageChannel(Channel parent, SelectableChannel ch, int readInterestOp)

Uses of Channel in io.netty.channel.oio

Classes in io.netty.channel.oio that implement Channel

Modifier and Type	Class and Description
class	AbstractOioByteChannel Deprecated. use NIO / EPOLL / KQUEUE transport.
class	AbstractOioChannel Deprecated. use NIO / EPOLL / KQUEUE transport.
class	AbstractOioMessageChannel Deprecated. use NIO / EPOLL / KQUEUE transport.
class	OioByteStreamChannel Deprecated. use NIO / EPOLL / KQUEUE transport.

Constructors in io.netty.channel.oio with parameters of type Channel

Constructor and Description
AbstractOioByteChannel(Channel parent) Deprecated.
AbstractOioChannel(Channel parent) Deprecated.
AbstractOioMessageChannel(Channel parent) Deprecated.
OioByteStreamChannel(Channel parent) Deprecated. Create a new instance

Uses of Channel in io.netty.channel.pool

Methods in io.netty.channel.pool that return Channel

Modifier and Type	Method and Description
protected Channel	SimpleChannelPool.pollChannel() Poll a Channel out of the internal storage to reuse it.

Methods in io.netty.channel.pool that return types with arguments of type Channel

Modifier and Type	Method and Description
io.netty.util.concurrent.Future<Channel>	SimpleChannelPool.acquire()
io.netty.util.concurrent.Future<Channel>	ChannelPool.acquire() Acquire a Channel from this ChannelPool.
io.netty.util.concurrent.Future<Channel>	SimpleChannelPool.acquire(io.netty.util.concurrent.Promise<Channel> promise)
io.netty.util.concurrent.Future<Channel>	FixedChannelPool.acquire(io.netty.util.concurrent.Promise<Channel> promise)
io.netty.util.concurrent.Future<Channel>	ChannelPool.acquire(io.netty.util.concurrent.Promise<Channel> promise) Acquire a Channel from this ChannelPool.

Methods in io.netty.channel.pool with parameters of type Channel

Modifier and Type	Method and Description
void	AbstractChannelPoolHandler.channelAcquired(Channel ch) NOOP implementation, sub-classes may override this.
void	ChannelPoolHandler.channelAcquired(Channel ch) Called once a Channel was acquired by calling ChannelPool.acquire() or ChannelPool.acquire(Promise).
void	ChannelPoolHandler.channelCreated(Channel ch) Called once a new Channel is created in the ChannelPool.
void	AbstractChannelPoolHandler.channelReleased(Channel ch) NOOP implementation, sub-classes may override this.
void	ChannelPoolHandler.channelReleased(Channel ch) Called once a Channel was released by calling ChannelPool.release(Channel) or ChannelPool.release(Channel, Promise).
io.netty.util.concurrent.Future<Boolean>	ChannelHealthChecker.isHealthy(Channel channel) Check if the given channel is healthy which means it can be used.
protected boolean	SimpleChannelPool.offerChannel(Channel channel) Offer a Channel back to the internal storage.
io.netty.util.concurrent.Future<Void>	SimpleChannelPool.release(Channel channel)
io.netty.util.concurrent.Future<Void>	ChannelPool.release(Channel channel) Release a Channel back to this ChannelPool.
io.netty.util.concurrent.Future<Void>	SimpleChannelPool.release(Channel channel, io.netty.util.concurrent.Promise<Void> promise)
io.netty.util.concurrent.Future<Void>	FixedChannelPool.release(Channel channel, io.netty.util.concurrent.Promise<Void> promise)
io.netty.util.concurrent.Future<Void>	ChannelPool.release(Channel channel, io.netty.util.concurrent.Promise<Void> promise) Release a Channel back to this ChannelPool.

Method parameters in io.netty.channel.pool with type arguments of type Channel

Modifier and Type	Method and Description
io.netty.util.concurrent.Future<Channel>	SimpleChannelPool.acquire(io.netty.util.concurrent.Promise<Channel> promise)
io.netty.util.concurrent.Future<Channel>	FixedChannelPool.acquire(io.netty.util.concurrent.Promise<Channel> promise)
io.netty.util.concurrent.Future<Channel>	ChannelPool.acquire(io.netty.util.concurrent.Promise<Channel> promise) Acquire a Channel from this ChannelPool.

Uses of Channel in io.netty.channel.socket

Subinterfaces of Channel in io.netty.channel.socket

Modifier and Type	Interface and Description
interface	DatagramChannel A UDP/IP Channel.
interface	DuplexChannel A duplex Channel that has two sides that can be shutdown independently.
interface	ServerSocketChannel A TCP/IP ServerChannel which accepts incoming TCP/IP connections.
interface	SocketChannel A TCP/IP socket Channel.

Uses of Channel in io.netty.channel.socket.nio

Classes in io.netty.channel.socket.nio that implement Channel

Modifier and Type	Class and Description
class	NioDatagramChannel An NIO datagram Channel that sends and receives an AddressedEnvelope.
class	NioDomainSocketChannel DuplexChannel which uses NIO selector based implementation to support UNIX Domain Sockets.
class	NioServerDomainSocketChannel A ServerChannel implementation which uses NIO selector based implementation to support UNIX Domain Sockets.
class	NioServerSocketChannel A ServerSocketChannel implementation which uses NIO selector based implementation to accept new connections.
class	NioSocketChannel SocketChannel which uses NIO selector based implementation.

Constructors in io.netty.channel.socket.nio with parameters of type Channel

Constructor and Description
NioDomainSocketChannel(Channel parent, SocketChannel socket) Create a new instance
NioSocketChannel(Channel parent, SocketChannel socket) Create a new instance

Uses of Channel in io.netty.channel.socket.oio

Classes in io.netty.channel.socket.oio that implement Channel

Modifier and Type	Class and Description
class	OioDatagramChannel Deprecated. use NIO / EPOLL / KQUEUE transport.
class	OioServerSocketChannel Deprecated. use NIO / EPOLL / KQUEUE transport.
class	OioSocketChannel Deprecated. use NIO / EPOLL / KQUEUE transport.

Constructors in io.netty.channel.socket.oio with parameters of type Channel

Constructor and Description
OioSocketChannel(Channel parent, Socket socket) Deprecated. Create a new instance from the given Socket