Uses of Interface
io.netty5.channel.Channel

Packages that use Channel

Package	Description
io.netty5.bootstrap	The helper classes with fluent API which enable an easy implementation of typical client side and server side channel initialization.
io.netty5.channel	The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.
io.netty5.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.netty5.channel.epoll	Optimized transport for linux which uses EPOLL Edge-Triggered Mode for maximal performance.
io.netty5.channel.group	A channel registry which helps a user maintain the list of open Channels and perform bulk operations on them.
io.netty5.channel.internal	Internal utilities for channel implementations.
io.netty5.channel.kqueue	BSD specific transport.
io.netty5.channel.local	A virtual transport that enables the communication between the two parties in the same virtual machine.
io.netty5.channel.nio	NIO-based channel API implementation - recommended for a large number of connections (>= 1000).
io.netty5.channel.socket	Abstract TCP and UDP socket interfaces which extend the core channel API.
io.netty5.channel.socket.nio	NIO-based socket channel API implementation - recommended for a large number of connections (>= 1000).
io.netty5.channel.unix	Unix specific transport.
io.netty5.handler.codec.http.websocketx	Encoder, decoder, handshakers and their related message types for Web Socket data frames.
io.netty5.handler.codec.http2	Handlers for sending and receiving HTTP/2 frames.
io.netty5.handler.ssl	SSL · TLS implementation based on SSLEngine

Uses of Channel in io.netty5.bootstrap

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

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

Methods in io.netty5.bootstrap that return Channel

Modifier and Type	Method	Description
Channel	AbstractBootstrap.createUnregistered()	Create a new unregistered channel.

Methods in io.netty5.bootstrap that return types with arguments of type Channel

Modifier and Type	Method	Description
Future<Channel>	AbstractBootstrap.bind()	Create a new Channel and bind it.
Future<Channel>	AbstractBootstrap.bind(int inetPort)	Create a new Channel and bind it.
Future<Channel>	AbstractBootstrap.bind(String inetHost, int inetPort)	Create a new Channel and bind it.
Future<Channel>	AbstractBootstrap.bind(InetAddress inetHost, int inetPort)	Create a new Channel and bind it.
Future<Channel>	AbstractBootstrap.bind(SocketAddress localAddress)	Create a new Channel and bind it.
ChannelFactory<? extends Channel>	BootstrapConfig.channelFactory()
Future<Channel>	Bootstrap.connect()	Connect a Channel to the remote peer.
Future<Channel>	Bootstrap.connect(String inetHost, int inetPort)	Connect a Channel to the remote peer.
Future<Channel>	Bootstrap.connect(InetAddress inetHost, int inetPort)	Connect a Channel to the remote peer.
Future<Channel>	Bootstrap.connect(SocketAddress remoteAddress)	Connect a Channel to the remote peer.
Future<Channel>	Bootstrap.connect(SocketAddress remoteAddress, SocketAddress localAddress)	Connect a Channel to the remote peer.
Future<Channel>	AbstractBootstrap.register()	Create a new Channel and register it with an EventLoop.

Method parameters in io.netty5.bootstrap with type arguments of type Channel

Modifier and Type	Method	Description
Bootstrap	Bootstrap.channel(Class<? extends Channel> channelClass)	The Class which is used to create Channel instances from.
Bootstrap	Bootstrap.channelFactory(ChannelFactory<? extends Channel> channelFactory)	ChannelFactory which is used to create Channel instances from when calling AbstractBootstrap.bind().

Uses of Channel in io.netty5.channel

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

Modifier and Type	Class	Description
class	AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>	A skeletal Channel implementation.
class	AbstractServerChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>	A skeletal server-side Channel implementation.
interface	ChannelFactory<T extends Channel>	Creates a new Channel.
class	ChannelInitializer<C extends Channel>	A special ChannelHandler 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.

Subinterfaces of Channel in io.netty5.channel

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

Classes in io.netty5.channel that implement Channel

