接口 io.netty.channel.Channel
的使用

使用Channel的程序包

程序包	说明
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.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 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.rxtx	A serial and parallel port communication transport based on RXTX.
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.channel.udt	UDT Transport.
io.netty.channel.udt.nio	UDT Transport for NIO Channels.
io.netty.channel.unix	Unix specific transport.
io.netty.example.proxy
io.netty.example.socksproxy
io.netty.handler.codec.http.websocketx	Encoder, decoder, handshakers and their related message types for Web Socket data frames.
io.netty.handler.ssl	SSL · TLS implementation based on SSLEngine

io.netty.bootstrap中Channel的使用

类型参数类型为Channel的io.netty.bootstrap中的类

限定符和类型	类和说明
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().

io.netty.channel中Channel的使用

类型参数类型为Channel的io.netty.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.

io.netty.channel中Channel的子接口

限定符和类型	接口和说明
interface	ServerChannel A Channel that accepts an incoming connection attempt and creates its child Channels by accepting them.

实现Channel的io.netty.channel中的类

限定符和类型	类和说明
class	AbstractChannel A skeletal Channel implementation.
class	AbstractServerChannel A skeletal server-side Channel implementation.

声明为Channel的io.netty.channel中的字段

限定符和类型	字段和说明
protected Channel	DefaultChannelConfig.channel

返回Channel的io.netty.channel中的方法

限定符和类型	方法和说明
Channel	DefaultChannelPromise.channel()
Channel	DefaultChannelProgressivePromise.channel()
Channel	DefaultChannelPipeline.channel()
Channel	ChannelPromise.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	Channel.flush() Request to flush all pending messages.
Channel	AbstractChannel.flush()
Channel	Channel.parent() Returns the parent of this channel.
Channel	AbstractChannel.parent()
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.
Channel	AbstractChannel.read()

参数类型为Channel的io.netty.channel中的方法

限定符和类型	方法和说明
int	AbstractChannel.compareTo(Channel o)
ChannelFuture	ThreadPerChannelEventLoopGroup.register(Channel channel)
ChannelFuture	SingleThreadEventLoop.register(Channel channel)
ChannelFuture	MultithreadEventLoopGroup.register(Channel channel)
ChannelFuture	EventLoopGroup.register(Channel channel) Register a Channel with this EventLoop.
ChannelFuture	ThreadPerChannelEventLoopGroup.register(Channel channel, ChannelPromise promise)
ChannelFuture	ThreadPerChannelEventLoop.register(Channel channel, ChannelPromise promise)
ChannelFuture	SingleThreadEventLoop.register(Channel channel, ChannelPromise promise)
ChannelFuture	MultithreadEventLoopGroup.register(Channel channel, ChannelPromise promise)
ChannelFuture	EventLoopGroup.register(Channel channel, ChannelPromise promise) Register a Channel with this EventLoop.

参数类型为Channel的io.netty.channel中的构造器

构造器和说明
AbstractChannel(Channel parent) Creates a new instance.
DefaultChannelConfig(Channel channel)
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.

io.netty.channel.embedded中Channel的使用

实现Channel的io.netty.channel.embedded中的类

限定符和类型	类和说明
class	EmbeddedChannel Base class for Channel implementations that are used in an embedded fashion.

io.netty.channel.epoll中Channel的使用

实现Channel的io.netty.channel.epoll中的类

限定符和类型	类和说明
class	AbstractEpollServerChannel
class	AbstractEpollStreamChannel
class	EpollDatagramChannel DatagramChannel implementation that uses linux EPOLL Edge-Triggered Mode for maximal performance.
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.

返回Channel的io.netty.channel.epoll中的方法

限定符和类型	方法和说明
protected Channel	EpollServerSocketChannel.newChildChannel(int fd, byte[] address, int offset, int len)
protected Channel	EpollServerDomainSocketChannel.newChildChannel(int fd, byte[] addr, int offset, int len)

参数类型为Channel的io.netty.channel.epoll中的构造器

构造器和说明
AbstractEpollStreamChannel(Channel parent, int fd) 已过时。 Use AbstractEpollStreamChannel.AbstractEpollStreamChannel(Channel, Socket).
AbstractEpollStreamChannel(Channel parent, Socket fd)
EpollDomainSocketChannel(Channel parent, FileDescriptor fd) 已过时。 Use EpollDomainSocketChannel.EpollDomainSocketChannel(Channel, Socket).
EpollDomainSocketChannel(Channel parent, Socket fd)

io.netty.channel.group中Channel的使用

返回变量类型为Channel的类型的io.netty.channel.group中的方法

限定符和类型	方法和说明
java.util.Iterator<Channel>	DefaultChannelGroup.iterator()
java.util.Iterator<java.util.Map.Entry<Channel,java.lang.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.

参数类型为Channel的io.netty.channel.group中的方法

限定符和类型	方法和说明
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.

类型变量类型为Channel的io.netty.channel.group中的方法参数

