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
Channel s 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.sctp |
Abstract SCTP socket interfaces which extend the core channel API.
|
io.netty.channel.sctp.nio |
NIO-based SCTP Channel
API implementation - recommended for a large number of connections (>= 1000).
|
io.netty.channel.sctp.oio |
Old blocking I/O based SCTP channel API implementation - recommended for
a small number of connections (< 1000).
|
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.handler.codec.http.websocketx |
Encoder, decoder, handshakers and their related message types for
Web Socket data frames.
|
io.netty.handler.ssl |
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 . |
interface |
ChannelFactory<T extends Channel>
Factory that creates a new
Channel on AbstractBootstrap.bind() , Bootstrap.connect() , and
AbstractBootstrap.bind() . |
Modifier and Type | Class and Description |
---|---|
class |
ChannelInitializer<C extends Channel>
A special
ChannelInboundHandler which offers an easy way to initialize a Channel once it was
registered to its EventLoop . |
Modifier and Type | Interface and Description |
---|---|
interface |
ServerChannel
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractChannel
A skeletal
Channel implementation. |
class |
AbstractServerChannel
A skeletal server-side
Channel implementation. |
Modifier and Type | Field and Description |
---|---|
protected Channel |
DefaultChannelConfig.channel |
Modifier and Type | Method and Description |
---|---|
Channel |
DefaultChannelProgressivePromise.channel() |
Channel |
ChannelPipeline.channel()
Returns the
Channel that this pipeline is attached to. |
Channel |
ChannelHandlerContext.channel()
Return the
Channel which is bound to the ChannelHandlerContext . |
Channel |
ChannelFuture.channel()
Returns a channel where the I/O operation associated with this
future takes place.
|
Channel |
DefaultChannelPromise.channel() |
Channel |
ChannelPromise.channel() |
Channel |
AbstractChannel.flush() |
Channel |
Channel.flush()
Request to flush all pending messages.
|
Channel |
AbstractChannel.parent() |
Channel |
Channel.parent()
Returns the parent of this channel.
|
Channel |
AbstractChannel.read() |
Channel |
Channel.read()
Request to Read data from the
Channel into the first inbound buffer, triggers an
ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was
read, and triggers a
channelReadComplete event so the
handler can decide to continue reading. |
Modifier and Type | Method and Description |
---|---|
int |
AbstractChannel.compareTo(Channel o) |
ChannelFuture |
SingleThreadEventLoop.register(Channel channel) |
ChannelFuture |
MultithreadEventLoopGroup.register(Channel channel) |
ChannelFuture |
ThreadPerChannelEventLoopGroup.register(Channel channel) |
ChannelFuture |
EventLoopGroup.register(Channel channel)
|
ChannelFuture |
SingleThreadEventLoop.register(Channel channel,
ChannelPromise promise) |
ChannelFuture |
MultithreadEventLoopGroup.register(Channel channel,
ChannelPromise promise) |
ChannelFuture |
ThreadPerChannelEventLoop.register(Channel channel,
ChannelPromise promise) |
ChannelFuture |
ThreadPerChannelEventLoopGroup.register(Channel channel,
ChannelPromise promise) |
ChannelFuture |
EventLoopGroup.register(Channel channel,
ChannelPromise promise)
|
Constructor and Description |
---|
AbstractChannel(Channel parent)
Creates a new instance.
|
DefaultChannelConfig(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.
|
Modifier and Type | Class and Description |
---|---|
class |
EmbeddedChannel
Base class for
Channel implementations that are used in an embedded fashion. |
Modifier and Type | Method and Description |
---|---|
Iterator<Map.Entry<Channel,Throwable>> |
ChannelGroupException.iterator()
|
Iterator<Channel> |
DefaultChannelGroup.iterator() |
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 Channel s except the given. |
boolean |
ChannelMatcher.matches(Channel channel)
Returns
true if the operation should be also executed on the given Channel . |
Modifier and Type | Method and Description |
---|---|
static ChannelMatcher |
ChannelMatchers.isInstanceOf(Class<? extends Channel> clazz)
Returns a
ChannelMatcher that matches all Channel s 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 Channel s that are not an
instance of sub-type of the given class. |
Constructor and Description |
---|
ChannelGroupException(Collection<Map.Entry<Channel,Throwable>> causes) |
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. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractNioByteChannel
AbstractNioChannel base class for Channel s that operate on bytes. |
class |
AbstractNioChannel
Abstract base class for
Channel implementations which use a Selector based approach. |
class |
AbstractNioMessageChannel
AbstractNioChannel base class for Channel s that operate on messages. |
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) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractOioByteChannel
Abstract base class for OIO which reads and writes bytes from/to a Socket
|
class |
AbstractOioChannel
Abstract base class for
Channel implementations that use Old-Blocking-IO |
class |
AbstractOioMessageChannel
Abstract base class for OIO which reads and writes objects from/to a Socket
|
class |
OioByteStreamChannel
Abstract base class for OIO Channels that are based on streams.
|
Constructor and Description |
---|
AbstractOioByteChannel(Channel parent) |
AbstractOioChannel(Channel parent) |
AbstractOioMessageChannel(Channel parent) |
OioByteStreamChannel(Channel parent)
Create a new instance
|
Modifier and Type | Method and Description |
---|---|
protected Channel |
SimpleChannelPool.pollChannel()
Poll a
Channel out of the internal storage to reuse it. |
Modifier and Type | Method and Description |
---|---|
Future<Channel> |
ChannelPool.acquire()
Acquire a
Channel from this ChannelPool . |
Future<Channel> |
SimpleChannelPool.acquire() |
Future<Channel> |
FixedChannelPool.acquire(Promise<Channel> promise) |
Future<Channel> |
ChannelPool.acquire(Promise<Channel> promise)
Acquire a
Channel from this ChannelPool . |
Future<Channel> |
SimpleChannelPool.acquire(Promise<Channel> promise) |
Modifier and Type | Method and Description |
---|---|
void |
ChannelPoolHandler.channelAcquired(Channel ch)
Called once a
Channel was acquired by calling ChannelPool.acquire() or
ChannelPool.acquire(Promise) . |
void |
AbstractChannelPoolHandler.channelAcquired(Channel ch)
NOOP implementation, sub-classes may override this.
|
void |
ChannelPoolHandler.channelCreated(Channel ch)
Called once a new
Channel is created in the ChannelPool . |
void |
ChannelPoolHandler.channelReleased(Channel ch)
Called once a
Channel was released by calling ChannelPool.release(Channel) or
ChannelPool.release(Channel, Promise) . |
void |
AbstractChannelPoolHandler.channelReleased(Channel ch)
NOOP implementation, sub-classes may override this.
|
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. |
Future<Void> |
ChannelPool.release(Channel channel)
Release a
Channel back to this ChannelPool . |
Future<Void> |
SimpleChannelPool.release(Channel channel) |
Future<Void> |
FixedChannelPool.release(Channel channel,
Promise<Void> promise) |
Future<Void> |
ChannelPool.release(Channel channel,
Promise<Void> promise)
Release a
Channel back to this ChannelPool . |
Future<Void> |
SimpleChannelPool.release(Channel channel,
Promise<Void> promise) |
Modifier and Type | Method and Description |
---|---|
Future<Channel> |
FixedChannelPool.acquire(Promise<Channel> promise) |
Future<Channel> |
ChannelPool.acquire(Promise<Channel> promise)
Acquire a
Channel from this ChannelPool . |
Future<Channel> |
SimpleChannelPool.acquire(Promise<Channel> promise) |
Modifier and Type | Interface and Description |
---|---|
interface |
SctpChannel
A SCTP/IP
Channel interface for single SCTP association. |
interface |
SctpServerChannel
A SCTP/IP
ServerChannel which accepts incoming SCTP/IP associations. |
Modifier and Type | Class and Description |
---|---|
class |
NioSctpChannel
SctpChannel implementation which use non-blocking mode and allows to read /
write SctpMessage s to the underlying SctpChannel . |
class |
NioSctpServerChannel
SctpServerChannel implementation which use non-blocking mode to accept new
connections and create the NioSctpChannel for them. |
Constructor and Description |
---|
NioSctpChannel(Channel parent,
SctpChannel sctpChannel)
Create a new instance
|
Modifier and Type | Class and Description |
---|---|
class |
OioSctpChannel
SctpChannel implementation which use blocking mode and allows to read / write
SctpMessage s to the underlying SctpChannel . |
class |
OioSctpServerChannel
SctpServerChannel implementation which use blocking mode to accept new
connections and create the OioSctpChannel for them. |
Constructor and Description |
---|
OioSctpChannel(Channel parent,
SctpChannel ch)
Create a new instance from the given
SctpChannel . |
Modifier and Type | Interface and Description |
---|---|
interface |
DatagramChannel
A UDP/IP
Channel }. |
interface |
ServerSocketChannel
A TCP/IP
ServerChannel which accepts incoming TCP/IP connections. |
interface |
SocketChannel
A TCP/IP socket
Channel . |
Modifier and Type | Class and Description |
---|---|
class |
NioDatagramChannel
An NIO datagram
Channel that sends and receives an
AddressedEnvelope . |
class |
NioServerSocketChannel
A
ServerSocketChannel implementation which uses
NIO selector based implementation to accept new connections. |
class |
NioSocketChannel
SocketChannel which uses NIO selector based implementation. |
Constructor and Description |
---|
NioSocketChannel(Channel parent,
SocketChannel socket)
Create a new instance
|
Modifier and Type | Class and Description |
---|---|
class |
OioDatagramChannel
An OIO datagram
Channel that sends and receives an
AddressedEnvelope . |
class |
OioServerSocketChannel
ServerSocketChannel which accepts new connections and create the OioSocketChannel 's for them. |
class |
OioSocketChannel
A
SocketChannel which is using Old-Blocking-IO |
Constructor and Description |
---|
OioSocketChannel(Channel parent,
Socket socket)
Create a new instance from the given
Socket |
Modifier and Type | Method and Description |
---|---|
ChannelFuture |
WebSocketServerHandshaker.close(Channel channel,
CloseWebSocketFrame frame)
Performs the closing handshake
|
ChannelFuture |
WebSocketClientHandshaker.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 frame
|
ChannelFuture |
WebSocketClientHandshaker.close(Channel channel,
CloseWebSocketFrame frame,
ChannelPromise promise)
Performs the closing handshake
|
void |
WebSocketClientHandshaker.finishHandshake(Channel channel,
FullHttpResponse response)
Validates and finishes the opening handshake initiated by
WebSocketClientHandshaker.handshake(io.netty.channel.Channel) }. |
ChannelFuture |
WebSocketClientHandshaker.handshake(Channel channel)
Begins the opening handshake
|
ChannelFuture |
WebSocketClientHandshaker.handshake(Channel channel,
ChannelPromise promise)
Begins the opening handshake
|
ChannelFuture |
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 the
FullHttpRequest 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 the
HttpRequest which is passed in. |
ChannelFuture |
WebSocketClientHandshaker.processHandshake(Channel channel,
HttpResponse response)
Process the opening handshake initiated by
WebSocketClientHandshaker.handshake(io.netty.channel.Channel) }. |
ChannelFuture |
WebSocketClientHandshaker.processHandshake(Channel channel,
HttpResponse response,
ChannelPromise promise)
Process the opening handshake initiated by
WebSocketClientHandshaker.handshake(io.netty.channel.Channel) }. |
static ChannelFuture |
WebSocketServerHandshakerFactory.sendUnsupportedVersionResponse(Channel channel)
Return that we need cannot not support the web socket version
|
static ChannelFuture |
WebSocketServerHandshakerFactory.sendUnsupportedVersionResponse(Channel channel,
ChannelPromise promise)
Return that we need cannot not support the web socket version
|
static void |
WebSocketServerHandshakerFactory.sendUnsupportedWebSocketVersionResponse(Channel channel)
|
Modifier and Type | Method and Description |
---|---|
Future<Channel> |
SslHandler.handshakeFuture()
Returns a
Future 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()
|
Modifier and Type | Method and Description |
---|---|
Future<Channel> |
SslHandler.renegotiate(Promise<Channel> promise)
Performs TLS renegotiation.
|
Copyright © 2008-2016 The Netty Project. All Rights Reserved.