Modifier and Type	Class	Description
class	AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>	A skeletal Channel implementation.
class	AbstractServerChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>	A skeletal server-side Channel implementation.

Fields in io.netty5.channel with type parameters of type Channel

Modifier and Type	Field	Description
static FutureContextListener<Channel,Object>	ChannelFutureListeners.FIRE_EXCEPTION_ON_FAILURE	A FutureContextListener that forwards the Throwable of the Future into the ChannelPipeline.

Methods in io.netty5.channel that return Channel

Modifier and Type	Method	Description
default Channel	ChannelHandlerContext.channel()	Return the Channel which is bound to the ChannelHandlerContext.
Channel	ChannelPipeline.channel()	Returns the Channel that this pipeline is attached to.
Channel	DefaultChannelPipeline.channel()
default Channel	Channel.flush()
Channel	Channel.parent()	Returns the parent of this channel.
default Channel	Channel.read()
<T> Channel	AbstractChannel.setOption(ChannelOption<T> option, T value)
<T> Channel	Channel.setOption(ChannelOption<T> option, T value)	Sets a configuration property with the specified name and value.

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

Modifier and Type	Method	Description
int	AbstractChannel.compareTo(Channel o)

Method parameters in io.netty5.channel with type arguments of type Channel

Modifier and Type	Method	Description
protected static <T extends EventLoopGroup> T	AbstractChannel.validateEventLoopGroup(T group, String name, Class<? extends Channel> channelType)

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

Constructor	Description
CoalescingBufferQueue(Channel channel)
CoalescingBufferQueue(Channel channel, int initSize)
DefaultChannelPipeline(Channel channel)

Constructor parameters in io.netty5.channel with type arguments of type Channel

Constructor	Description
AbstractServerChannel(EventLoop eventLoop, EventLoopGroup childEventLoopGroup, ChannelMetadata metadata, Class<? extends Channel> childChannelType)
AbstractServerChannel(EventLoop eventLoop, EventLoopGroup childEventLoopGroup, Class<? extends Channel> childChannelType)	Creates a new instance.

Uses of Channel in io.netty5.channel.embedded

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

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

Constructors in io.netty5.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.netty5.channel.epoll

Classes in io.netty5.channel.epoll that implement Channel

Modifier and Type	Class	Description
class	EpollDatagramChannel	DatagramChannel implementation that uses linux EPOLL Edge-Triggered Mode for maximal performance.
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.

Uses of Channel in io.netty5.channel.group

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

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

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

Modifier and Type	Method	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.netty5.channel.group with parameters of type Channel

Modifier and Type	Method	Description
boolean	DefaultChannelGroup.add(Channel channel)
Future<Void>	ChannelGroupFuture.find(Channel channel)	Returns the Future 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.netty5.channel.group with type arguments of type Channel

Modifier and Type	Method	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.netty5.channel.group with type arguments of type Channel

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

Uses of Channel in io.netty5.channel.internal

Methods in io.netty5.channel.internal that return Channel

Modifier and Type	Method	Description
Channel	DelegatingChannelHandlerContext.channel()

Uses of Channel in io.netty5.channel.kqueue

Classes in io.netty5.channel.kqueue that implement Channel

Modifier and Type	Class	Description
class	KQueueDatagramChannel	DatagramChannel implementation that uses KQueue.
class	KQueueServerSocketChannel	ServerSocketChannel implementation that uses KQueue.
class	KQueueSocketChannel	SocketChannel implementation that uses KQueue.

Uses of Channel in io.netty5.channel.local

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

Modifier and Type	Class	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.netty5.channel.nio

Classes in io.netty5.channel.nio with type parameters of type Channel

Modifier and Type	Class	Description
class	AbstractNioByteChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>	AbstractNioChannel base class for Channels that operate on bytes.
class	AbstractNioChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>	Abstract base class for Channel implementations which use a Selector based approach.
class	AbstractNioMessageChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>	AbstractNioChannel base class for Channels that operate on messages.

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

