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 virtualChannel
that helps wrapping a series of handlers to unit test the handlers or use them in non-I/O context.io.netty.channel.epoll Optimized transport for linux which uses EPOLL Edge-Triggered Mode for maximal performance.io.netty.channel.group A channel registry which helps a user maintain the list of openChannel
s and perform bulk operations on them.io.netty.channel.kqueue BSD specific transport.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 forChannel
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).io.netty.channel.unix Unix specific transport.io.netty.handler.codec.http.websocketx Encoder, decoder, handshakers and their related message types for Web Socket data frames.io.netty.handler.codec.http2 Handlers for sending and receiving HTTP/2 frames.io.netty.handler.proxy Adds support for client connections via proxy protocols such as SOCKS and HTTP CONNECT tunnelingio.netty.handler.ssl -
-
Uses of Channel in io.netty.bootstrap
Classes in io.netty.bootstrap with type parameters of type Channel Modifier and Type Class Description class
AbstractBootstrap<B extends AbstractBootstrap<B,C>,C extends Channel>
AbstractBootstrap
is a helper class that makes it easy to bootstrap aChannel
.class
AbstractBootstrapConfig<B extends AbstractBootstrap<B,C>,C extends Channel>
Exposes the configuration of anAbstractBootstrap
.interface
ChannelFactory<T extends Channel>
Deprecated.UseChannelFactory
instead. -
Uses of Channel in io.netty.channel
Classes in io.netty.channel with type parameters of type Channel Modifier and Type Interface Description interface
ChannelFactory<T extends Channel>
Creates a newChannel
.class
ChannelInitializer<C extends Channel>
A specialChannelInboundHandler
which offers an easy way to initialize aChannel
once it was registered to itsEventLoop
.class
ReflectiveChannelFactory<T extends Channel>
AChannelFactory
that instantiates a newChannel
by invoking its default constructor reflectively.Subinterfaces of Channel in io.netty.channel Modifier and Type Interface Description interface
ServerChannel
Classes in io.netty.channel that implement Channel Modifier and Type Class Description class
AbstractChannel
A skeletalChannel
implementation.class
AbstractServerChannel
A skeletal server-sideChannel
implementation.Fields in io.netty.channel declared as Channel Modifier and Type Field Description protected Channel
DefaultChannelConfig. channel
Methods in io.netty.channel that return Channel Modifier and Type Method Description Channel
ChannelFuture. channel()
Returns a channel where the I/O operation associated with this future takes place.Channel
ChannelHandlerContext. channel()
Return theChannel
which is bound to theChannelHandlerContext
.Channel
ChannelPipeline. channel()
Returns theChannel
that this pipeline is attached to.Channel
ChannelPromise. channel()
Channel
DefaultChannelPipeline. channel()
Channel
DefaultChannelProgressivePromise. channel()
Channel
DefaultChannelPromise. channel()
Channel
DelegatingChannelPromiseNotifier. channel()
Channel
VoidChannelPromise. channel()
Channel
AbstractChannel. flush()
Channel
Channel. flush()
Channel
AbstractChannel. parent()
Channel
Channel. parent()
Returns the parent of this channel.Channel
AbstractChannel. read()
Channel
Channel. read()
Methods in io.netty.channel with parameters of type Channel Modifier and Type Method Description int
AbstractChannel. compareTo(Channel o)
ChannelFuture
EventLoopGroup. register(Channel channel)
ChannelFuture
EventLoopGroup. register(Channel channel, ChannelPromise promise)
Deprecated.UseEventLoopGroup.register(ChannelPromise)
instead.ChannelFuture
MultithreadEventLoopGroup. register(Channel channel)
ChannelFuture
MultithreadEventLoopGroup. register(Channel channel, ChannelPromise promise)
Deprecated.ChannelFuture
SingleThreadEventLoop. register(Channel channel)
ChannelFuture
SingleThreadEventLoop. register(Channel channel, ChannelPromise promise)
Deprecated.ChannelFuture
ThreadPerChannelEventLoop. register(Channel channel, ChannelPromise promise)
Deprecated.ChannelFuture
ThreadPerChannelEventLoopGroup. register(Channel channel)
Deprecated.ChannelFuture
ThreadPerChannelEventLoopGroup. register(Channel channel, ChannelPromise promise)
Deprecated.Constructors in io.netty.channel with parameters of type Channel Constructor 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, EventExecutor executor)
Creates a new instance.DefaultChannelPromise(Channel channel)
Creates a new instance.DefaultChannelPromise(Channel channel, 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 Description class
EmbeddedChannel
Base class forChannel
implementations that are used in an embedded fashion.Constructors in io.netty.channel.embedded with parameters of type Channel Constructor 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.epoll
Classes in io.netty.channel.epoll that implement Channel Modifier and Type Class Description class
AbstractEpollServerChannel
class
AbstractEpollStreamChannel
class
EpollDatagramChannel
DatagramChannel
implementation that uses linux EPOLL Edge-Triggered Mode for maximal performance.class
EpollDomainDatagramChannel
class
EpollDomainSocketChannel
class
EpollServerDomainSocketChannel
class
EpollServerSocketChannel
ServerSocketChannel
implementation that uses linux EPOLL Edge-Triggered Mode for maximal performance.class
EpollSocketChannel
SocketChannel
implementation that uses linux EPOLL Edge-Triggered Mode for maximal performance.Methods in io.netty.channel.epoll that return Channel Modifier and Type Method Description protected Channel
EpollServerDomainSocketChannel. newChildChannel(int fd, byte[] addr, int offset, int len)
protected Channel
EpollServerSocketChannel. newChildChannel(int fd, byte[] address, int offset, int len)
Constructors in io.netty.channel.epoll with parameters of type Channel Constructor Description AbstractEpollStreamChannel(Channel parent, int fd)
EpollDomainSocketChannel(Channel parent, LinuxSocket fd)
-
Uses of Channel in io.netty.channel.group
Methods in io.netty.channel.group that return Channel Modifier and Type Method Description Channel
ChannelGroup. find(ChannelId id)
Channel
DefaultChannelGroup. find(ChannelId id)
Methods in io.netty.channel.group that return types with arguments of type Channel Modifier and Type Method Description Iterator<Map.Entry<Channel,Throwable>>
ChannelGroupException. iterator()
Iterator<Channel>
DefaultChannelGroup. iterator()
Methods in io.netty.channel.group with parameters of type Channel Modifier and Type Method Description boolean
DefaultChannelGroup. add(Channel channel)
ChannelFuture
ChannelGroupFuture. find(Channel channel)
Returns theChannelFuture
of the individual I/O operation which is associated with the specifiedChannel
.static ChannelMatcher
ChannelMatchers. is(Channel channel)
Returns aChannelMatcher
that matches the givenChannel
.static ChannelMatcher
ChannelMatchers. isNot(Channel channel)
Returns aChannelMatcher
that matches allChannel
s except the given.boolean
ChannelMatcher. matches(Channel channel)
Returnstrue
if the operation should be also executed on the givenChannel
.Method parameters in io.netty.channel.group with type arguments of type Channel Modifier and Type Method Description static ChannelMatcher
ChannelMatchers. isInstanceOf(Class<? extends Channel> clazz)
Returns aChannelMatcher
that matches allChannel
s that are an instance of sub-type of the given class.static ChannelMatcher
ChannelMatchers. isNotInstanceOf(Class<? extends Channel> clazz)
Returns aChannelMatcher
that matches allChannel
s 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 Description ChannelGroupException(Collection<Map.Entry<Channel,Throwable>> causes)
-
Uses of Channel in io.netty.channel.kqueue
Classes in io.netty.channel.kqueue that implement Channel Modifier and Type Class Description class
AbstractKQueueServerChannel
class
AbstractKQueueStreamChannel
class
KQueueDatagramChannel
class
KQueueDomainDatagramChannel
class
KQueueDomainSocketChannel
class
KQueueServerDomainSocketChannel
class
KQueueServerSocketChannel
class
KQueueSocketChannel
Methods in io.netty.channel.kqueue that return Channel Modifier and Type Method Description protected Channel
KQueueServerDomainSocketChannel. newChildChannel(int fd, byte[] addr, int offset, int len)
protected Channel
KQueueServerSocketChannel. newChildChannel(int fd, byte[] address, int offset, int len)
-
Uses of Channel in io.netty.channel.local
Classes in io.netty.channel.local that implement Channel Modifier and Type Class Description class
LocalChannel
AChannel
for the local transport.class
LocalServerChannel
AServerChannel
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 Description class
AbstractNioByteChannel
AbstractNioChannel
base class forChannel
s that operate on bytes.class
AbstractNioChannel
Abstract base class forChannel
implementations which use a Selector based approach.class
AbstractNioMessageChannel
AbstractNioChannel
base class forChannel
s that operate on messages.Constructors in io.netty.channel.nio with parameters of type Channel Constructor Description AbstractNioByteChannel(Channel parent, SelectableChannel ch)
Create a new instanceAbstractNioChannel(Channel parent, SelectableChannel ch, int readInterestOp)
Create a new instanceAbstractNioMessageChannel(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 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 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 Description protected Channel
SimpleChannelPool. pollChannel()
Poll aChannel
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 Description Future<Channel>
ChannelPool. acquire()
Acquire aChannel
from thisChannelPool
.Future<Channel>
ChannelPool. acquire(Promise<Channel> promise)
Acquire aChannel
from thisChannelPool
.Future<Channel>
FixedChannelPool. acquire(Promise<Channel> promise)
Future<Channel>
SimpleChannelPool. acquire()
Future<Channel>
SimpleChannelPool. acquire(Promise<Channel> promise)
Methods in io.netty.channel.pool with parameters of type Channel Modifier and Type Method Description void
AbstractChannelPoolHandler. channelAcquired(Channel ch)
NOOP implementation, sub-classes may override this.void
ChannelPoolHandler. channelAcquired(Channel ch)
Called once aChannel
was acquired by callingChannelPool.acquire()
orChannelPool.acquire(Promise)
.void
ChannelPoolHandler. channelCreated(Channel ch)
Called once a newChannel
is created in theChannelPool
.void
AbstractChannelPoolHandler. channelReleased(Channel ch)
NOOP implementation, sub-classes may override this.void
ChannelPoolHandler. channelReleased(Channel ch)
Called once aChannel
was released by callingChannelPool.release(Channel)
orChannelPool.release(Channel, Promise)
.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 aChannel
back to the internal storage.Future<Void>
ChannelPool. release(Channel channel)
Release aChannel
back to thisChannelPool
.Future<Void>
ChannelPool. release(Channel channel, Promise<Void> promise)
Release aChannel
back to thisChannelPool
.Future<Void>
FixedChannelPool. release(Channel channel, Promise<Void> promise)
Future<Void>
SimpleChannelPool. release(Channel channel)
Future<Void>
SimpleChannelPool. release(Channel channel, Promise<Void> promise)
Method parameters in io.netty.channel.pool with type arguments of type Channel Modifier and Type Method Description Future<Channel>
ChannelPool. acquire(Promise<Channel> promise)
Acquire aChannel
from thisChannelPool
.Future<Channel>
FixedChannelPool. acquire(Promise<Channel> promise)
Future<Channel>
SimpleChannelPool. acquire(Promise<Channel> promise)
-
Uses of Channel in io.netty.channel.socket
Subinterfaces of Channel in io.netty.channel.socket Modifier and Type Interface Description interface
DatagramChannel
A UDP/IPChannel
.interface
DuplexChannel
A duplexChannel
that has two sides that can be shutdown independently.interface
ServerSocketChannel
A TCP/IPServerChannel
which accepts incoming TCP/IP connections.interface
SocketChannel
A TCP/IP socketChannel
. -
Uses of Channel in io.netty.channel.socket.nio
Classes in io.netty.channel.socket.nio that implement Channel Modifier and Type Class Description class
NioDatagramChannel
An NIO datagramChannel
that sends and receives anAddressedEnvelope
.class
NioServerSocketChannel
AServerSocketChannel
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 Description 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 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 Description OioSocketChannel(Channel parent, Socket socket)
Deprecated.Create a new instance from the givenSocket
-
Uses of Channel in io.netty.channel.unix
Subinterfaces of Channel in io.netty.channel.unix Modifier and Type Interface Description interface
DomainDatagramChannel
AUnixChannel
that supports communication via UNIX domain datagram sockets.interface
DomainSocketChannel
AUnixChannel
that supports communication via Unix Domain Socket.interface
ServerDomainSocketChannel
interface
UnixChannel
Channel
that expose operations that are only present onUNIX
like systems. -
Uses of Channel in io.netty.handler.codec.http.websocketx
Methods in io.netty.handler.codec.http.websocketx with parameters of type Channel Modifier and Type Method Description ChannelFuture
WebSocketClientHandshaker. close(Channel channel, CloseWebSocketFrame frame)
Performs the closing handshake.ChannelFuture
WebSocketClientHandshaker. close(Channel channel, CloseWebSocketFrame frame, ChannelPromise promise)
Performs the closing handshake When called from within aChannelHandler
you most likely want to useWebSocketClientHandshaker.close(ChannelHandlerContext, CloseWebSocketFrame, ChannelPromise)
.ChannelFuture
WebSocketServerHandshaker. close(Channel channel, CloseWebSocketFrame frame)
Performs the closing handshake.ChannelFuture
WebSocketServerHandshaker. close(Channel channel, CloseWebSocketFrame frame, ChannelPromise promise)
Performs the closing handshake.ChannelFuture
WebSocketServerHandshaker00. close(Channel channel, CloseWebSocketFrame frame, ChannelPromise promise)
Echo back the closing framevoid
WebSocketClientHandshaker. finishHandshake(Channel channel, FullHttpResponse response)
Validates and finishes the opening handshake initiated byWebSocketClientHandshaker.handshake(io.netty.channel.Channel)
}.ChannelFuture
WebSocketClientHandshaker. handshake(Channel channel)
Begins the opening handshakeChannelFuture
WebSocketClientHandshaker. handshake(Channel channel, ChannelPromise promise)
Begins the opening handshakeChannelFuture
WebSocketServerHandshaker. handshake(Channel channel, FullHttpRequest req)
Performs the opening handshake.ChannelFuture
WebSocketServerHandshaker. handshake(Channel channel, FullHttpRequest req, HttpHeaders responseHeaders, ChannelPromise promise)
Performs the opening handshake When call this method you MUST NOT retain theFullHttpRequest
which is passed in.ChannelFuture
WebSocketServerHandshaker. handshake(Channel channel, HttpRequest req)
Performs the opening handshake.ChannelFuture
WebSocketServerHandshaker. handshake(Channel channel, HttpRequest req, HttpHeaders responseHeaders, ChannelPromise promise)
Performs the opening handshake When call this method you MUST NOT retain theHttpRequest
which is passed in.ChannelFuture
WebSocketClientHandshaker. processHandshake(Channel channel, HttpResponse response)
Process the opening handshake initiated byWebSocketClientHandshaker.handshake(io.netty.channel.Channel)
}.ChannelFuture
WebSocketClientHandshaker. processHandshake(Channel channel, HttpResponse response, ChannelPromise promise)
Process the opening handshake initiated byWebSocketClientHandshaker.handshake(io.netty.channel.Channel)
}.static ChannelFuture
WebSocketServerHandshakerFactory. sendUnsupportedVersionResponse(Channel channel)
Return that we need cannot not support the web socket versionstatic ChannelFuture
WebSocketServerHandshakerFactory. sendUnsupportedVersionResponse(Channel channel, ChannelPromise promise)
Return that we need cannot not support the web socket versionstatic void
WebSocketServerHandshakerFactory. sendUnsupportedWebSocketVersionResponse(Channel channel)
-
Uses of Channel in io.netty.handler.codec.http2
Subinterfaces of Channel in io.netty.handler.codec.http2 Modifier and Type Interface Description interface
Http2StreamChannel
Constructors in io.netty.handler.codec.http2 with parameters of type Channel Constructor Description Http2StreamChannelBootstrap(Channel channel)
-
Uses of Channel in io.netty.handler.proxy
Methods in io.netty.handler.proxy that return types with arguments of type Channel Modifier and Type Method Description Future<Channel>
ProxyHandler. connectFuture()
Returns aFuture
that is notified when the connection to the destination has been established or the connection attempt has failed. -
Uses of Channel in io.netty.handler.ssl
Methods in io.netty.handler.ssl that return types with arguments of type Channel Modifier and Type Method Description Future<Channel>
SslHandler. handshakeFuture()
Returns aFuture
that will get notified once the current TLS handshake completes.Future<Channel>
SslHandler. renegotiate()
Performs TLS renegotiation.Future<Channel>
SslHandler. renegotiate(Promise<Channel> promise)
Performs TLS renegotiation.Future<Channel>
SslHandler. sslCloseFuture()
Method parameters in io.netty.handler.ssl with type arguments of type Channel Modifier and Type Method Description Future<Channel>
SslHandler. renegotiate(Promise<Channel> promise)
Performs TLS renegotiation.
-