限定符和类型	方法和说明
static ChannelMatcher	ChannelMatchers.isInstanceOf(java.lang.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(java.lang.Class<? extends Channel> clazz) Returns a ChannelMatcher that matches all Channels that are not an instance of sub-type of the given class.

类型变量类型为Channel的io.netty.channel.group中的构造器参数

构造器和说明
ChannelGroupException(java.util.Collection<java.util.Map.Entry<Channel,java.lang.Throwable>> causes)

io.netty.channel.local中Channel的使用

实现Channel的io.netty.channel.local中的类

限定符和类型	类和说明
class	LocalChannel A Channel for the local transport.
class	LocalServerChannel A ServerChannel for the local transport which allows in VM communication.

io.netty.channel.nio中Channel的使用

实现Channel的io.netty.channel.nio中的类

限定符和类型	类和说明
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.

参数类型为Channel的io.netty.channel.nio中的构造器

构造器和说明
AbstractNioByteChannel(Channel parent, java.nio.channels.SelectableChannel ch) Create a new instance
AbstractNioChannel(Channel parent, java.nio.channels.SelectableChannel ch, int readInterestOp) Create a new instance
AbstractNioMessageChannel(Channel parent, java.nio.channels.SelectableChannel ch, int readInterestOp)

io.netty.channel.oio中Channel的使用

实现Channel的io.netty.channel.oio中的类

限定符和类型	类和说明
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.

参数类型为Channel的io.netty.channel.oio中的构造器

构造器和说明
AbstractOioByteChannel(Channel parent)
AbstractOioChannel(Channel parent)
AbstractOioMessageChannel(Channel parent)
OioByteStreamChannel(Channel parent) Create a new instance

io.netty.channel.pool中Channel的使用

返回Channel的io.netty.channel.pool中的方法

限定符和类型	方法和说明
protected Channel	SimpleChannelPool.pollChannel() Poll a Channel out of the internal storage to reuse it.

返回变量类型为Channel的类型的io.netty.channel.pool中的方法

限定符和类型	方法和说明
Future<Channel>	SimpleChannelPool.acquire()
Future<Channel>	ChannelPool.acquire() Acquire a Channel from this ChannelPool.
Future<Channel>	SimpleChannelPool.acquire(Promise<Channel> promise)
Future<Channel>	FixedChannelPool.acquire(Promise<Channel> promise)
Future<Channel>	ChannelPool.acquire(Promise<Channel> promise) Acquire a Channel from this ChannelPool.

参数类型为Channel的io.netty.channel.pool中的方法

限定符和类型	方法和说明
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<java.lang.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<java.lang.Void>	SimpleChannelPool.release(Channel channel)
Future<java.lang.Void>	ChannelPool.release(Channel channel) Release a Channel back to this ChannelPool.
Future<java.lang.Void>	SimpleChannelPool.release(Channel channel, Promise<java.lang.Void> promise)
Future<java.lang.Void>	FixedChannelPool.release(Channel channel, Promise<java.lang.Void> promise)
Future<java.lang.Void>	ChannelPool.release(Channel channel, Promise<java.lang.Void> promise) Release a Channel back to this ChannelPool.

类型变量类型为Channel的io.netty.channel.pool中的方法参数

限定符和类型	方法和说明
Future<Channel>	SimpleChannelPool.acquire(Promise<Channel> promise)
Future<Channel>	FixedChannelPool.acquire(Promise<Channel> promise)
Future<Channel>	ChannelPool.acquire(Promise<Channel> promise) Acquire a Channel from this ChannelPool.

io.netty.channel.rxtx中Channel的使用

实现Channel的io.netty.channel.rxtx中的类

限定符和类型	类和说明
class	RxtxChannel 已过时。 this transport will be removed in the next major version.

io.netty.channel.sctp中Channel的使用

io.netty.channel.sctp中Channel的子接口

限定符和类型	接口和说明
interface	SctpChannel A SCTP/IP Channel interface for single SCTP association.
interface	SctpServerChannel A SCTP/IP ServerChannel which accepts incoming SCTP/IP associations.

io.netty.channel.sctp.nio中Channel的使用

实现Channel的io.netty.channel.sctp.nio中的类

限定符和类型	类和说明
class	NioSctpChannel SctpChannel implementation which use non-blocking mode and allows to read / write SctpMessages to the underlying SctpChannel.
class	NioSctpServerChannel SctpServerChannel implementation which use non-blocking mode to accept new connections and create the NioSctpChannel for them.

参数类型为Channel的io.netty.channel.sctp.nio中的构造器

构造器和说明
NioSctpChannel(Channel parent, com.sun.nio.sctp.SctpChannel sctpChannel) Create a new instance

io.netty.channel.sctp.oio中Channel的使用

实现Channel的io.netty.channel.sctp.oio中的类

限定符和类型	类和说明
class	OioSctpChannel SctpChannel implementation which use blocking mode and allows to read / write SctpMessages to the underlying SctpChannel.
class	OioSctpServerChannel SctpServerChannel implementation which use blocking mode to accept new connections and create the OioSctpChannel for them.

参数类型为Channel的io.netty.channel.sctp.oio中的构造器

构造器和说明
OioSctpChannel(Channel parent, com.sun.nio.sctp.SctpChannel ch) Create a new instance from the given SctpChannel.

io.netty.channel.socket中Channel的使用

io.netty.channel.socket中Channel的子接口

限定符和类型	接口和说明
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.

io.netty.channel.socket.nio中Channel的使用

实现Channel的io.netty.channel.socket.nio中的类

限定符和类型	类和说明
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.

参数类型为Channel的io.netty.channel.socket.nio中的构造器

构造器和说明
NioSocketChannel(Channel parent, java.nio.channels.SocketChannel socket) Create a new instance

io.netty.channel.socket.oio中Channel的使用

实现Channel的io.netty.channel.socket.oio中的类

限定符和类型	类和说明
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

参数类型为Channel的io.netty.channel.socket.oio中的构造器

构造器和说明
OioSocketChannel(Channel parent, java.net.Socket socket) Create a new instance from the given Socket

io.netty.channel.udt中Channel的使用

io.netty.channel.udt中Channel的子接口

限定符和类型	接口和说明
interface	UdtChannel 已过时。 The UDT transport is no longer maintained and will be removed.
interface	UdtServerChannel 已过时。 The UDT transport is no longer maintained and will be removed.

io.netty.channel.udt.nio中Channel的使用

实现Channel的io.netty.channel.udt.nio中的类

限定符和类型	类和说明
class	NioUdtAcceptorChannel 已过时。 The UDT transport is no longer maintained and will be removed.
class	NioUdtByteAcceptorChannel 已过时。 The UDT transport is no longer maintained and will be removed.
class	NioUdtByteConnectorChannel 已过时。 The UDT transport is no longer maintained and will be removed.
class	NioUdtByteRendezvousChannel 已过时。 The UDT transport is no longer maintained and will be removed.
class	NioUdtMessageAcceptorChannel 已过时。 The UDT transport is no longer maintained and will be removed.
class	NioUdtMessageConnectorChannel 已过时。 The UDT transport is no longer maintained and will be removed.
class	NioUdtMessageRendezvousChannel 已过时。 The UDT transport is no longer maintained and will be removed.

参数类型为Channel的io.netty.channel.udt.nio中的方法

限定符和类型	方法和说明
static ChannelUDT	NioUdtProvider.channelUDT(Channel channel) 已过时。 Expose underlying ChannelUDT for debugging and monitoring.
static SocketUDT	NioUdtProvider.socketUDT(Channel channel) 已过时。 Expose underlying SocketUDT for debugging and monitoring.

参数类型为Channel的io.netty.channel.udt.nio中的构造器

构造器和说明
NioUdtByteConnectorChannel(Channel parent, SocketChannelUDT channelUDT) 已过时。
NioUdtMessageConnectorChannel(Channel parent, SocketChannelUDT channelUDT) 已过时。

io.netty.channel.unix中Channel的使用

io.netty.channel.unix中Channel的子接口

限定符和类型	接口和说明
interface	DomainSocketChannel A UnixChannel that supports communication via Unix Domain Socket.
interface	ServerDomainSocketChannel ServerChannel that accepts DomainSocketChannel's via Unix Domain Socket.
interface	UnixChannel Channel that expose operations that are only present on UNIX like systems.

io.netty.example.proxy中Channel的使用

参数类型为Channel的io.netty.example.proxy中的构造器

构造器和说明
HexDumpProxyBackendHandler(Channel inboundChannel)

io.netty.example.socksproxy中Channel的使用

参数类型为Channel的io.netty.example.socksproxy中的方法

限定符和类型	方法和说明
static void	SocksServerUtils.closeOnFlush(Channel ch) Closes the specified channel after all queued write requests are flushed.

参数类型为Channel的io.netty.example.socksproxy中的构造器

构造器和说明
RelayHandler(Channel relayChannel)

类型变量类型为Channel的io.netty.example.socksproxy中的构造器参数

构造器和说明
DirectClientHandler(Promise<Channel> promise)

io.netty.handler.codec.http.websocketx中Channel的使用

参数类型为Channel的io.netty.handler.codec.http.websocketx中的方法

限定符和类型	方法和说明
ChannelFuture	WebSocketServerHandshaker.close(Channel channel, CloseWebSocketFrame frame) Performs the closing handshake
ChannelFuture	WebSocketClientHandshaker.close(Channel channel, CloseWebSocketFrame frame) Performs the closing handshake
ChannelFuture	WebSocketServerHandshaker00.close(Channel channel, CloseWebSocketFrame frame, ChannelPromise promise) Echo back the closing frame
ChannelFuture	WebSocketServerHandshaker.close(Channel channel, CloseWebSocketFrame frame, ChannelPromise promise) Performs the closing handshake
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) 已过时。 use WebSocketServerHandshakerFactory.sendUnsupportedVersionResponse(Channel)

io.netty.handler.ssl中Channel的使用

返回变量类型为Channel的类型的io.netty.handler.ssl中的方法

限定符和类型	方法和说明
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() Return the Future that will get notified if the inbound of the SSLEngine is closed.

类型变量类型为Channel的io.netty.handler.ssl中的方法参数

限定符和类型	方法和说明
Future<Channel>	SslHandler.renegotiate(Promise<Channel> promise) Performs TLS renegotiation.