Modifier and Type	Class	Description
class	AbstractNioByteChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>	AbstractNioChannel base class for Channels that operate on bytes.
class	AbstractNioChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>	Abstract base class for Channel implementations which use a Selector based approach.
class	AbstractNioMessageChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>	AbstractNioChannel base class for Channels that operate on messages.

Uses of Channel in io.netty5.channel.socket

Subinterfaces of Channel in io.netty5.channel.socket

Modifier and Type	Interface	Description
interface	DatagramChannel	A UDP/IP Channel.
interface	ServerSocketChannel	A Socket ServerChannel which accepts incoming Socket connections.
interface	SocketChannel	A Socket Channel.

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

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

Modifier and Type	Class	Description
class	NioDatagramChannel	An NIO DatagramChannel 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.

Uses of Channel in io.netty5.channel.unix

Subinterfaces of Channel in io.netty5.channel.unix

Modifier and Type	Interface	Description
interface	UnixChannel	Channel that expose operations that are only present on UNIX like systems.

Uses of Channel in io.netty5.handler.codec.http.websocketx

Methods in io.netty5.handler.codec.http.websocketx with parameters of type Channel

Modifier and Type	Method	Description
Future<Void>	WebSocketClientHandshaker.close(Channel channel, CloseWebSocketFrame frame)	Performs the closing handshake.
Future<Void>	WebSocketServerHandshaker.close(Channel channel, CloseWebSocketFrame frame)	Performs the closing handshake.
void	WebSocketClientHandshaker.finishHandshake(Channel channel, FullHttpResponse response)	Validates and finishes the opening handshake initiated by WebSocketClientHandshaker.handshake(io.netty5.channel.Channel)}.
Future<Void>	WebSocketClientHandshaker.handshake(Channel channel)	Begins the opening handshake
Future<Void>	WebSocketServerHandshaker.handshake(Channel channel, FullHttpRequest req)	Performs the opening handshake.
Future<Void>	WebSocketServerHandshaker.handshake(Channel channel, FullHttpRequest req, HttpHeaders responseHeaders)	Performs the opening handshake When call this method you MUST NOT retain the FullHttpRequest which is passed in.
Future<Void>	WebSocketServerHandshaker.handshake(Channel channel, HttpRequest req)	Performs the opening handshake.
Future<Void>	WebSocketServerHandshaker.handshake(Channel channel, HttpRequest req, HttpHeaders responseHeaders)	Performs the opening handshake When call this method you MUST NOT retain the HttpRequest which is passed in.
Future<Void>	WebSocketClientHandshaker.processHandshake(Channel channel, HttpResponse response)	Process the opening handshake initiated by WebSocketClientHandshaker.handshake(io.netty5.channel.Channel)}.
static Future<Void>	WebSocketServerHandshakerFactory.sendUnsupportedVersionResponse(Channel channel)	Return that we need cannot not support the web socket version
static void	WebSocketServerHandshakerFactory.sendUnsupportedWebSocketVersionResponse(Channel channel)	Deprecated. use WebSocketServerHandshakerFactory.sendUnsupportedVersionResponse(Channel)

Uses of Channel in io.netty5.handler.codec.http2

Subinterfaces of Channel in io.netty5.handler.codec.http2

Modifier and Type	Interface	Description
interface	Http2StreamChannel

Constructors in io.netty5.handler.codec.http2 with parameters of type Channel

Constructor	Description
Http2StreamChannelBootstrap(Channel channel)

Uses of Channel in io.netty5.handler.ssl

Methods in io.netty5.handler.ssl that return types with arguments of type Channel

Modifier and Type	Method	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()	Return the Future that will get notified if the inbound of the SSLEngine is closed.

Method parameters in io.netty5.handler.ssl with type arguments of type Channel

Modifier and Type	Method	Description
Future<Channel>	SslHandler.renegotiate(Promise<Channel> promise)	Performs TLS renegotiation.