A B C D E F G H I J L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractBootstrap<B extends AbstractBootstrap<B,C,F>,C extends Channel,F> - Class in io.netty5.bootstrap
-
AbstractBootstrapis a helper class that makes it easy to bootstrap aChannel. - AbstractBootstrapConfig<B extends AbstractBootstrap<B,C,F>,C extends Channel,F> - Class in io.netty5.bootstrap
-
Exposes the configuration of an
AbstractBootstrap. - abstractChannel() - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress> - Class in io.netty5.channel
-
A skeletal
Channelimplementation. - AbstractChannel(P, EventLoop, boolean) - Constructor for class io.netty5.channel.AbstractChannel
-
Creates a new instance.
- AbstractChannel(P, EventLoop, boolean, ReadHandleFactory, WriteHandleFactory) - Constructor for class io.netty5.channel.AbstractChannel
-
Creates a new instance.
- AbstractChannel(P, EventLoop, boolean, ReadHandleFactory, WriteHandleFactory, ChannelId) - Constructor for class io.netty5.channel.AbstractChannel
-
Creates a new instance.
- AbstractChannel.DefaultAbstractChannelPipeline - Class in io.netty5.channel
- AbstractChannel.ReadSink - Class in io.netty5.channel
-
Sink that will be used by
#doReadNow(ReadSink)implementations to perform the actual read from the underlying transport (for example a socket). - AbstractChannel.WriteSink - Class in io.netty5.channel
-
Sink that will be used by
#doWriteNow(WriteSink)implementations. - AbstractCoalescingBufferQueue - Class in io.netty5.channel
- AbstractCoalescingBufferQueue(int) - Constructor for class io.netty5.channel.AbstractCoalescingBufferQueue
-
Create a new instance.
- AbstractNioByteChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress> - Class in io.netty5.channel.nio
-
AbstractNioChannelbase class forChannels that operate on bytes. - AbstractNioByteChannel(P, EventLoop, WriteHandleFactory, SelectableChannel) - Constructor for class io.netty5.channel.nio.AbstractNioByteChannel
-
Create a new instance
- AbstractNioChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress> - Class in io.netty5.channel.nio
-
Abstract base class for
Channelimplementations which use a Selector based approach. - AbstractNioChannel(P, EventLoop, boolean, ReadHandleFactory, WriteHandleFactory, SelectableChannel, int) - Constructor for class io.netty5.channel.nio.AbstractNioChannel
-
Create a new instance
- AbstractNioMessageChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress> - Class in io.netty5.channel.nio
-
AbstractNioChannelbase class forChannels that operate on messages. - AbstractNioMessageChannel(P, EventLoop, boolean, ReadHandleFactory, WriteHandleFactory, SelectableChannel, int) - Constructor for class io.netty5.channel.nio.AbstractNioMessageChannel
- AbstractServerChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress> - Class in io.netty5.channel
-
A skeletal
ServerChannelimplementation. - AbstractServerChannel(EventLoop, EventLoopGroup, Class<? extends Channel>) - Constructor for class io.netty5.channel.AbstractServerChannel
-
Creates a new instance.
- acceptEvent(Object) - Method in class io.netty5.channel.SimpleUserEventChannelHandler
-
Returns
trueif the given user event should be handled. - acceptInboundMessage(Object) - Method in class io.netty5.channel.SimpleChannelInboundHandler
-
Returns
trueif the given message should be handled. - AdaptiveReadHandleFactory - Class in io.netty5.channel
-
The
ReadHandleFactorythat automatically increases and decreases the predicted buffer size on feed back. - AdaptiveReadHandleFactory() - Constructor for class io.netty5.channel.AdaptiveReadHandleFactory
-
Creates a new predictor with the default parameters.
- AdaptiveReadHandleFactory(int) - Constructor for class io.netty5.channel.AdaptiveReadHandleFactory
-
Creates a new predictor with the default parameters.
- AdaptiveReadHandleFactory(int, int, int, int) - Constructor for class io.netty5.channel.AdaptiveReadHandleFactory
-
Creates a new predictor with the specified parameters.
- add(Buffer) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Add a buffer to the end of the queue.
- add(Buffer, FutureListener<Void>) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Add a buffer to the end of the queue and associate a listener with it that should be completed when all the buffers bytes have been consumed from the queue and written.
- add(Buffer, Promise<Void>) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Add a buffer to the end of the queue and associate a promise with it that should be completed when all the buffer's bytes have been consumed from the queue and written.
- add(Channel) - Method in class io.netty5.channel.group.DefaultChannelGroup
- add(Object, Promise<Void>) - Method in class io.netty5.channel.PendingWriteQueue
-
Add the given
msgandPromise. - addAfter(String, String, ChannelHandler) - Method in interface io.netty5.channel.ChannelPipeline
-
Inserts a
ChannelHandlerafter an existing handler of this pipeline. - addAfter(String, String, ChannelHandler) - Method in class io.netty5.channel.DefaultChannelPipeline
- addBefore(String, String, ChannelHandler) - Method in interface io.netty5.channel.ChannelPipeline
-
Inserts a
ChannelHandlerbefore an existing handler of this pipeline. - addBefore(String, String, ChannelHandler) - Method in class io.netty5.channel.DefaultChannelPipeline
- addFirst(Buffer, Promise<Void>) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Add a buffer to the front of the queue and associate a promise with it that should be completed when all the buffer's bytes have been consumed from the queue and written.
- addFirst(ChannelHandler) - Method in class io.netty5.channel.DefaultChannelPipeline
- addFirst(ChannelHandler...) - Method in interface io.netty5.channel.ChannelPipeline
-
Inserts
ChannelHandlers at the first position of this pipeline. - addFirst(ChannelHandler...) - Method in class io.netty5.channel.DefaultChannelPipeline
- addFirst(String, ChannelHandler) - Method in interface io.netty5.channel.ChannelPipeline
-
Inserts a
ChannelHandlerat the first position of this pipeline. - addFirst(String, ChannelHandler) - Method in class io.netty5.channel.DefaultChannelPipeline
- addLast(ChannelHandler) - Method in class io.netty5.channel.DefaultChannelPipeline
- addLast(ChannelHandler...) - Method in interface io.netty5.channel.ChannelPipeline
-
Inserts
ChannelHandlers at the last position of this pipeline. - addLast(ChannelHandler...) - Method in class io.netty5.channel.DefaultChannelPipeline
- addLast(String, ChannelHandler) - Method in interface io.netty5.channel.ChannelPipeline
-
Appends a
ChannelHandlerat the last position of this pipeline. - addLast(String, ChannelHandler) - Method in class io.netty5.channel.DefaultChannelPipeline
- addListener(FutureListener<? super Void>) - Method in interface io.netty5.channel.group.ChannelGroupFuture
- AddressedEnvelope<M,A extends SocketAddress> - Interface in io.netty5.channel
-
A message that wraps another message with a sender address and a recipient address.
- advanceTimeBy(long, TimeUnit) - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Advance the clock of the event loop of this channel by the given duration.
- all() - Static method in class io.netty5.channel.group.ChannelMatchers
-
Returns a
ChannelMatcherthat matches allChannels. - allocate(BufferAllocator, int) - Method in interface io.netty5.channel.ReadBufferAllocator
-
Allocates a
Bufferthat is used for the next actual read to store the data in. - allocateBuffer() - Method in class io.netty5.channel.AbstractChannel.ReadSink
-
Allocate a
Bufferwith a capacity that is probably large enough to read all inbound data and small enough not to waste space. - ALLOW_HALF_CLOSURE - Static variable in class io.netty5.channel.ChannelOption
- ANY - Static variable in class io.netty5.channel.local.LocalAddress
- asLongText() - Method in interface io.netty5.channel.ChannelId
-
Returns the long yet globally unique string representation of the
ChannelId. - asLongText() - Method in class io.netty5.channel.DefaultChannelId
- asShortText() - Method in interface io.netty5.channel.ChannelId
-
Returns the short but globally non-unique string representation of the
ChannelId. - asShortText() - Method in class io.netty5.channel.DefaultChannelId
- attr(AttributeKey<T>, T) - Method in class io.netty5.bootstrap.AbstractBootstrap
-
Allow to specify an initial attribute of the newly created
Channel. - attrs() - Method in class io.netty5.bootstrap.AbstractBootstrapConfig
-
Returns a copy of the configured attributes.
- AUTO_CLOSE - Static variable in class io.netty5.channel.ChannelOption
-
If
truethen theChannelis closed automatically and immediately on write failure. - AUTO_READ - Static variable in class io.netty5.channel.ChannelOption
B
- bind() - Method in class io.netty5.bootstrap.AbstractBootstrap
-
Create a new
Channeland bind it. - bind(int) - Method in class io.netty5.bootstrap.AbstractBootstrap
-
Create a new
Channeland bind it. - bind(ChannelHandlerContext, SocketAddress) - Method in interface io.netty5.channel.ChannelHandler
-
Called once a bind operation is made.
- bind(ChannelHandlerContext, SocketAddress) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- bind(String, int) - Method in class io.netty5.bootstrap.AbstractBootstrap
-
Create a new
Channeland bind it. - bind(InetAddress, int) - Method in class io.netty5.bootstrap.AbstractBootstrap
-
Create a new
Channeland bind it. - bind(SocketAddress) - Method in class io.netty5.bootstrap.AbstractBootstrap
-
Create a new
Channeland bind it. - bind(SocketAddress) - Method in interface io.netty5.channel.Channel
- bind(SocketAddress) - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Request to bind to the given
SocketAddressand notify theFutureonce the operation completes, either because the operation was successful or because of an error. - bind(SocketAddress) - Method in class io.netty5.channel.DefaultChannelPipeline
- bind(SocketAddress) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- bindTransport(SocketAddress, Promise<Void>) - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- bindTransport(SocketAddress, Promise<Void>) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Bind the
SocketAddressto the transport and notify thePromiseonce the operation was completed. - block(InetAddress, InetAddress) - Method in interface io.netty5.channel.socket.DatagramChannel
-
Block the given sourceToBlock address for the given multicastAddress and notifies the
Futureonce the operation completes. - block(InetAddress, InetAddress) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
-
Block the given sourceToBlock address for the given multicastAddress
- block(InetAddress, NetworkInterface, InetAddress) - Method in interface io.netty5.channel.socket.DatagramChannel
-
Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the
Futureonce the operation completes. - block(InetAddress, NetworkInterface, InetAddress) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
-
Block the given sourceToBlock address for the given multicastAddress on the given networkInterface
- bootstrap - Variable in class io.netty5.bootstrap.AbstractBootstrapConfig
- Bootstrap - Class in io.netty5.bootstrap
- Bootstrap() - Constructor for class io.netty5.bootstrap.Bootstrap
- BootstrapConfig - Class in io.netty5.bootstrap
-
Exposes the configuration of a
Bootstrap. - BUFFER_ALLOCATOR - Static variable in class io.netty5.channel.ChannelOption
- BufferAddressedEnvelope<A extends SocketAddress,T extends BufferAddressedEnvelope<A,T>> - Class in io.netty5.channel
-
Base class for addressed envelopes that have
Bufferinstances as messages. - BufferAddressedEnvelope(Buffer, A) - Constructor for class io.netty5.channel.BufferAddressedEnvelope
- BufferAddressedEnvelope(Buffer, A, A) - Constructor for class io.netty5.channel.BufferAddressedEnvelope
- bufferAllocator() - Method in class io.netty5.channel.AbstractChannel
- bufferAllocator() - Method in interface io.netty5.channel.Channel
-
Return the assigned
BufferAllocatorwhich will be used to allocateBuffers. - bufferAllocator() - Method in interface io.netty5.channel.ChannelHandlerContext
-
Return the assigned
BufferAllocatorwhich will be used to allocateBuffers. - bufferAllocator() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- BUSY_WAIT - Static variable in interface io.netty5.channel.SelectStrategy
-
Indicates the IO loop to poll for new events without blocking.
- bytes() - Method in class io.netty5.channel.PendingWriteQueue
-
Returns the total number of bytes that are pending because of pending messages.
C
- cacheAddresses(L, R) - Method in class io.netty5.channel.AbstractChannel
- calculateStrategy(IntSupplier, boolean) - Method in interface io.netty5.channel.SelectStrategy
-
The
SelectStrategycan be used to steer the outcome of a potential select call. - canBlock() - Method in interface io.netty5.channel.IoExecutionContext
-
Returns
trueif blocking for IO is allowed or if we should try to do a non-blocking request for IO to be ready. - cause() - Method in interface io.netty5.channel.group.ChannelGroupFuture
- channel() - Method in interface io.netty5.channel.ChannelHandlerContext
-
Return the
Channelwhich is bound to theChannelHandlerContext. - channel() - Method in interface io.netty5.channel.ChannelPipeline
-
Returns the
Channelthat this pipeline is attached to. - channel() - Method in class io.netty5.channel.DefaultChannelPipeline
- channel() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- channel(Class<? extends Channel>) - Method in class io.netty5.bootstrap.Bootstrap
- channel(Class<? extends ServerChannel>) - Method in class io.netty5.bootstrap.ServerBootstrap
-
The
Classwhich is used to createServerChannelinstances from. - Channel - Interface in io.netty5.channel
-
A nexus to a network socket or a component which is capable of I/O operations such as read, write, connect, and bind.
- channelActive(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
-
The
Channelof theChannelHandlerContextis now active - channelActive(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- ChannelException - Exception in io.netty5.channel
-
A
RuntimeExceptionwhich is thrown when an I/O operation fails. - ChannelException() - Constructor for exception io.netty5.channel.ChannelException
-
Creates a new exception.
- ChannelException(String) - Constructor for exception io.netty5.channel.ChannelException
-
Creates a new exception.
- ChannelException(String, Throwable) - Constructor for exception io.netty5.channel.ChannelException
-
Creates a new exception.
- ChannelException(String, Throwable, boolean) - Constructor for exception io.netty5.channel.ChannelException
- ChannelException(Throwable) - Constructor for exception io.netty5.channel.ChannelException
-
Creates a new exception.
- channelExceptionCaught(ChannelHandlerContext, Throwable) - Method in interface io.netty5.channel.ChannelHandler
-
Gets called if a
Throwablewas thrown when handling inbound events. - channelExceptionCaught(ChannelHandlerContext, Throwable) - Method in class io.netty5.channel.ChannelInitializer
- channelExceptionCaught(ChannelHandlerContext, Throwable) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- channelFactory() - Method in class io.netty5.bootstrap.AbstractBootstrapConfig
- channelFactory() - Method in class io.netty5.bootstrap.BootstrapConfig
- channelFactory() - Method in class io.netty5.bootstrap.ServerBootstrapConfig
- channelFactory(ChannelFactory<? extends Channel>) - Method in class io.netty5.bootstrap.Bootstrap
-
ChannelFactorywhich is used to createChannelinstances from when callingAbstractBootstrap.bind(). - channelFactory(ServerChannelFactory<? extends ServerChannel>) - Method in class io.netty5.bootstrap.ServerBootstrap
-
ServerChannelFactorywhich is used to createChannelinstances from when callingAbstractBootstrap.bind(). - ChannelFactory<T extends Channel> - Interface in io.netty5.channel
-
Creates a new
Channel. - ChannelFutureListeners - Class in io.netty5.channel
-
FutureContextListenerlisteners that take a context, and listens to the result of aFuture. - ChannelGroup - Interface in io.netty5.channel.group
- ChannelGroupException - Exception in io.netty5.channel.group
-
ChannelExceptionwhich holdsFutures that failed because of an error. - ChannelGroupException(Collection<Map.Entry<Channel, Throwable>>) - Constructor for exception io.netty5.channel.group.ChannelGroupException
- ChannelGroupFuture - Interface in io.netty5.channel.group
-
The result of an asynchronous
ChannelGroupoperation. - ChannelGroupFutureListener - Interface in io.netty5.channel.group
-
Listens to the result of a
ChannelGroupFuture. - ChannelHandler - Interface in io.netty5.channel
-
Handles an I/O event or intercepts an I/O operation, and forwards it to its next handler in its
ChannelPipeline. - ChannelHandlerAdapter - Class in io.netty5.channel
-
Skeleton implementation of a
ChannelHandler. - ChannelHandlerAdapter() - Constructor for class io.netty5.channel.ChannelHandlerAdapter
- ChannelHandlerContext - Interface in io.netty5.channel
-
Enables a
ChannelHandlerto interact with itsChannelPipelineand other handlers. - ChannelId - Interface in io.netty5.channel
-
Represents the globally unique identifier of a
Channel. - channelInactive(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
-
The
Channelof theChannelHandlerContextwas registered is now inactive and reached its end of lifetime. - channelInactive(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- channelInboundEvent(ChannelHandlerContext, Object) - Method in interface io.netty5.channel.ChannelHandler
-
Gets called if a custom inbound event happened.
- channelInboundEvent(ChannelHandlerContext, Object) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- channelInboundEvent(ChannelHandlerContext, Object) - Method in class io.netty5.channel.SimpleUserEventChannelHandler
- ChannelInboundInvoker - Interface in io.netty5.channel
- ChannelInitializer<C extends Channel> - Class in io.netty5.channel
-
A special
ChannelHandlerwhich offers an easy way to initialize aChannelonce it was registered to itsEventLoop. - ChannelInitializer() - Constructor for class io.netty5.channel.ChannelInitializer
- ChannelMatcher - Interface in io.netty5.channel.group
-
Allows to only match some
Channel's for operations inChannelGroup. - ChannelMatchers - Class in io.netty5.channel.group
-
Helper class which provides often used
ChannelMatcherimplementations. - ChannelOption<T> - Class in io.netty5.channel
-
A
ChannelOptionallows to configure aChannelin a type-safe way. - ChannelOption(String) - Constructor for class io.netty5.channel.ChannelOption
-
Deprecated.
- ChannelOutboundInvoker - Interface in io.netty5.channel
- ChannelOutputShutdownException - Exception in io.netty5.channel
-
Used to fail pending writes when a channel's output has been shutdown.
- ChannelOutputShutdownException() - Constructor for exception io.netty5.channel.ChannelOutputShutdownException
- ChannelOutputShutdownException(String) - Constructor for exception io.netty5.channel.ChannelOutputShutdownException
- ChannelOutputShutdownException(String, Throwable) - Constructor for exception io.netty5.channel.ChannelOutputShutdownException
- ChannelPipeline - Interface in io.netty5.channel
-
A list of
ChannelHandlers which handles or intercepts inbound events and outbound operations of aChannel. - ChannelPipelineException - Exception in io.netty5.channel
-
A
ChannelExceptionwhich is thrown when aChannelPipelinefailed to execute an operation. - ChannelPipelineException() - Constructor for exception io.netty5.channel.ChannelPipelineException
-
Creates a new instance.
- ChannelPipelineException(String) - Constructor for exception io.netty5.channel.ChannelPipelineException
-
Creates a new instance.
- ChannelPipelineException(String, Throwable) - Constructor for exception io.netty5.channel.ChannelPipelineException
-
Creates a new instance.
- ChannelPipelineException(Throwable) - Constructor for exception io.netty5.channel.ChannelPipelineException
-
Creates a new instance.
- channelRead(ChannelHandlerContext, Object) - Method in interface io.netty5.channel.ChannelHandler
-
Invoked when the current
Channelhas read a message from the peer. - channelRead(ChannelHandlerContext, Object) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- channelRead(ChannelHandlerContext, Object) - Method in class io.netty5.channel.SimpleChannelInboundHandler
- channelReadComplete(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
-
Invoked when the last message read by the current read operation has been consumed by
ChannelHandler.channelRead(ChannelHandlerContext, Object). - channelReadComplete(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- channelRegistered(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
- channelRegistered(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- channelShutdown(ChannelHandlerContext, ChannelShutdownDirection) - Method in interface io.netty5.channel.ChannelHandler
-
The
Channelof theChannelHandlerContextwas shutdown in one direction. - channelShutdown(ChannelHandlerContext, ChannelShutdownDirection) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- ChannelShutdownDirection - Enum in io.netty5.channel
-
The direction of a shutdown.
- channelUnregistered(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
- channelUnregistered(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- channelWritabilityChanged(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
-
Gets called once the writable state of a
Channelchanged. - channelWritabilityChanged(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- checkException() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Check if there was any
Throwablereceived and if so rethrow it. - childAttr(AttributeKey<T>, T) - Method in class io.netty5.bootstrap.ServerBootstrap
-
Set the specific
AttributeKeywith the given value on every childChannel. - childAttrs() - Method in class io.netty5.bootstrap.ServerBootstrapConfig
-
Returns a copy of the configured attributes which will be used for the child channels.
- childEventLoopGroup() - Method in class io.netty5.channel.AbstractServerChannel
- childEventLoopGroup() - Method in interface io.netty5.channel.ServerChannel
-
Returns the
EventLoopGroupthat is used to register the childChannels on after accepting these. - childEventLoopGroup() - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- childGroup() - Method in class io.netty5.bootstrap.ServerBootstrap
-
Deprecated.Use
ServerBootstrap.config()instead. - childGroup() - Method in class io.netty5.bootstrap.ServerBootstrapConfig
-
Returns the configured
EventLoopGroupwhich will be used for the child channels ornullif non is configured yet. - childHandler() - Method in class io.netty5.bootstrap.ServerBootstrapConfig
-
Returns the configured
ChannelHandlerbe used for the child channels ornullif non is configured yet. - childHandler(ChannelHandler) - Method in class io.netty5.bootstrap.ServerBootstrap
-
Set the
ChannelHandlerwhich is used to serve the request for theChannel's. - childOption(ChannelOption<T>, T) - Method in class io.netty5.bootstrap.ServerBootstrap
-
Allow to specify a
ChannelOptionwhich is used for theChannelinstances once they get created (after the acceptor accepted theChannel). - childOptions() - Method in class io.netty5.bootstrap.ServerBootstrapConfig
-
Returns a copy of the configured options which will be used for the child channels.
- cleanup() - Method in class io.netty5.channel.SingleThreadEventLoop
- clear() - Method in class io.netty5.channel.group.DefaultChannelGroup
- clone() - Method in class io.netty5.bootstrap.AbstractBootstrap
-
Returns a deep clone of this bootstrap which has the identical configuration.
- clone() - Method in class io.netty5.bootstrap.Bootstrap
- clone() - Method in class io.netty5.bootstrap.ServerBootstrap
- clone(EventLoopGroup) - Method in class io.netty5.bootstrap.Bootstrap
-
Returns a deep clone of this bootstrap which has the identical configuration except that it uses the given
EventLoopGroup. - close() - Method in class io.netty5.channel.BufferAddressedEnvelope
- close() - Method in interface io.netty5.channel.Channel
- close() - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Request to close the
Channeland notify theFutureonce the operation completes, either because the operation was successful or because of an error. - close() - Method in class io.netty5.channel.DefaultChannelPipeline
- close() - Method in class io.netty5.channel.embedded.EmbeddedChannel
- close() - Method in interface io.netty5.channel.group.ChannelGroup
-
Closes all
Channels in this group. - close() - Method in class io.netty5.channel.group.DefaultChannelGroup
- close() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- close(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
-
Called once a close operation is made.
- close(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- close(ChannelMatcher) - Method in interface io.netty5.channel.group.ChannelGroup
-
Closes all
Channels in this group that are matched by the givenChannelMatcher. - close(ChannelMatcher) - Method in class io.netty5.channel.group.DefaultChannelGroup
- CLOSE - Static variable in class io.netty5.channel.ChannelFutureListeners
-
A
FutureContextListenerthat closes theChannelOutboundInvokerwhich is associated with the specifiedFuture. - CLOSE_ON_FAILURE - Static variable in class io.netty5.channel.ChannelFutureListeners
-
A
FutureContextListenerthat closes theChannelOutboundInvokerwhen the operation ended up with a failure or cancellation rather than a success. - closeFuture() - Method in class io.netty5.channel.AbstractChannel
- closeFuture() - Method in interface io.netty5.channel.Channel
-
Returns the
Futurewhich will be notified when this channel is closed. - closeTransport(Promise<Void>) - Method in class io.netty5.channel.AbstractChannel
- closeTransport(Promise<Void>) - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- closeTransport(Promise<Void>) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Close the transport and notify the
Promiseonce the operation was completed. - closeTransportNow() - Method in class io.netty5.channel.local.LocalChannel
- closeTransportNow() - Method in class io.netty5.channel.local.LocalServerChannel
- CoalescingBufferQueue - Class in io.netty5.channel
-
A FIFO queue of bytes where producers add bytes by repeatedly adding
Bufferand consumers take bytes in arbitrary lengths. - CoalescingBufferQueue(Channel) - Constructor for class io.netty5.channel.CoalescingBufferQueue
- CoalescingBufferQueue(Channel, int) - Constructor for class io.netty5.channel.CoalescingBufferQueue
- CombinedChannelDuplexHandler<I extends ChannelHandler,O extends ChannelHandler> - Class in io.netty5.channel
-
Combines the inbound handling of one
ChannelHandlerwith the outbound handling of anotherChannelHandler. - CombinedChannelDuplexHandler() - Constructor for class io.netty5.channel.CombinedChannelDuplexHandler
-
Creates a new uninitialized instance.
- CombinedChannelDuplexHandler(I, O) - Constructor for class io.netty5.channel.CombinedChannelDuplexHandler
-
Creates a new instance that combines the specified two handlers into one.
- compareTo(Channel) - Method in class io.netty5.channel.AbstractChannel
- compareTo(ChannelId) - Method in class io.netty5.channel.DefaultChannelId
- compareTo(ChannelGroup) - Method in class io.netty5.channel.group.DefaultChannelGroup
- compareTo(LocalAddress) - Method in class io.netty5.channel.local.LocalAddress
- complete(long, long, int, boolean) - Method in class io.netty5.channel.AbstractChannel.WriteSink
-
Notify of the last write operation and its result.
- complete(long, Throwable, boolean) - Method in class io.netty5.channel.AbstractChannel.WriteSink
-
Notify of the last write operation and its result.
- compose(BufferAllocator, Buffer, Buffer) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Calculate the result of
current + next. - compose(BufferAllocator, Buffer, Buffer) - Method in class io.netty5.channel.CoalescingBufferQueue
- compose(ChannelMatcher...) - Static method in class io.netty5.channel.group.ChannelMatchers
-
Return a composite of the given
ChannelMatchers. - composeFirst(BufferAllocator, Buffer) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Calculate the first
Bufferwhich will be used in subsequent calls toAbstractCoalescingBufferQueue.compose(BufferAllocator, Buffer, Buffer). - composeIntoComposite(BufferAllocator, Buffer, Buffer) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Compose
cumulationandnextinto a newCompositeBuffer. - config() - Method in class io.netty5.bootstrap.AbstractBootstrap
-
Returns the
AbstractBootstrapConfigobject that can be used to obtain the current config of the bootstrap. - config() - Method in class io.netty5.bootstrap.Bootstrap
- config() - Method in class io.netty5.bootstrap.ServerBootstrap
- connect() - Method in class io.netty5.bootstrap.Bootstrap
-
Connect a
Channelto the remote peer. - connect(ChannelHandlerContext, SocketAddress, SocketAddress) - Method in interface io.netty5.channel.ChannelHandler
-
Called once a connect operation is made.
- connect(ChannelHandlerContext, SocketAddress, SocketAddress) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- connect(String, int) - Method in class io.netty5.bootstrap.Bootstrap
-
Connect a
Channelto the remote peer. - connect(InetAddress, int) - Method in class io.netty5.bootstrap.Bootstrap
-
Connect a
Channelto the remote peer. - connect(SocketAddress) - Method in class io.netty5.bootstrap.Bootstrap
-
Connect a
Channelto the remote peer. - connect(SocketAddress) - Method in interface io.netty5.channel.Channel
- connect(SocketAddress) - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Request to connect to the given
SocketAddressand notify theFutureonce the operation completes, either because the operation was successful or because of an error. - connect(SocketAddress) - Method in class io.netty5.channel.DefaultChannelPipeline
- connect(SocketAddress) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- connect(SocketAddress, SocketAddress) - Method in class io.netty5.bootstrap.Bootstrap
-
Connect a
Channelto the remote peer. - connect(SocketAddress, SocketAddress) - Method in interface io.netty5.channel.Channel
- connect(SocketAddress, SocketAddress) - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Request to connect to the given
SocketAddresswhile bind to the localAddress and notify theFutureonce the operation completes, either because the operation was successful or because of an error. - connect(SocketAddress, SocketAddress) - Method in class io.netty5.channel.DefaultChannelPipeline
- connect(SocketAddress, SocketAddress) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- CONNECT_TIMEOUT_MILLIS - Static variable in class io.netty5.channel.ChannelOption
- ConnectTimeoutException - Exception in io.netty5.channel
-
ConnectExceptionwhich will be thrown if a connection could not be established because of a connection timeout. - ConnectTimeoutException() - Constructor for exception io.netty5.channel.ConnectTimeoutException
- ConnectTimeoutException(String) - Constructor for exception io.netty5.channel.ConnectTimeoutException
- connectTransport(SocketAddress, SocketAddress, Promise<Void>) - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- connectTransport(SocketAddress, SocketAddress, Promise<Void>) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Connect the transport with the given remote
SocketAddress. - contains(Object) - Method in class io.netty5.channel.group.DefaultChannelGroup
- content() - Method in interface io.netty5.channel.AddressedEnvelope
-
Returns the message wrapped by this envelope message.
- content() - Method in class io.netty5.channel.DefaultAddressedEnvelope
- context(ChannelHandler) - Method in interface io.netty5.channel.ChannelPipeline
-
Returns the context object of the specified
ChannelHandlerin this pipeline. - context(ChannelHandler) - Method in class io.netty5.channel.DefaultChannelPipeline
- context(Class<? extends ChannelHandler>) - Method in interface io.netty5.channel.ChannelPipeline
-
Returns the context object of the
ChannelHandlerof the specified type in this pipeline. - context(Class<? extends ChannelHandler>) - Method in class io.netty5.channel.DefaultChannelPipeline
- context(String) - Method in interface io.netty5.channel.ChannelPipeline
-
Returns the context object of the
ChannelHandlerwith the specified name in this pipeline. - context(String) - Method in class io.netty5.channel.DefaultChannelPipeline
- CONTINUE - Static variable in interface io.netty5.channel.SelectStrategy
-
Indicates the IO loop should be retried, no blocking select to follow directly.
- copyAndCompose(BufferAllocator, Buffer, Buffer, int) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Compose
cumulationandnextinto a newBuffersuitable for IO. - copyTo(AbstractCoalescingBufferQueue) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Copy all pending entries in this queue into the destination queue.
- count() - Method in class io.netty5.channel.DefaultFileRegion
- count() - Method in interface io.netty5.channel.FileRegion
-
Returns the number of bytes to transfer.
- createUnregistered() - Method in class io.netty5.bootstrap.AbstractBootstrap
-
Create a new unregistered channel.
- current() - Method in class io.netty5.channel.PendingWriteQueue
-
Return the current message or
nullif empty. - currentFlushedMessage() - Method in class io.netty5.channel.AbstractChannel.WriteSink
-
Return the current message that should be written.
D
- DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION - Static variable in class io.netty5.channel.ChannelOption
- DatagramChannel - Interface in io.netty5.channel.socket
-
A UDP/IP
Channel. - DatagramPacket - Class in io.netty5.channel.socket
-
The message container that is used for
DatagramChannelto communicate with the remote peer. - DatagramPacket(Buffer, SocketAddress) - Constructor for class io.netty5.channel.socket.DatagramPacket
-
Create a new instance with the specified packet
dataandrecipientaddress. - DatagramPacket(Buffer, SocketAddress, SocketAddress) - Constructor for class io.netty5.channel.socket.DatagramPacket
-
Create a new instance with the specified packet
data,recipientaddress, andsenderaddress. - deadlineNanos() - Method in interface io.netty5.channel.IoExecutionContext
-
Returns the absolute point in time at which the next closest scheduled task should run or
-1if nothing is scheduled to run. - deallocate() - Method in class io.netty5.channel.DefaultFileRegion
- DEFAULT - Static variable in class io.netty5.channel.DefaultMessageSizeEstimator
-
Return the default implementation which returns
8for unknown messages. - DEFAULT - Static variable in class io.netty5.channel.WriteBufferWaterMark
- DEFAULT_EVENT_LOOP_THREADS - Static variable in class io.netty5.channel.MultithreadEventLoopGroup
- DEFAULT_MAX_PENDING_TASKS - Static variable in class io.netty5.channel.SingleThreadEventLoop
- DEFAULT_MAX_TASKS_PER_RUN - Static variable in class io.netty5.channel.SingleThreadEventLoop
- DefaultAbstractChannelPipeline(AbstractChannel<?, ?, ?>) - Constructor for class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- DefaultAddressedEnvelope<M,A extends SocketAddress> - Class in io.netty5.channel
-
The default
AddressedEnvelopeimplementation. - DefaultAddressedEnvelope(M, A) - Constructor for class io.netty5.channel.DefaultAddressedEnvelope
-
Creates a new instance with the specified
messageandrecipientaddress. - DefaultAddressedEnvelope(M, A, A) - Constructor for class io.netty5.channel.DefaultAddressedEnvelope
-
Creates a new instance with the specified
message,recipientaddress, andsenderaddress. - DefaultBufferAddressedEnvelope<A extends SocketAddress> - Class in io.netty5.channel
-
The default
AddressedEnvelopeimplementation forBuffermessages. - DefaultBufferAddressedEnvelope(Buffer, A) - Constructor for class io.netty5.channel.DefaultBufferAddressedEnvelope
-
Creates a new instance with the specified
messageandrecipientaddress. - DefaultBufferAddressedEnvelope(Buffer, A, A) - Constructor for class io.netty5.channel.DefaultBufferAddressedEnvelope
-
Creates a new instance with the specified
message,recipientaddress, andsenderaddress. - DefaultChannelGroup - Class in io.netty5.channel.group
-
The default
ChannelGroupimplementation. - DefaultChannelGroup(EventExecutor) - Constructor for class io.netty5.channel.group.DefaultChannelGroup
-
Creates a new group with a generated name and the provided
EventExecutorto notify theChannelGroupFutures. - DefaultChannelGroup(EventExecutor, boolean) - Constructor for class io.netty5.channel.group.DefaultChannelGroup
-
Creates a new group with a generated name and the provided
EventExecutorto notify theChannelGroupFutures. - DefaultChannelGroup(String, EventExecutor) - Constructor for class io.netty5.channel.group.DefaultChannelGroup
- DefaultChannelGroup(String, EventExecutor, boolean) - Constructor for class io.netty5.channel.group.DefaultChannelGroup
- DefaultChannelId - Class in io.netty5.channel
-
The default
ChannelIdimplementation. - DefaultChannelPipeline - Class in io.netty5.channel
-
The default
ChannelPipelineimplementation. - DefaultChannelPipeline(Channel) - Constructor for class io.netty5.channel.DefaultChannelPipeline
- DefaultFileRegion - Class in io.netty5.channel
- DefaultFileRegion(File, long, long) - Constructor for class io.netty5.channel.DefaultFileRegion
-
Create a new instance using the given
File. - DefaultFileRegion(FileChannel, long, long) - Constructor for class io.netty5.channel.DefaultFileRegion
-
Create a new instance
- DefaultMessageSizeEstimator - Class in io.netty5.channel
-
Default
MessageSizeEstimatorimplementation which supports the estimation of the size ofBufferandFileRegion. - DefaultMessageSizeEstimator(int) - Constructor for class io.netty5.channel.DefaultMessageSizeEstimator
-
Create a new instance
- DefaultSelectStrategyFactory - Class in io.netty5.channel
-
Factory which uses the default select strategy.
- delayNanos(long) - Method in interface io.netty5.channel.IoExecutionContext
-
Returns the amount of time left until the scheduled task with the closest deadline should run.
- DelegatingChannelHandlerContext - Class in io.netty5.channel.internal
- DelegatingChannelHandlerContext(ChannelHandlerContext) - Constructor for class io.netty5.channel.internal.DelegatingChannelHandlerContext
- delegatingCtx() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- deregister() - Method in interface io.netty5.channel.Channel
- deregister() - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Request to deregister from the previous assigned
EventExecutorand notify theFutureonce the operation completes, either because the operation was successful or because of an error. - deregister() - Method in class io.netty5.channel.DefaultChannelPipeline
- deregister() - Method in interface io.netty5.channel.group.ChannelGroup
-
Deprecated.This method will be removed in the next major feature release. Deregister all
Channels in this group from theirEventLoop. Please note that this operation is asynchronous asChannel.deregister()is. - deregister() - Method in class io.netty5.channel.group.DefaultChannelGroup
- deregister() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- deregister(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
-
Called once a deregister operation is made from the current registered
EventLoop. - deregister(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- deregister(ChannelMatcher) - Method in interface io.netty5.channel.group.ChannelGroup
-
Deprecated.This method will be removed in the next major feature release. Deregister all
Channels in this group from theirEventLoopthat are matched by the givenChannelMatcher. Please note that this operation is asynchronous asChannel.deregister()is. - deregister(ChannelMatcher) - Method in class io.netty5.channel.group.DefaultChannelGroup
- deregister(IoHandle) - Method in interface io.netty5.channel.IoHandler
-
Deregister a
IoHandlefor IO. - deregister(IoHandle) - Method in class io.netty5.channel.local.LocalHandler
- deregister(IoHandle) - Method in class io.netty5.channel.nio.NioHandler
- deregisterForIo(IoHandle) - Method in interface io.netty5.channel.EventLoop
- deregisterForIo(IoHandle) - Method in class io.netty5.channel.SingleThreadEventLoop
- deregisterTransport(Promise<Void>) - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- deregisterTransport(Promise<Void>) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Deregister the transport of the
EventLoopand notify thePromiseonce the operation was completed. - deregisterTransportNow() - Method in class io.netty5.channel.local.LocalChannel
- deregisterTransportNow() - Method in class io.netty5.channel.local.LocalServerChannel
- destroy() - Method in interface io.netty5.channel.IoHandler
-
Destroy the
IoHandlerand free all its resources. - destroy() - Method in class io.netty5.channel.local.LocalHandler
- destroy() - Method in class io.netty5.channel.nio.NioHandler
- disconnect() - Method in interface io.netty5.channel.Channel
- disconnect() - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Request to disconnect from the remote peer and notify the
Futureonce the operation completes, either because the operation was successful or because of an error. - disconnect() - Method in class io.netty5.channel.DefaultChannelPipeline
- disconnect() - Method in class io.netty5.channel.embedded.EmbeddedChannel
- disconnect() - Method in interface io.netty5.channel.group.ChannelGroup
-
Disconnects all
Channels in this group from their remote peers. - disconnect() - Method in class io.netty5.channel.group.DefaultChannelGroup
- disconnect() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- disconnect(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
-
Called once a disconnect operation is made.
- disconnect(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- disconnect(ChannelMatcher) - Method in interface io.netty5.channel.group.ChannelGroup
-
Disconnects all
Channels in this group from their remote peers, that are matched by the givenChannelMatcher. - disconnect(ChannelMatcher) - Method in class io.netty5.channel.group.DefaultChannelGroup
- disconnectTransport(Promise<Void>) - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- disconnectTransport(Promise<Void>) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Disconnect the transport and notify the
Promiseonce the operation was completed. - doBind(SocketAddress) - Method in class io.netty5.channel.AbstractChannel
-
Bind the
Channelto theSocketAddress - doBind(SocketAddress) - Method in class io.netty5.channel.embedded.EmbeddedChannel
- doBind(SocketAddress) - Method in class io.netty5.channel.local.LocalChannel
- doBind(SocketAddress) - Method in class io.netty5.channel.local.LocalServerChannel
- doBind(SocketAddress) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- doBind(SocketAddress) - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- doBind(SocketAddress) - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- doClearScheduledRead() - Method in class io.netty5.channel.AbstractChannel
-
Clear any previous scheduled read.
- doClearScheduledRead() - Method in class io.netty5.channel.nio.AbstractNioChannel
- doClose() - Method in class io.netty5.channel.AbstractChannel
-
Close the
Channel - doClose() - Method in class io.netty5.channel.embedded.EmbeddedChannel
- doClose() - Method in class io.netty5.channel.local.LocalChannel
- doClose() - Method in class io.netty5.channel.local.LocalServerChannel
- doClose() - Method in class io.netty5.channel.nio.AbstractNioChannel
- doConnect(SocketAddress, SocketAddress, Buffer) - Method in class io.netty5.channel.AbstractChannel
-
Connect to remote peer.
- doConnect(SocketAddress, SocketAddress, Buffer) - Method in class io.netty5.channel.AbstractServerChannel
- doConnect(SocketAddress, SocketAddress, Buffer) - Method in class io.netty5.channel.embedded.EmbeddedChannel
- doConnect(SocketAddress, SocketAddress, Buffer) - Method in class io.netty5.channel.local.LocalChannel
- doConnect(SocketAddress, SocketAddress, Buffer) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- doConnect(SocketAddress, SocketAddress, Buffer) - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- doConnect(SocketAddress, SocketAddress, Buffer) - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- doDisconnect() - Method in class io.netty5.channel.AbstractChannel
-
Disconnect this
Channelfrom its remote peer - doDisconnect() - Method in class io.netty5.channel.AbstractServerChannel
- doDisconnect() - Method in class io.netty5.channel.embedded.EmbeddedChannel
- doDisconnect() - Method in class io.netty5.channel.local.LocalChannel
- doDisconnect() - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- doDisconnect() - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- doDisconnect() - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- doFinishConnect(LocalAddress) - Method in class io.netty5.channel.local.LocalChannel
- doFinishConnect(SocketAddress) - Method in class io.netty5.channel.embedded.EmbeddedChannel
- doFinishConnect(SocketAddress) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- doFinishConnect(SocketAddress) - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- doFinishConnect(SocketAddress) - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- doFinishConnect(R) - Method in class io.netty5.channel.AbstractChannel
-
Finish a connect request.
- doFinishConnect(R) - Method in class io.netty5.channel.AbstractServerChannel
- DomainSocketAddress - Class in io.netty5.channel.socket
-
An address for a Unix Domain Socket.
- DomainSocketAddress(File) - Constructor for class io.netty5.channel.socket.DomainSocketAddress
- DomainSocketAddress(String) - Constructor for class io.netty5.channel.socket.DomainSocketAddress
- doRead(boolean) - Method in class io.netty5.channel.AbstractChannel
-
Schedule a read operation.
- doRead(boolean) - Method in class io.netty5.channel.embedded.EmbeddedChannel
- doRead(boolean) - Method in class io.netty5.channel.local.LocalChannel
- doRead(boolean) - Method in class io.netty5.channel.local.LocalServerChannel
- doRead(boolean) - Method in class io.netty5.channel.nio.AbstractNioChannel
- doReadBytes(Buffer) - Method in class io.netty5.channel.nio.AbstractNioByteChannel
-
Read bytes into the given
Bufferand return the amount. - doReadBytes(Buffer) - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- doReadMessages(AbstractChannel.ReadSink) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- doReadMessages(AbstractChannel.ReadSink) - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- doReadMessages(AbstractChannel.ReadSink) - Method in class io.netty5.channel.nio.AbstractNioMessageChannel
-
Read messages into the given array and return the amount which was read.
- doReadNow(AbstractChannel.ReadSink) - Method in class io.netty5.channel.embedded.EmbeddedChannel
- doReadNow(AbstractChannel.ReadSink) - Method in class io.netty5.channel.local.LocalServerChannel
- doReadNow(AbstractChannel.ReadSink) - Method in class io.netty5.channel.local.LocalChannel
- doReadNow(AbstractChannel.ReadSink) - Method in class io.netty5.channel.AbstractChannel
-
Try to read a message from the transport and dispatch it via
AbstractChannel.ReadSink.processRead(int, int, Object). - doReadNow(AbstractChannel.ReadSink) - Method in class io.netty5.channel.nio.AbstractNioByteChannel
- doReadNow(AbstractChannel.ReadSink) - Method in class io.netty5.channel.nio.AbstractNioMessageChannel
- doShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.AbstractChannel
-
Shutdown one direction of the
Channel. - doShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.AbstractServerChannel
- doShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.embedded.EmbeddedChannel
- doShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.local.LocalChannel
- doShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- doShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- doShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- doWriteBytes(Buffer) - Method in class io.netty5.channel.nio.AbstractNioByteChannel
-
Write bytes form the given
Bufferto the underlyingChannel. - doWriteBytes(Buffer) - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- doWriteFileRegion(FileRegion) - Method in class io.netty5.channel.nio.AbstractNioByteChannel
-
Write a
FileRegion - doWriteFileRegion(FileRegion) - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- doWriteNow(AbstractChannel.WriteSink) - Method in class io.netty5.channel.embedded.EmbeddedChannel
- doWriteNow(AbstractChannel.WriteSink) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- doWriteNow(AbstractChannel.WriteSink) - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- doWriteNow(AbstractChannel.WriteSink) - Method in class io.netty5.channel.local.LocalChannel
- doWriteNow(AbstractChannel.WriteSink) - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- doWriteNow(AbstractChannel.WriteSink) - Method in class io.netty5.channel.AbstractChannel
-
Called in a loop when writes should be performed until this method returns
falseor there are no more messages to write. - doWriteNow(AbstractChannel.WriteSink) - Method in class io.netty5.channel.AbstractServerChannel
- doWriteNow(AbstractChannel.WriteSink) - Method in class io.netty5.channel.nio.AbstractNioByteChannel
E
- EmbeddedChannel - Class in io.netty5.channel.embedded
-
Base class for
Channelimplementations that are used in an embedded fashion. - EmbeddedChannel() - Constructor for class io.netty5.channel.embedded.EmbeddedChannel
-
Create a new instance with an
EmbeddedChannelIdand an empty pipeline. - EmbeddedChannel(boolean, boolean, ChannelHandler...) - Constructor for class io.netty5.channel.embedded.EmbeddedChannel
-
Create a new instance with the pipeline initialized with the specified handlers.
- EmbeddedChannel(boolean, ChannelHandler...) - Constructor for class io.netty5.channel.embedded.EmbeddedChannel
-
Create a new instance with the pipeline initialized with the specified handlers.
- EmbeddedChannel(ChannelHandler...) - Constructor for class io.netty5.channel.embedded.EmbeddedChannel
-
Create a new instance with the pipeline initialized with the specified handlers.
- EmbeddedChannel(ChannelId) - Constructor for class io.netty5.channel.embedded.EmbeddedChannel
-
Create a new instance with the specified ID and an empty pipeline.
- EmbeddedChannel(ChannelId, boolean, boolean, ChannelHandler...) - Constructor for class io.netty5.channel.embedded.EmbeddedChannel
-
Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
- EmbeddedChannel(ChannelId, boolean, ChannelHandler...) - Constructor for class io.netty5.channel.embedded.EmbeddedChannel
-
Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
- EmbeddedChannel(ChannelId, ChannelHandler...) - Constructor for class io.netty5.channel.embedded.EmbeddedChannel
-
Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
- EmbeddedChannel(Channel, ChannelId, boolean, boolean, ChannelHandler...) - Constructor for class io.netty5.channel.embedded.EmbeddedChannel
-
Create a new instance with the channel ID set to the given ID and the pipeline initialized with the specified handlers.
- ensureOpen() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Ensure the
Channelis open and if not throw an exception. - equals(Object) - Method in class io.netty5.channel.AbstractChannel
-
Returns
trueif and only if the specified object is identical with this channel (i.e:this == o). - equals(Object) - Method in class io.netty5.channel.DefaultChannelId
- equals(Object) - Method in class io.netty5.channel.group.DefaultChannelGroup
- equals(Object) - Method in class io.netty5.channel.local.LocalAddress
- equals(Object) - Method in class io.netty5.channel.socket.DomainSocketAddress
- estimatedBufferCapacity() - Method in interface io.netty5.channel.ReadHandleFactory.ReadHandle
-
Guess the capacity for the next receive buffer that is probably large enough to read all inbound data and small enough not to waste its space.
- estimatedMaxBytesPerGatheringWrite() - Method in class io.netty5.channel.AbstractChannel.WriteSink
-
Return the estimated maximum number of bytes that can be written with one gathering write operation.
- estimatedMaxBytesPerGatheringWrite() - Method in interface io.netty5.channel.WriteHandleFactory.WriteHandle
-
Estimate the maximum number of bytes that can be written with one gathering write operation.
- EventLoop - Interface in io.netty5.channel
-
Will handle all the I/O operations for a
IoHandleonce registered. - EventLoopGroup - Interface in io.netty5.channel
-
Special
EventExecutorGroupwhich allows registeringIoHandles that get processed for later selection during the event loop. - eventReceived(ChannelHandlerContext, I) - Method in class io.netty5.channel.SimpleUserEventChannelHandler
-
Is called for each user event triggered of type
SimpleUserEventChannelHandler. - exact(int) - Static method in interface io.netty5.channel.ReadBufferAllocator
- executor() - Method in class io.netty5.channel.AbstractChannel
- executor() - Method in interface io.netty5.channel.Channel
- executor() - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Returns the
EventExecutorthat is used to execute the operations of thisChannelOutboundInvoker. - executor() - Method in class io.netty5.channel.DefaultChannelPipeline
- executor() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- exists(String) - Static method in class io.netty5.channel.ChannelOption
F
- FileRegion - Interface in io.netty5.channel
-
A region of a file that is sent via a
Channelwhich supports zero-copy file transfer. - filterOutboundMessage(Object) - Method in class io.netty5.channel.AbstractChannel
-
Invoked when a new message is added to to the outbound queue of this
AbstractChannel, so that theChannelimplementation converts the message to another. - filterOutboundMessage(Object) - Method in class io.netty5.channel.AbstractServerChannel
- filterOutboundMessage(Object) - Method in class io.netty5.channel.nio.AbstractNioByteChannel
- filterOutboundMessage(Object) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- filterOutboundMessage(Object) - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- find(Channel) - Method in interface io.netty5.channel.group.ChannelGroupFuture
-
Returns the
Futureof the individual I/O operation which is associated with the specifiedChannel. - find(ChannelId) - Method in interface io.netty5.channel.group.ChannelGroup
- find(ChannelId) - Method in class io.netty5.channel.group.DefaultChannelGroup
- finish() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Mark this
Channelas finished. - finishAndReleaseAll() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Mark this
Channelas finished and release all pending message in the inbound and outbound buffer. - finishConnect() - Method in class io.netty5.channel.AbstractChannel
-
Should be called once the connect request is ready to be completed and
AbstractChannel.isConnectPending()istrue. - FIRE_EXCEPTION_ON_FAILURE - Static variable in class io.netty5.channel.ChannelFutureListeners
- fireChannelActive() - Method in interface io.netty5.channel.ChannelHandlerContext
- fireChannelActive() - Method in interface io.netty5.channel.ChannelInboundInvoker
-
A
Channelis active now, which means it is connected. - fireChannelActive() - Method in interface io.netty5.channel.ChannelPipeline
- fireChannelActive() - Method in class io.netty5.channel.DefaultChannelPipeline
- fireChannelActive() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- fireChannelExceptionCaught(Throwable) - Method in interface io.netty5.channel.ChannelHandlerContext
- fireChannelExceptionCaught(Throwable) - Method in interface io.netty5.channel.ChannelInboundInvoker
- fireChannelExceptionCaught(Throwable) - Method in interface io.netty5.channel.ChannelPipeline
- fireChannelExceptionCaught(Throwable) - Method in class io.netty5.channel.DefaultChannelPipeline
- fireChannelExceptionCaught(Throwable) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- fireChannelInactive() - Method in interface io.netty5.channel.ChannelHandlerContext
- fireChannelInactive() - Method in interface io.netty5.channel.ChannelInboundInvoker
-
A
Channelis inactive now, which means it is closed. - fireChannelInactive() - Method in interface io.netty5.channel.ChannelPipeline
- fireChannelInactive() - Method in class io.netty5.channel.DefaultChannelPipeline
- fireChannelInactive() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- fireChannelInboundEvent(Object) - Method in interface io.netty5.channel.ChannelHandlerContext
- fireChannelInboundEvent(Object) - Method in interface io.netty5.channel.ChannelInboundInvoker
-
A
Channelreceived a custom defined inbound event. - fireChannelInboundEvent(Object) - Method in interface io.netty5.channel.ChannelPipeline
- fireChannelInboundEvent(Object) - Method in class io.netty5.channel.DefaultChannelPipeline
- fireChannelInboundEvent(Object) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- fireChannelRead(Object) - Method in interface io.netty5.channel.ChannelHandlerContext
- fireChannelRead(Object) - Method in interface io.netty5.channel.ChannelInboundInvoker
-
A
Channelreceived a message. - fireChannelRead(Object) - Method in interface io.netty5.channel.ChannelPipeline
- fireChannelRead(Object) - Method in class io.netty5.channel.DefaultChannelPipeline
- fireChannelRead(Object) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- fireChannelReadComplete() - Method in interface io.netty5.channel.ChannelHandlerContext
- fireChannelReadComplete() - Method in interface io.netty5.channel.ChannelInboundInvoker
-
Triggers an
ChannelHandler.channelReadComplete(ChannelHandlerContext)event to the nextChannelHandlerin theChannelPipeline. - fireChannelReadComplete() - Method in interface io.netty5.channel.ChannelPipeline
- fireChannelReadComplete() - Method in class io.netty5.channel.DefaultChannelPipeline
- fireChannelReadComplete() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- fireChannelRegistered() - Method in interface io.netty5.channel.ChannelHandlerContext
- fireChannelRegistered() - Method in interface io.netty5.channel.ChannelInboundInvoker
- fireChannelRegistered() - Method in interface io.netty5.channel.ChannelPipeline
- fireChannelRegistered() - Method in class io.netty5.channel.DefaultChannelPipeline
- fireChannelRegistered() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- fireChannelShutdown(ChannelShutdownDirection) - Method in interface io.netty5.channel.ChannelHandlerContext
- fireChannelShutdown(ChannelShutdownDirection) - Method in interface io.netty5.channel.ChannelInboundInvoker
-
A
Channelwas shutdown in a specific direction. - fireChannelShutdown(ChannelShutdownDirection) - Method in interface io.netty5.channel.ChannelPipeline
- fireChannelShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.DefaultChannelPipeline
- fireChannelShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- fireChannelUnregistered() - Method in interface io.netty5.channel.ChannelHandlerContext
- fireChannelUnregistered() - Method in interface io.netty5.channel.ChannelInboundInvoker
- fireChannelUnregistered() - Method in interface io.netty5.channel.ChannelPipeline
- fireChannelUnregistered() - Method in class io.netty5.channel.DefaultChannelPipeline
- fireChannelUnregistered() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- fireChannelWritabilityChanged() - Method in interface io.netty5.channel.ChannelHandlerContext
- fireChannelWritabilityChanged() - Method in interface io.netty5.channel.ChannelInboundInvoker
-
Triggers an
ChannelHandler.channelWritabilityChanged(ChannelHandlerContext)event to the nextChannelHandlerin theChannelPipeline. - fireChannelWritabilityChanged() - Method in interface io.netty5.channel.ChannelPipeline
- fireChannelWritabilityChanged() - Method in class io.netty5.channel.DefaultChannelPipeline
- fireChannelWritabilityChanged() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- first() - Method in interface io.netty5.channel.ChannelPipeline
-
Returns the first
ChannelHandlerin this pipeline. - first() - Method in class io.netty5.channel.DefaultChannelPipeline
- firstContext() - Method in interface io.netty5.channel.ChannelPipeline
-
Returns the context of the first
ChannelHandlerin this pipeline. - firstContext() - Method in class io.netty5.channel.DefaultChannelPipeline
- FixedReadHandleFactory - Class in io.netty5.channel
-
The
ReadHandleFactorythat always yields the same buffer size prediction. - FixedReadHandleFactory(int) - Constructor for class io.netty5.channel.FixedReadHandleFactory
-
Creates a new predictor that always returns the same prediction of the specified buffer size.
- FixedReadHandleFactory(int, int) - Constructor for class io.netty5.channel.FixedReadHandleFactory
- flush() - Method in interface io.netty5.channel.Channel
- flush() - Method in interface io.netty5.channel.ChannelHandlerContext
- flush() - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Request to flush all pending messages via this ChannelOutboundInvoker.
- flush() - Method in interface io.netty5.channel.ChannelPipeline
- flush() - Method in class io.netty5.channel.DefaultChannelPipeline
- flush() - Method in interface io.netty5.channel.group.ChannelGroup
-
Flush all
Channels in this group. - flush() - Method in class io.netty5.channel.group.DefaultChannelGroup
- flush() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- flush(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
-
Called once a flush operation is made.
- flush(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- flush(ChannelMatcher) - Method in interface io.netty5.channel.group.ChannelGroup
-
Flush all
Channels in this group that are matched by the givenChannelMatcher. - flush(ChannelMatcher) - Method in class io.netty5.channel.group.DefaultChannelGroup
- flushAndWrite(Object) - Method in interface io.netty5.channel.group.ChannelGroup
-
Deprecated.Use
ChannelGroup.writeAndFlush(Object)instead. - flushAndWrite(Object) - Method in class io.netty5.channel.group.DefaultChannelGroup
- flushAndWrite(Object, ChannelMatcher) - Method in interface io.netty5.channel.group.ChannelGroup
-
Deprecated.Use
ChannelGroup.writeAndFlush(Object, ChannelMatcher)instead. - flushAndWrite(Object, ChannelMatcher) - Method in class io.netty5.channel.group.DefaultChannelGroup
- flushInbound() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Flushes the inbound of this
Channel. - flushOutbound() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Flushes the outbound of this
Channel. - flushTransport() - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- flushTransport() - Method in class io.netty5.channel.DefaultChannelPipeline
-
Flush out all (previous) scheduled write operations, scheduled via
DefaultChannelPipeline.writeTransport(Object, Promise). - forEachFlushedMessage(Predicate<Object>) - Method in class io.netty5.channel.AbstractChannel.WriteSink
-
Call
Predicate.test(Object)for each message that is flushed untilPredicate.test(Object)returnsfalseor there are no more flushed messages. - freezeTime() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Freeze the clock of this channel's event loop.
G
- get(Class<T>) - Method in interface io.netty5.channel.ChannelPipeline
-
Returns the
ChannelHandlerof the specified type in this pipeline. - get(Class<T>) - Method in class io.netty5.channel.DefaultChannelPipeline
- get(String) - Method in interface io.netty5.channel.ChannelPipeline
-
Returns the
ChannelHandlerwith the specified name in this pipeline. - get(String) - Method in class io.netty5.channel.DefaultChannelPipeline
- getExtendedOption(ChannelOption<T>) - Method in class io.netty5.channel.AbstractChannel
-
Override to add support for more
ChannelOptions. - getExtendedOption(ChannelOption<T>) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- getExtendedOption(ChannelOption<T>) - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- getExtendedOption(ChannelOption<T>) - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- getOption(ChannelOption<T>) - Method in class io.netty5.channel.AbstractChannel
- getOption(ChannelOption<T>) - Method in interface io.netty5.channel.Channel
-
Return the value of the given
ChannelOption - group() - Method in class io.netty5.bootstrap.AbstractBootstrap
-
Deprecated.Use
AbstractBootstrap.config()instead. - group() - Method in class io.netty5.bootstrap.AbstractBootstrapConfig
-
Returns the configured
EventLoopGroupornullif non is configured yet. - group() - Method in interface io.netty5.channel.group.ChannelGroupFuture
-
Returns the
ChannelGroupwhich is associated with this future. - group(EventLoopGroup) - Method in class io.netty5.bootstrap.AbstractBootstrap
-
The
EventLoopGroupwhich is used to handle all the events for the to-be-createdChannel - group(EventLoopGroup) - Method in class io.netty5.bootstrap.ServerBootstrap
-
Specify the
EventLoopGroupwhich is used for the parent (acceptor) and the child (client). - group(EventLoopGroup, EventLoopGroup) - Method in class io.netty5.bootstrap.ServerBootstrap
-
Set the
EventLoopGroupfor the parent (acceptor) and the child (client).
H
- handleInboundMessage(Object) - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Called for each inbound message.
- handleOutboundMessage(Object) - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Called for each outbound message.
- handler() - Method in class io.netty5.bootstrap.AbstractBootstrapConfig
-
Returns the configured
ChannelHandlerornullif non is configured yet. - handler() - Method in interface io.netty5.channel.ChannelHandlerContext
-
The
ChannelHandlerthat is bound thisChannelHandlerContext. - handler() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- handler(ChannelHandler) - Method in class io.netty5.bootstrap.AbstractBootstrap
-
the
ChannelHandlerto use for serving the requests. - handlerAdded(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
-
Gets called after the
ChannelHandlerwas added to the actual context and it's ready to handle events. - handlerAdded(ChannelHandlerContext) - Method in class io.netty5.channel.ChannelInitializer
-
Gets called after the
ChannelHandlerwas added to the actual context and it's ready to handle events. - handlerAdded(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- handlerRemoved(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
-
Gets called after the
ChannelHandlerwas removed from the actual context and it doesn't handle events anymore. - handlerRemoved(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- hashCode() - Method in class io.netty5.channel.AbstractChannel
-
Returns the ID of this channel.
- hashCode() - Method in class io.netty5.channel.DefaultChannelId
- hashCode() - Method in class io.netty5.channel.group.DefaultChannelGroup
- hashCode() - Method in class io.netty5.channel.local.LocalAddress
- hashCode() - Method in class io.netty5.channel.socket.DomainSocketAddress
- hasPendingTasks() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Check whether this channel has any pending tasks that would be executed by a call to
EmbeddedChannel.runPendingTasks(). - high() - Method in class io.netty5.channel.WriteBufferWaterMark
-
Returns the high water mark for the write buffer.
I
- id() - Method in class io.netty5.channel.AbstractChannel
- id() - Method in interface io.netty5.channel.Channel
-
Returns the globally unique identifier of this
Channel. - id() - Method in class io.netty5.channel.local.LocalAddress
-
Returns the ID of this address.
- Inbound - io.netty5.channel.ChannelShutdownDirection
-
The inbound direction of a
Channelwas or should be shutdown. - inboundHandler() - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- inboundMessages() - Method in class io.netty5.channel.embedded.EmbeddedChannel
- INET - io.netty5.channel.socket.SocketProtocolFamily
-
IPv4
- INET6 - io.netty5.channel.socket.SocketProtocolFamily
-
IPv6
- init(I, O) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
-
Initialized this handler with the specified handlers.
- initChannel(C) - Method in class io.netty5.channel.ChannelInitializer
-
This method will be called once the
Channelwas registered. - INSTANCE - Static variable in class io.netty5.channel.DefaultSelectStrategyFactory
- invert(ChannelMatcher) - Static method in class io.netty5.channel.group.ChannelMatchers
-
Invert the given
ChannelMatcher. - io.netty5.bootstrap - package 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 - package 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 - package io.netty5.channel.embedded
-
A virtual
Channelthat helps wrapping a series of handlers to unit test the handlers or use them in non-I/O context. - io.netty5.channel.group - package 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 - package io.netty5.channel.internal
-
Internal utilities for channel implementations.
- io.netty5.channel.local - package io.netty5.channel.local
-
A virtual transport that enables the communication between the two parties in the same virtual machine.
- io.netty5.channel.nio - package io.netty5.channel.nio
-
NIO-based channel API implementation - recommended for a large number of connections (>= 1000).
- io.netty5.channel.socket - package io.netty5.channel.socket
-
Abstract TCP and UDP socket interfaces which extend the core channel API.
- io.netty5.channel.socket.nio - package io.netty5.channel.socket.nio
-
NIO-based socket channel API implementation - recommended for a large number of connections (>= 1000).
- io.netty5.transport - module io.netty5.transport
- IoExecutionContext - Interface in io.netty5.channel
-
The execution context for an
IoHandler. - IoHandle - Interface in io.netty5.channel
-
A handle that will process I/O.
- IoHandler - Interface in io.netty5.channel
-
Handles IO dispatching for an
EventLoopAll operations exceptIoHandler.wakeup(boolean)andIoHandler.isCompatible(Class)MUST be executed on theEventLoopthread and should never be called from the user-directly. - IoHandlerFactory - Interface in io.netty5.channel
-
Factory for
IoHandlerinstances. - IP_MULTICAST_IF - Static variable in class io.netty5.channel.ChannelOption
- IP_MULTICAST_LOOP_DISABLED - Static variable in class io.netty5.channel.ChannelOption
- IP_MULTICAST_TTL - Static variable in class io.netty5.channel.ChannelOption
- IP_TOS - Static variable in class io.netty5.channel.ChannelOption
- is(Channel) - Static method in class io.netty5.channel.group.ChannelMatchers
-
Returns a
ChannelMatcherthat matches the givenChannel. - isAccessible() - Method in class io.netty5.channel.BufferAddressedEnvelope
- isActive() - Method in interface io.netty5.channel.Channel
-
Return
trueif theChannelis active and so connected. - isActive() - Method in class io.netty5.channel.embedded.EmbeddedChannel
- isActive() - Method in class io.netty5.channel.local.LocalChannel
- isActive() - Method in class io.netty5.channel.local.LocalServerChannel
- isActive() - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- isActive() - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- isActive() - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- isCompatible(Class<? extends IoHandle>) - Method in interface io.netty5.channel.EventLoop
- isCompatible(Class<? extends IoHandle>) - Method in interface io.netty5.channel.EventLoopGroup
-
Returns
trueif the given type is compatible with thisEventLoopGroupand so can be registered to the containedEventLoops,falseotherwise. - isCompatible(Class<? extends IoHandle>) - Method in interface io.netty5.channel.IoHandler
-
Returns
trueif the given type is compatible with thisIoHandlerand so can be registered,falseotherwise. - isCompatible(Class<? extends IoHandle>) - Method in class io.netty5.channel.local.LocalHandler
- isCompatible(Class<? extends IoHandle>) - Method in class io.netty5.channel.nio.NioHandler
- isCompatible(Class<? extends IoHandle>) - Method in class io.netty5.channel.SingleThreadEventLoop
- isConnected() - Method in interface io.netty5.channel.socket.DatagramChannel
-
Return
trueif theDatagramChannelis connected to the remote peer. - isConnected() - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- isConnectPending() - Method in class io.netty5.channel.AbstractChannel
-
Returns if a connect operation was issued before, and
AbstractChannel.finishConnect()must be called once the connect operation can be finished. - isEmpty() - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Are there pending buffers in the queue.
- isEmpty() - Method in interface io.netty5.channel.ChannelPipeline
- isEmpty() - Method in class io.netty5.channel.group.DefaultChannelGroup
- isEmpty() - Method in class io.netty5.channel.PendingWriteQueue
-
Returns
trueif there are no pending write operations left in this queue. - isExtendedOptionSupported(ChannelOption<?>) - Method in class io.netty5.channel.AbstractChannel
-
Override to add support for more
ChannelOptions. - isExtendedOptionSupported(ChannelOption<?>) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- isExtendedOptionSupported(ChannelOption<?>) - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- isExtendedOptionSupported(ChannelOption<?>) - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- isInstanceOf(Class<? extends Channel>) - Static method in class io.netty5.channel.group.ChannelMatchers
-
Returns a
ChannelMatcherthat matches allChannels that are an instance of sub-type of the given class. - isNonServerChannel() - Static method in class io.netty5.channel.group.ChannelMatchers
- isNot(Channel) - Static method in class io.netty5.channel.group.ChannelMatchers
-
Returns a
ChannelMatcherthat matches allChannels except the given. - isNotInstanceOf(Class<? extends Channel>) - Static method in class io.netty5.channel.group.ChannelMatchers
-
Returns a
ChannelMatcherthat matches allChannels that are not an instance of sub-type of the given class. - isOpen() - Method in interface io.netty5.channel.Channel
-
Returns
trueif theChannelis open and may get active later - isOpen() - Method in class io.netty5.channel.DefaultFileRegion
-
Returns
trueif theFileRegionhas a open file-descriptor - isOpen() - Method in class io.netty5.channel.embedded.EmbeddedChannel
- isOpen() - Method in class io.netty5.channel.local.LocalChannel
- isOpen() - Method in class io.netty5.channel.local.LocalServerChannel
- isOpen() - Method in class io.netty5.channel.nio.AbstractNioChannel
- isOptionSupported(ChannelOption<?>) - Method in class io.netty5.channel.AbstractChannel
- isOptionSupported(ChannelOption<?>) - Method in interface io.netty5.channel.Channel
- isPartialFailure() - Method in interface io.netty5.channel.group.ChannelGroupFuture
-
Returns
trueif and only if the I/O operations associated with this future have failed partially with some success. - isPartialSuccess() - Method in interface io.netty5.channel.group.ChannelGroupFuture
-
Returns
trueif and only if the I/O operations associated with this future were partially successful with some failure. - isReadPending() - Method in class io.netty5.channel.AbstractChannel
-
Returns
trueif a read is currently scheduled and pending for later execution. - isRegistered() - Method in class io.netty5.channel.AbstractChannel
- isRegistered() - Method in interface io.netty5.channel.IoHandle
-
Return true if registered already.
- isRegistered() - Method in class io.netty5.channel.nio.NioSelectableChannelHandle
- isRemoved() - Method in interface io.netty5.channel.ChannelHandlerContext
-
Return
trueif theChannelHandlerwhich belongs to this context was removed from theChannelPipeline. - isRemoved() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- isServerChannel() - Static method in class io.netty5.channel.group.ChannelMatchers
- isSharable() - Method in interface io.netty5.channel.ChannelHandler
-
Returns
trueif this handler is sharable and thus can be added to more than oneChannelPipeline. - isSharable() - Method in class io.netty5.channel.ChannelInitializer
- isSharable() - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- isShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.AbstractServerChannel
- isShutdown(ChannelShutdownDirection) - Method in interface io.netty5.channel.Channel
- isShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.embedded.EmbeddedChannel
- isShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.local.LocalChannel
- isShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- isShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- isShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- isSuccess() - Method in interface io.netty5.channel.group.ChannelGroupFuture
-
Returns
trueif and only if all I/O operations associated with this future were successful without any failure. - isSupportingDisconnect() - Method in class io.netty5.channel.AbstractChannel
-
Returns
trueif the implementation supports disconnecting and re-connecting,falseotherwise. - isTransportSupportingDisconnect() - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- isTransportSupportingDisconnect() - Method in class io.netty5.channel.DefaultChannelPipeline
-
Returns
trueif and only if the transport has thedisconnect()operation that allows a user to disconnect and then connect again. - isWritable() - Method in interface io.netty5.channel.Channel
-
Returns
trueif and only if the I/O thread will perform the requested flush operation immediately. - isWriteFlushedScheduled() - Method in class io.netty5.channel.AbstractChannel
-
Returns
trueif flushed messages should not be tried to write when callingChannel.flush(). - isWriteFlushedScheduled() - Method in class io.netty5.channel.nio.AbstractNioChannel
- iterator() - Method in class io.netty5.channel.DefaultChannelPipeline
- iterator() - Method in exception io.netty5.channel.group.ChannelGroupException
- iterator() - Method in interface io.netty5.channel.group.ChannelGroupFuture
-
Returns the
Iteratorthat enumerates allFutures which are associated with this future. - iterator() - Method in class io.netty5.channel.group.DefaultChannelGroup
J
- javaChannel() - Method in class io.netty5.channel.nio.AbstractNioChannel
- javaChannel() - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- javaChannel() - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- javaChannel() - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- joinGroup(InetAddress) - Method in interface io.netty5.channel.socket.DatagramChannel
-
Joins a multicast group and notifies the
Futureonce the operation completes. - joinGroup(InetAddress) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- joinGroup(InetAddress, NetworkInterface, InetAddress) - Method in interface io.netty5.channel.socket.DatagramChannel
-
Joins the specified multicast group at the specified interface and notifies the
Futureonce the operation completes. - joinGroup(InetAddress, NetworkInterface, InetAddress) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
L
- last() - Method in interface io.netty5.channel.ChannelPipeline
-
Returns the last
ChannelHandlerin this pipeline. - last() - Method in class io.netty5.channel.DefaultChannelPipeline
- lastContext() - Method in interface io.netty5.channel.ChannelPipeline
-
Returns the context of the last
ChannelHandlerin this pipeline. - lastContext() - Method in class io.netty5.channel.DefaultChannelPipeline
- lastRead(int, int, int) - Method in class io.netty5.channel.MaxMessagesReadHandleFactory.MaxMessageReadHandle
- lastRead(int, int, int) - Method in interface io.netty5.channel.ReadHandleFactory.ReadHandle
-
Notify the
ReadHandleFactory.ReadHandleof the last read operation and its result. - lastWrite(long, long, int) - Method in class io.netty5.channel.MaxMessagesWriteHandleFactory.MaxMessagesWriteHandle
- lastWrite(long, long, int) - Method in interface io.netty5.channel.WriteHandleFactory.WriteHandle
-
Notify the
WriteHandleFactory.WriteHandleof the last write operation and its result. - leaveGroup(InetAddress) - Method in interface io.netty5.channel.socket.DatagramChannel
-
Leaves a multicast group and notifies the
Futureonce the operation completes. - leaveGroup(InetAddress) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- leaveGroup(InetAddress, NetworkInterface, InetAddress) - Method in interface io.netty5.channel.socket.DatagramChannel
-
Leave the specified multicast group at the specified interface using the specified source and notifies the
Futureonce the operation completes. - leaveGroup(InetAddress, NetworkInterface, InetAddress) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- localAddress() - Method in class io.netty5.bootstrap.AbstractBootstrapConfig
-
Returns the configured local address or
nullif non is configured yet. - localAddress() - Method in class io.netty5.channel.AbstractChannel
- localAddress() - Method in interface io.netty5.channel.Channel
-
Returns the local address where this channel is bound to.
- localAddress(int) - Method in class io.netty5.bootstrap.AbstractBootstrap
- localAddress(String, int) - Method in class io.netty5.bootstrap.AbstractBootstrap
- localAddress(InetAddress, int) - Method in class io.netty5.bootstrap.AbstractBootstrap
- localAddress(SocketAddress) - Method in class io.netty5.bootstrap.AbstractBootstrap
-
The
SocketAddresswhich is used to bind the local "end" to. - LocalAddress - Class in io.netty5.channel.local
-
An endpoint in the local transport.
- LocalAddress(Class<?>) - Constructor for class io.netty5.channel.local.LocalAddress
-
Creates a new instance with a random ID based on the given class.
- LocalAddress(String) - Constructor for class io.netty5.channel.local.LocalAddress
-
Creates a new instance with the specified ID.
- localAddress0() - Method in class io.netty5.channel.AbstractChannel
-
Returns the
SocketAddresswhich is bound locally. - localAddress0() - Method in class io.netty5.channel.embedded.EmbeddedChannel
- localAddress0() - Method in class io.netty5.channel.local.LocalChannel
- localAddress0() - Method in class io.netty5.channel.local.LocalServerChannel
- localAddress0() - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- localAddress0() - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- localAddress0() - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- LocalChannel - Class in io.netty5.channel.local
-
A
Channelfor the local transport. - LocalChannel(EventLoop) - Constructor for class io.netty5.channel.local.LocalChannel
- LocalChannel(LocalServerChannel, EventLoop, LocalChannel) - Constructor for class io.netty5.channel.local.LocalChannel
- LocalHandler - Class in io.netty5.channel.local
- LocalServerChannel - Class in io.netty5.channel.local
-
A
ServerChannelfor the local transport which allows in VM communication. - LocalServerChannel(EventLoop, EventLoopGroup) - Constructor for class io.netty5.channel.local.LocalServerChannel
- low() - Method in class io.netty5.channel.WriteBufferWaterMark
-
Returns the low water mark for the write buffer.
M
- matches(Channel) - Method in interface io.netty5.channel.group.ChannelMatcher
-
Returns
trueif the operation should be also executed on the givenChannel. - MAX_MESSAGES_PER_WRITE - Static variable in class io.netty5.channel.ChannelOption
- MaxMessageReadHandle(int) - Constructor for class io.netty5.channel.MaxMessagesReadHandleFactory.MaxMessageReadHandle
- MaxMessagesReadHandleFactory - Class in io.netty5.channel
-
Base implementation of
ReadHandleFactorywhich allows to limit the number of messages read per read loop. - MaxMessagesReadHandleFactory() - Constructor for class io.netty5.channel.MaxMessagesReadHandleFactory
- MaxMessagesReadHandleFactory(int) - Constructor for class io.netty5.channel.MaxMessagesReadHandleFactory
- MaxMessagesReadHandleFactory.MaxMessageReadHandle - Class in io.netty5.channel
-
Focuses on enforcing the maximum messages per read condition for
MaxMessagesReadHandleFactory.MaxMessageReadHandle.lastRead(int, int, int). - MaxMessagesWriteHandle(int) - Constructor for class io.netty5.channel.MaxMessagesWriteHandleFactory.MaxMessagesWriteHandle
- MaxMessagesWriteHandleFactory - Class in io.netty5.channel
- MaxMessagesWriteHandleFactory(int) - Constructor for class io.netty5.channel.MaxMessagesWriteHandleFactory
- MaxMessagesWriteHandleFactory.MaxMessagesWriteHandle - Class in io.netty5.channel
- MESSAGE_SIZE_ESTIMATOR - Static variable in class io.netty5.channel.ChannelOption
- messageReceived(ChannelHandlerContext, I) - Method in class io.netty5.channel.SimpleChannelInboundHandler
-
Is called for each message of type
SimpleChannelInboundHandler. - MessageSizeEstimator - Interface in io.netty5.channel
-
Responsible to estimate the size of a message.
- MessageSizeEstimator.Handle - Interface in io.netty5.channel
- MultithreadEventLoopGroup - Class in io.netty5.channel
-
EventLoopGroupimplementation that will handle its tasks with multiple threads. - MultithreadEventLoopGroup(int, IoHandlerFactory) - Constructor for class io.netty5.channel.MultithreadEventLoopGroup
-
Create a new instance.
- MultithreadEventLoopGroup(int, Executor, IoHandlerFactory) - Constructor for class io.netty5.channel.MultithreadEventLoopGroup
-
Create a new instance.
- MultithreadEventLoopGroup(int, Executor, IoHandlerFactory, int, RejectedExecutionHandler) - Constructor for class io.netty5.channel.MultithreadEventLoopGroup
-
Create a new instance.
- MultithreadEventLoopGroup(int, Executor, IoHandlerFactory, int, RejectedExecutionHandler, int) - Constructor for class io.netty5.channel.MultithreadEventLoopGroup
-
Create a new instance.
- MultithreadEventLoopGroup(int, Executor, IoHandlerFactory, int, RejectedExecutionHandler, int, Object...) - Constructor for class io.netty5.channel.MultithreadEventLoopGroup
-
Create a new instance.
- MultithreadEventLoopGroup(int, ThreadFactory, IoHandlerFactory) - Constructor for class io.netty5.channel.MultithreadEventLoopGroup
-
Create a new instance.
- MultithreadEventLoopGroup(int, ThreadFactory, IoHandlerFactory, int, RejectedExecutionHandler) - Constructor for class io.netty5.channel.MultithreadEventLoopGroup
-
Create a new instance.
- MultithreadEventLoopGroup(int, ThreadFactory, IoHandlerFactory, int, RejectedExecutionHandler, int) - Constructor for class io.netty5.channel.MultithreadEventLoopGroup
-
Create a new instance.
- MultithreadEventLoopGroup(int, ThreadFactory, IoHandlerFactory, int, RejectedExecutionHandler, int, Object...) - Constructor for class io.netty5.channel.MultithreadEventLoopGroup
-
Create a new instance.
- MultithreadEventLoopGroup(IoHandlerFactory) - Constructor for class io.netty5.channel.MultithreadEventLoopGroup
-
Create a new instance.
- MultithreadEventLoopGroup(Executor, IoHandlerFactory) - Constructor for class io.netty5.channel.MultithreadEventLoopGroup
-
Create a new instance.
- MultithreadEventLoopGroup(ThreadFactory, IoHandlerFactory) - Constructor for class io.netty5.channel.MultithreadEventLoopGroup
-
Create a new instance.
N
- name() - Method in interface io.netty5.channel.ChannelHandlerContext
-
The unique name of the
ChannelHandlerContext.The name was used when thenChannelHandlerwas added to theChannelPipeline. - name() - Method in interface io.netty5.channel.group.ChannelGroup
-
Returns the name of this group.
- name() - Method in class io.netty5.channel.group.DefaultChannelGroup
- name() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- names() - Method in interface io.netty5.channel.ChannelPipeline
-
Returns the
Listof the handler names. - names() - Method in class io.netty5.channel.DefaultChannelPipeline
- newChannel(EventLoop) - Method in interface io.netty5.channel.ChannelFactory
-
Creates a new channel.
- newChannel(EventLoop) - Method in class io.netty5.channel.ReflectiveChannelFactory
- newChannel(EventLoop, EventLoopGroup) - Method in class io.netty5.channel.ReflectiveServerChannelFactory
- newChannel(EventLoop, EventLoopGroup) - Method in interface io.netty5.channel.ServerChannelFactory
-
Creates a new channel.
- newChannelPipeline() - Method in class io.netty5.channel.AbstractChannel
-
Returns a new
ChannelPipelineinstance. - newChannelPipeline() - Method in class io.netty5.channel.embedded.EmbeddedChannel
- newChild(Executor, int, RejectedExecutionHandler, IoHandler, int, Object...) - Method in class io.netty5.channel.MultithreadEventLoopGroup
-
Creates a new
EventLoopto use. - newChild(Executor, int, RejectedExecutionHandler, Object...) - Method in class io.netty5.channel.MultithreadEventLoopGroup
- newCloseFuture() - Method in interface io.netty5.channel.group.ChannelGroup
-
Returns the
ChannelGroupFuturewhich will be notified when allChannels that are part of thisChannelGroup, at the time of calling, are closed. - newCloseFuture() - Method in class io.netty5.channel.group.DefaultChannelGroup
- newCloseFuture(ChannelMatcher) - Method in interface io.netty5.channel.group.ChannelGroup
-
Returns the
ChannelGroupFuturewhich will be notified when allChannels that are part of thisChannelGroup, at the time of calling, are closed. - newCloseFuture(ChannelMatcher) - Method in class io.netty5.channel.group.DefaultChannelGroup
- newDirectBuffer(Buffer) - Method in class io.netty5.channel.nio.AbstractNioChannel
-
Allocates a new off-heap copy of the given buffer, unless the cost of doing so is too high.
- newDirectBuffer(Resource<?>, Buffer) - Method in class io.netty5.channel.nio.AbstractNioChannel
-
Allocates a new off-heap copy of the given buffer, unless the cost of doing so is too high.
- newFactory() - Static method in class io.netty5.channel.local.LocalHandler
-
Returns a new
IoHandlerFactorythat createsLocalHandlerinstances. - newFactory() - Static method in class io.netty5.channel.nio.NioHandler
-
Returns a new
IoHandlerFactorythat createsNioHandlerinstances. - newFactory(SelectorProvider, SelectStrategyFactory) - Static method in class io.netty5.channel.nio.NioHandler
-
Returns a new
IoHandlerFactorythat createsNioHandlerinstances. - newFailedFuture(Throwable) - Method in interface io.netty5.channel.ChannelOutboundInvoker
- newFailedFuture(Throwable) - Method in class io.netty5.channel.DefaultChannelPipeline
- newFailedFuture(Throwable) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- newHandle() - Method in class io.netty5.channel.DefaultMessageSizeEstimator
- newHandle() - Method in interface io.netty5.channel.MessageSizeEstimator
-
Creates a new handle.
- newHandle(Channel) - Method in class io.netty5.channel.MaxMessagesReadHandleFactory
- newHandle(Channel) - Method in class io.netty5.channel.MaxMessagesWriteHandleFactory
- newHandle(Channel) - Method in interface io.netty5.channel.ReadHandleFactory
-
Creates a new handle for the given
Channel. - newHandle(Channel) - Method in class io.netty5.channel.ServerChannelWriteHandleFactory
- newHandle(Channel) - Method in interface io.netty5.channel.WriteHandleFactory
-
Creates a new handle for the given
Channel. - newHandle(Channel, int) - Method in class io.netty5.channel.MaxMessagesWriteHandleFactory
- newHandle(Channel, int) - Method in class io.netty5.channel.socket.SocketChannelWriteHandleFactory
- newHandler() - Method in interface io.netty5.channel.IoHandlerFactory
-
Creates a new
IoHandlerinstance. - newInstance() - Static method in class io.netty5.channel.DefaultChannelId
-
Returns a new
DefaultChannelIdinstance. - newInstance(String) - Static method in class io.netty5.channel.ChannelOption
-
Deprecated.
- newLocalChannel(LocalChannel) - Method in class io.netty5.channel.local.LocalServerChannel
-
A factory method for
LocalChannels. - newMaxMessageHandle(int) - Method in class io.netty5.channel.AdaptiveReadHandleFactory
- newMaxMessageHandle(int) - Method in class io.netty5.channel.FixedReadHandleFactory
- newMaxMessageHandle(int) - Method in class io.netty5.channel.MaxMessagesReadHandleFactory
-
Creates a new
MaxMessagesReadHandleFactory.MaxMessageReadHandleto use. - newMaxMessageHandle(int) - Method in class io.netty5.channel.ServerChannelReadHandleFactory
- newPromise() - Method in interface io.netty5.channel.ChannelOutboundInvoker
- newPromise() - Method in class io.netty5.channel.DefaultChannelPipeline
- newPromise() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- newSelectStrategy() - Method in class io.netty5.channel.DefaultSelectStrategyFactory
- newSelectStrategy() - Method in interface io.netty5.channel.SelectStrategyFactory
-
Creates a new
SelectStrategy. - newSucceededFuture() - Method in interface io.netty5.channel.ChannelOutboundInvoker
- newSucceededFuture() - Method in class io.netty5.channel.DefaultChannelPipeline
- newSucceededFuture() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- newSucceededFuture(V) - Method in interface io.netty5.channel.ChannelOutboundInvoker
- newSucceededFuture(V) - Method in class io.netty5.channel.DefaultChannelPipeline
- newSucceededFuture(V) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- newSupportedIdentityOptionsSet(ChannelOption<?>...) - Static method in class io.netty5.channel.AbstractChannel
-
Creates a new
Setthat holds the givenChannelOptions. - newTaskQueue(int) - Method in class io.netty5.channel.SingleThreadEventLoop
- next() - Method in interface io.netty5.channel.EventLoop
- next() - Method in interface io.netty5.channel.EventLoopGroup
-
Return the next
EventLoopto use - next() - Method in class io.netty5.channel.MultithreadEventLoopGroup
- NioChannelOption<T> - Class in io.netty5.channel.socket.nio
-
Provides
ChannelOptionover a givenSocketOptionwhich is then passed through the underlyingNetworkChannel. - NioDatagramChannel - Class in io.netty5.channel.socket.nio
-
An NIO
DatagramChannelthat sends and receives anAddressedEnvelope. - NioDatagramChannel(EventLoop) - Constructor for class io.netty5.channel.socket.nio.NioDatagramChannel
-
Create a new instance which will use the Operation Systems default
ProtocolFamily. - NioDatagramChannel(EventLoop, ProtocolFamily) - Constructor for class io.netty5.channel.socket.nio.NioDatagramChannel
-
Create a new instance using the given
ProtocolFamily. - NioDatagramChannel(EventLoop, DatagramChannel, ProtocolFamily) - Constructor for class io.netty5.channel.socket.nio.NioDatagramChannel
-
Create a new instance from the given
DatagramChannel. - NioDatagramChannel(EventLoop, SelectorProvider) - Constructor for class io.netty5.channel.socket.nio.NioDatagramChannel
-
Create a new instance using the given
SelectorProviderwhich will use the Operation Systems defaultProtocolFamily. - NioDatagramChannel(EventLoop, SelectorProvider, ProtocolFamily) - Constructor for class io.netty5.channel.socket.nio.NioDatagramChannel
-
Create a new instance using the given
SelectorProviderandProtocolFamily. - NioHandler - Class in io.netty5.channel.nio
- NioSelectableChannelHandle<S extends SelectableChannel> - Class in io.netty5.channel.nio
-
Allows to create an
IoHandlefor aSelectableChannel, not necessarily created by Netty. - NioSelectableChannelHandle(S, int, BiConsumer<S, SelectionKey>) - Constructor for class io.netty5.channel.nio.NioSelectableChannelHandle
- NioServerSocketChannel - Class in io.netty5.channel.socket.nio
-
A
ServerSocketChannelimplementation which uses NIO selector based implementation to accept new connections. - NioServerSocketChannel(EventLoop, EventLoopGroup) - Constructor for class io.netty5.channel.socket.nio.NioServerSocketChannel
-
Create a new instance
- NioServerSocketChannel(EventLoop, EventLoopGroup, ServerSocketChannel) - Constructor for class io.netty5.channel.socket.nio.NioServerSocketChannel
-
Create a new instance using the given
ServerSocketChannel. - NioServerSocketChannel(EventLoop, EventLoopGroup, ServerSocketChannel, ProtocolFamily) - Constructor for class io.netty5.channel.socket.nio.NioServerSocketChannel
-
Create a new instance using the given
ServerSocketChannel. - NioServerSocketChannel(EventLoop, EventLoopGroup, SelectorProvider) - Constructor for class io.netty5.channel.socket.nio.NioServerSocketChannel
-
Create a new instance using the given
SelectorProvider. - NioServerSocketChannel(EventLoop, EventLoopGroup, SelectorProvider, ProtocolFamily) - Constructor for class io.netty5.channel.socket.nio.NioServerSocketChannel
-
Create a new instance using the given
SelectorProviderand protocol family (supported only since JDK 15). - NioSocketChannel - Class in io.netty5.channel.socket.nio
-
SocketChannelwhich uses NIO selector based implementation. - NioSocketChannel(EventLoop) - Constructor for class io.netty5.channel.socket.nio.NioSocketChannel
-
Create a new instance
- NioSocketChannel(EventLoop, SocketChannel) - Constructor for class io.netty5.channel.socket.nio.NioSocketChannel
-
Create a new instance using the given
SocketChannel. - NioSocketChannel(EventLoop, SelectorProvider) - Constructor for class io.netty5.channel.socket.nio.NioSocketChannel
-
Create a new instance using the given
SelectorProvider. - NioSocketChannel(EventLoop, SelectorProvider, ProtocolFamily) - Constructor for class io.netty5.channel.socket.nio.NioSocketChannel
-
Create a new instance using the given
SelectorProviderand protocol family (supported only since JDK 15). - NioSocketChannel(NioServerSocketChannel, EventLoop, SocketChannel) - Constructor for class io.netty5.channel.socket.nio.NioSocketChannel
-
Create a new instance
- NioSocketChannel(NioServerSocketChannel, EventLoop, SocketChannel, ProtocolFamily) - Constructor for class io.netty5.channel.socket.nio.NioSocketChannel
-
Create a new instance
- numFlushedMessages() - Method in class io.netty5.channel.AbstractChannel.WriteSink
-
The number of flushed messages that are ready to be written.
O
- of(ProtocolFamily) - Static method in enum io.netty5.channel.socket.SocketProtocolFamily
-
Return the
SocketProtocolFamilyfor the givenProtocolFamilyif possible. - of(SocketOption<T>) - Static method in class io.netty5.channel.socket.nio.NioChannelOption
-
Returns a
ChannelOptionfor the givenSocketOption. - onUnhandledChannelInboundEvent(Object) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Called once an user event hit the end of the
ChannelPipelinewithout been handled by the user inChannelHandler.channelInboundEvent(ChannelHandlerContext, Object). - onUnhandledChannelWritabilityChanged() - Method in class io.netty5.channel.DefaultChannelPipeline
-
Called once the
ChannelHandler.channelWritabilityChanged(ChannelHandlerContext)event hit the end of theChannelPipeline. - onUnhandledInboundChannelActive() - Method in class io.netty5.channel.DefaultChannelPipeline
-
Called once the
ChannelHandler.channelActive(ChannelHandlerContext)event hit the end of theChannelPipeline. - onUnhandledInboundChannelInactive() - Method in class io.netty5.channel.DefaultChannelPipeline
-
Called once the
ChannelHandler.channelInactive(ChannelHandlerContext)event hit the end of theChannelPipeline. - onUnhandledInboundChannelReadComplete() - Method in class io.netty5.channel.DefaultChannelPipeline
-
Called once the
ChannelHandler.channelReadComplete(ChannelHandlerContext)event hit the end of theChannelPipeline. - onUnhandledInboundChannelShutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Called once the
ChannelHandler.channelShutdown(ChannelHandlerContext, ChannelShutdownDirection)event hit the end of theChannelPipeline. - onUnhandledInboundException(Throwable) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Called once a
Throwablehit the end of theChannelPipelinewithout been handled by the user inChannelHandler.channelExceptionCaught(ChannelHandlerContext, Throwable). - onUnhandledInboundMessage(ChannelHandlerContext, Object) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Called once a message hit the end of the
ChannelPipelinewithout been handled by the user inChannelHandler.channelRead(ChannelHandlerContext, Object). - open() - Method in class io.netty5.channel.DefaultFileRegion
-
Explicitly open the underlying file-descriptor if not done yet.
- option(ChannelOption<T>, T) - Method in class io.netty5.bootstrap.AbstractBootstrap
-
Allow to specify a
ChannelOptionwhich is used for theChannelinstances once they got created. - options() - Method in class io.netty5.bootstrap.AbstractBootstrapConfig
-
Returns a copy of the configured options.
- Outbound - io.netty5.channel.ChannelShutdownDirection
-
The outbound direction of a
Channelwas or should be shutdown. - outboundHandler() - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- outboundMessages() - Method in class io.netty5.channel.embedded.EmbeddedChannel
P
- parent() - Method in class io.netty5.channel.AbstractChannel
- parent() - Method in interface io.netty5.channel.Channel
-
Returns the parent of this channel.
- parent() - Method in interface io.netty5.channel.socket.SocketChannel
- path() - Method in class io.netty5.channel.socket.DomainSocketAddress
-
The path to the domain socket.
- pendingOutboundBytes() - Method in interface io.netty5.channel.ChannelPipeline
-
The number of the outbound bytes that are buffered / queued in this
ChannelPipeline. - pendingOutboundBytes() - Method in class io.netty5.channel.DefaultChannelPipeline
- pendingOutboundBytes(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
-
The number of the outbound bytes that are buffered / queued in this
ChannelHandler. - pendingOutboundBytes(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- pendingOutboundBytesUpdated(long) - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- pendingOutboundBytesUpdated(long) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Called once the
DefaultChannelPipeline.pendingOutboundBytes()were changed. - PendingWriteQueue - Class in io.netty5.channel
-
A queue of write operations which are pending for later execution.
- PendingWriteQueue(EventExecutor, MessageSizeEstimator.Handle) - Constructor for class io.netty5.channel.PendingWriteQueue
- pickThreadCount(int) - Static method in class io.netty5.channel.MultithreadEventLoopGroup
-
Return the number of threads to use based on the given
nThreads. - pipeline() - Method in class io.netty5.channel.AbstractChannel
- pipeline() - Method in interface io.netty5.channel.Channel
-
Return the assigned
ChannelPipeline. - pipeline() - Method in interface io.netty5.channel.ChannelHandlerContext
-
Return the assigned
ChannelPipeline - pipeline() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- position() - Method in class io.netty5.channel.DefaultFileRegion
- position() - Method in interface io.netty5.channel.FileRegion
-
Returns the offset in the file where the transfer began.
- prepareToClose() - Method in class io.netty5.channel.AbstractChannel
-
Prepares to close the
Channel. - prepareToClose() - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- prepareToDestroy() - Method in interface io.netty5.channel.IoHandler
-
Prepare to destroy this
IoHandler. - prepareToDestroy() - Method in class io.netty5.channel.local.LocalHandler
- prepareToDestroy() - Method in class io.netty5.channel.nio.NioHandler
- processRead(int, int, Object) - Method in class io.netty5.channel.AbstractChannel.ReadSink
-
Process the read message and fire it through the
ChannelPipeline
R
- read() - Method in interface io.netty5.channel.Channel
- read() - Method in interface io.netty5.channel.ChannelHandlerContext
- read() - Method in interface io.netty5.channel.ChannelOutboundInvoker
- read() - Method in interface io.netty5.channel.ChannelPipeline
- read() - Method in class io.netty5.channel.DefaultChannelPipeline
- read() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- read(ChannelHandlerContext, ReadBufferAllocator) - Method in interface io.netty5.channel.ChannelHandler
-
Called once a read operation is made from the current registered
EventLoop. - read(ChannelHandlerContext, ReadBufferAllocator) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- read(ReadBufferAllocator) - Method in interface io.netty5.channel.Channel
- read(ReadBufferAllocator) - Method in interface io.netty5.channel.ChannelHandlerContext
- read(ReadBufferAllocator) - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Request to read data from the
Channel, triggers anChannelHandler.channelRead(ChannelHandlerContext, Object)event if data was read, and triggers achannelReadCompleteevent so the handler can decide to continue reading. - read(ReadBufferAllocator) - Method in interface io.netty5.channel.ChannelPipeline
- read(ReadBufferAllocator) - Method in class io.netty5.channel.DefaultChannelPipeline
- read(ReadBufferAllocator) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- READ_HANDLE_FACTORY - Static variable in class io.netty5.channel.ChannelOption
- readableBytes() - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
The number of readable bytes.
- readBufferAllocator() - Method in class io.netty5.channel.AbstractChannel
-
Return the
BufferAllocatorthat is used to allocateBufferthat are used for reading. - ReadBufferAllocator - Interface in io.netty5.channel
-
Implementations of this interface can influence how
Buffers are allocated that are used when reading from the transport. - readComplete() - Method in class io.netty5.channel.MaxMessagesReadHandleFactory.MaxMessageReadHandle
- readComplete() - Method in interface io.netty5.channel.ReadHandleFactory.ReadHandle
-
Method that must be called once the read loop was completed.
- readHandle() - Method in class io.netty5.channel.AbstractChannel
- ReadHandleFactory - Interface in io.netty5.channel
-
Implementations allow to influence how much data / messages are read per read loop invocation.
- ReadHandleFactory.ReadHandle - Interface in io.netty5.channel
-
Handle which allows to customize how data / messages are read.
- readIfIsAutoRead() - Method in class io.netty5.channel.AbstractChannel
- readInbound() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Return received data from this
Channel - readLoopComplete() - Method in class io.netty5.channel.AbstractChannel
-
Called once the read loop completed for this Channel.
- readNow() - Method in class io.netty5.channel.AbstractChannel
-
Reading from the underlying transport now until there is nothing more to read or the
ReadHandleFactory.ReadHandleis telling us to stop. - readOutbound() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Read data from the outbound.
- readTransport(ReadBufferAllocator) - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- readTransport(ReadBufferAllocator) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Schedules a read operation on the transport that fills the inbound buffer of the first
ChannelHandlerin theChannelPipeline. - recipient() - Method in interface io.netty5.channel.AddressedEnvelope
-
Returns the address of the recipient of this message.
- recipient() - Method in class io.netty5.channel.DefaultAddressedEnvelope
- ReflectiveChannelFactory<T extends Channel> - Class in io.netty5.channel
-
A
ChannelFactorythat instantiates a newChannelby invoking its default constructor reflectively. - ReflectiveChannelFactory(Class<? extends T>) - Constructor for class io.netty5.channel.ReflectiveChannelFactory
- ReflectiveServerChannelFactory<T extends ServerChannel> - Class in io.netty5.channel
-
A
ChannelFactorythat instantiates a newServerChannelby invoking its default constructor reflectively. - ReflectiveServerChannelFactory(Class<? extends T>) - Constructor for class io.netty5.channel.ReflectiveServerChannelFactory
- register() - Method in class io.netty5.bootstrap.AbstractBootstrap
- register() - Method in interface io.netty5.channel.Channel
- register() - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Request to register on the
EventExecutorfor I/O processing. - register() - Method in class io.netty5.channel.DefaultChannelPipeline
- register() - Method in class io.netty5.channel.embedded.EmbeddedChannel
- register() - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- register(ChannelHandlerContext) - Method in interface io.netty5.channel.ChannelHandler
-
Called once a register operation is made to register for IO on the
EventLoop. - register(ChannelHandlerContext) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- register(IoHandle) - Method in interface io.netty5.channel.IoHandler
-
Register a
Channelfor IO. - register(IoHandle) - Method in class io.netty5.channel.local.LocalHandler
- register(IoHandle) - Method in class io.netty5.channel.nio.NioHandler
- registerForIo(IoHandle) - Method in interface io.netty5.channel.EventLoop
- registerForIo(IoHandle) - Method in class io.netty5.channel.SingleThreadEventLoop
- registerTransport(Promise<Void>) - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- registerTransport(Promise<Void>) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Register the transport and notify the
Promiseonce the operation was completed. - registerTransportNow() - Method in class io.netty5.channel.local.LocalChannel
- registerTransportNow() - Method in class io.netty5.channel.local.LocalServerChannel
- releaseAndFailAll(ChannelOutboundInvoker, Throwable) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Release all buffers in the queue and complete all listeners and promises.
- releaseAndFailAll(Throwable) - Method in class io.netty5.channel.CoalescingBufferQueue
-
Release all buffers in the queue and complete all listeners and promises.
- releaseInbound() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Release all buffered inbound messages and return
trueif any were in the inbound buffer,falseotherwise. - releaseOutbound() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Release all buffered outbound messages and return
trueif any were in the outbound buffer,falseotherwise. - remoteAddress() - Method in class io.netty5.bootstrap.BootstrapConfig
-
Returns the configured remote address or
nullif non is configured yet. - remoteAddress() - Method in class io.netty5.channel.AbstractChannel
- remoteAddress() - Method in interface io.netty5.channel.Channel
-
Returns the remote address where this channel is connected to.
- remoteAddress(String, int) - Method in class io.netty5.bootstrap.Bootstrap
- remoteAddress(InetAddress, int) - Method in class io.netty5.bootstrap.Bootstrap
- remoteAddress(SocketAddress) - Method in class io.netty5.bootstrap.Bootstrap
-
The
SocketAddressto connect to once theBootstrap.connect()method is called. - remoteAddress0() - Method in class io.netty5.channel.AbstractChannel
-
Return the
SocketAddresswhich theChannelis connected to. - remoteAddress0() - Method in class io.netty5.channel.AbstractServerChannel
- remoteAddress0() - Method in class io.netty5.channel.embedded.EmbeddedChannel
- remoteAddress0() - Method in class io.netty5.channel.local.LocalChannel
- remoteAddress0() - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- remoteAddress0() - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- remoteAddress0() - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- remove() - Method in class io.netty5.channel.PendingWriteQueue
-
Removes a pending write operation and release its message via
Resource.dispose(Object). - remove(int, Promise<Void>) - Method in class io.netty5.channel.CoalescingBufferQueue
-
Remove a
Bufferfrom the queue with the specified number of bytes. - remove(BufferAllocator, int, Promise<Void>) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Remove a
Bufferfrom the queue with the specified number of bytes. - remove(ChannelHandler) - Method in interface io.netty5.channel.ChannelPipeline
-
Removes the specified
ChannelHandlerfrom this pipeline. - remove(ChannelHandler) - Method in class io.netty5.channel.DefaultChannelPipeline
- remove(Class<T>) - Method in interface io.netty5.channel.ChannelPipeline
-
Removes the
ChannelHandlerof the specified type from this pipeline. - remove(Class<T>) - Method in class io.netty5.channel.DefaultChannelPipeline
- remove(Object) - Method in class io.netty5.channel.group.DefaultChannelGroup
- remove(String) - Method in interface io.netty5.channel.ChannelPipeline
-
Removes the
ChannelHandlerwith the specified name from this pipeline. - remove(String) - Method in class io.netty5.channel.DefaultChannelPipeline
- removeAndFail(Throwable) - Method in class io.netty5.channel.PendingWriteQueue
-
Remove a pending write operation and fail it with the given
Throwable. - removeAndFailAll(Throwable) - Method in class io.netty5.channel.PendingWriteQueue
-
Remove all pending write operation and fail them with the given
Throwable. - removeAndTransfer(Function<Object, Future<Void>>) - Method in class io.netty5.channel.PendingWriteQueue
-
Removes a pending write operation and performs it via
Function.apply(Object). - removeAndTransferAll(Function<Object, Future<Void>>) - Method in class io.netty5.channel.PendingWriteQueue
-
Remove all pending write operation and performs them via
Function.apply(Object). - removeEmptyValue() - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
The value to return when
AbstractCoalescingBufferQueue.remove(BufferAllocator, int, Promise)is called but the queue is empty. - removeEmptyValue() - Method in class io.netty5.channel.CoalescingBufferQueue
- removeFirst() - Method in interface io.netty5.channel.ChannelPipeline
-
Removes the first
ChannelHandlerin this pipeline. - removeFirst() - Method in class io.netty5.channel.DefaultChannelPipeline
- removeFirst(Promise<Void>) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Remove the first
Bufferfrom the queue. - removeIfExists(ChannelHandler) - Method in interface io.netty5.channel.ChannelPipeline
-
Removes the specified
ChannelHandlerfrom this pipeline if it exists - removeIfExists(ChannelHandler) - Method in class io.netty5.channel.DefaultChannelPipeline
- removeIfExists(Class<T>) - Method in interface io.netty5.channel.ChannelPipeline
-
Removes the
ChannelHandlerof the specified type from this pipeline if it exists. - removeIfExists(Class<T>) - Method in class io.netty5.channel.DefaultChannelPipeline
- removeIfExists(String) - Method in interface io.netty5.channel.ChannelPipeline
-
Removes the
ChannelHandlerwith the specified name from this pipeline if it exists. - removeIfExists(String) - Method in class io.netty5.channel.DefaultChannelPipeline
- removeInboundHandler() - Method in class io.netty5.channel.CombinedChannelDuplexHandler
-
Removes the inbound
ChannelHandlerthat was combined in thisCombinedChannelDuplexHandler. - removeLast() - Method in interface io.netty5.channel.ChannelPipeline
-
Removes the last
ChannelHandlerin this pipeline. - removeLast() - Method in class io.netty5.channel.DefaultChannelPipeline
- removeOutboundHandler() - Method in class io.netty5.channel.CombinedChannelDuplexHandler
-
Removes the outbound
ChannelHandlerthat was combined in thisCombinedChannelDuplexHandler. - replace(Buffer) - Method in class io.netty5.channel.BufferAddressedEnvelope
-
Create a new addressed envelope instance, that has the same recipient and sender as this one, but the given content.
- replace(Buffer) - Method in class io.netty5.channel.DefaultBufferAddressedEnvelope
- replace(Buffer) - Method in class io.netty5.channel.socket.DatagramPacket
- replace(ChannelHandler, String, ChannelHandler) - Method in interface io.netty5.channel.ChannelPipeline
-
Replaces the specified
ChannelHandlerwith a new handler in this pipeline. - replace(ChannelHandler, String, ChannelHandler) - Method in class io.netty5.channel.DefaultChannelPipeline
- replace(Class<T>, String, ChannelHandler) - Method in interface io.netty5.channel.ChannelPipeline
-
Replaces the
ChannelHandlerof the specified type with a new handler in this pipeline. - replace(Class<T>, String, ChannelHandler) - Method in class io.netty5.channel.DefaultChannelPipeline
- replace(String, String, ChannelHandler) - Method in interface io.netty5.channel.ChannelPipeline
-
Replaces the
ChannelHandlerof the specified name with a new handler in this pipeline. - replace(String, String, ChannelHandler) - Method in class io.netty5.channel.DefaultChannelPipeline
- resolver() - Method in class io.netty5.bootstrap.BootstrapConfig
-
Returns the configured
AddressResolverGroupor the default if non is configured yet. - resolver(AddressResolverGroup<?>) - Method in class io.netty5.bootstrap.Bootstrap
-
Sets the
NameResolverwhich will resolve the address of the unresolved named address. - retain() - Method in class io.netty5.channel.DefaultFileRegion
- retain() - Method in interface io.netty5.channel.FileRegion
- retain(int) - Method in class io.netty5.channel.DefaultFileRegion
- retain(int) - Method in interface io.netty5.channel.FileRegion
- run() - Method in class io.netty5.channel.SingleThreadEventLoop
- run(IoExecutionContext) - Method in interface io.netty5.channel.IoHandler
-
Run the IO handled by this
IoHandler. - run(IoExecutionContext) - Method in class io.netty5.channel.local.LocalHandler
- run(IoExecutionContext) - Method in class io.netty5.channel.nio.NioHandler
- runAfterTransportOperation() - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
-
Override to add extra logic after each `*Transport` method call.
- runIO() - Method in class io.netty5.channel.SingleThreadEventLoop
-
Called when IO will be processed for all the
Channels on thisSingleThreadEventLoop. - runPendingTasks() - Method in class io.netty5.channel.embedded.EmbeddedChannel
- runScheduledPendingTasks() - Method in class io.netty5.channel.embedded.EmbeddedChannel
S
- SELECT - Static variable in interface io.netty5.channel.SelectStrategy
-
Indicates a blocking select should follow.
- selectionKey() - Method in class io.netty5.channel.nio.AbstractNioChannel
-
Return the current
SelectionKeyornullif the underlying channel was not registered with theSelectoryet. - selectorProvider() - Method in class io.netty5.channel.nio.NioHandler
- SelectStrategy - Interface in io.netty5.channel
-
Select strategy interface.
- SelectStrategyFactory - Interface in io.netty5.channel
-
Factory that creates a new
SelectStrategyevery time. - send() - Method in class io.netty5.channel.BufferAddressedEnvelope
- sender() - Method in interface io.netty5.channel.AddressedEnvelope
-
Returns the address of the sender of this message.
- sender() - Method in class io.netty5.channel.DefaultAddressedEnvelope
- sendOutboundEvent(ChannelHandlerContext, Object) - Method in interface io.netty5.channel.ChannelHandler
-
Called once a custom defined outbound event was sent.
- sendOutboundEvent(ChannelHandlerContext, Object) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- sendOutboundEvent(Object) - Method in interface io.netty5.channel.Channel
- sendOutboundEvent(Object) - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Send a custom outbound event via this
ChannelOutboundInvokerthrough theChannelPipeline. - sendOutboundEvent(Object) - Method in class io.netty5.channel.DefaultChannelPipeline
- sendOutboundEvent(Object) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- sendOutboundEventTransport(Object, Promise<Void>) - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- sendOutboundEventTransport(Object, Promise<Void>) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Send a custom outbound event on the transport.
- ServerBootstrap - Class in io.netty5.bootstrap
-
Bootstrapsub-class which allows easy bootstrap ofServerChannel - ServerBootstrap() - Constructor for class io.netty5.bootstrap.ServerBootstrap
- ServerBootstrapConfig - Class in io.netty5.bootstrap
-
Exposes the configuration of a
ServerBootstrapConfig. - ServerChannel - Interface in io.netty5.channel
- ServerChannelFactory<T extends ServerChannel> - Interface in io.netty5.channel
-
Creates a new
ServerChannel. - ServerChannelReadHandleFactory - Class in io.netty5.channel
-
MaxMessagesReadHandleFactoryimplementation which should be used forServerChannels. - ServerChannelReadHandleFactory() - Constructor for class io.netty5.channel.ServerChannelReadHandleFactory
- ServerChannelReadHandleFactory(int) - Constructor for class io.netty5.channel.ServerChannelReadHandleFactory
- ServerChannelWriteHandleFactory - Class in io.netty5.channel
- ServerChannelWriteHandleFactory() - Constructor for class io.netty5.channel.ServerChannelWriteHandleFactory
- ServerSocketChannel - Interface in io.netty5.channel.socket
-
A Socket
ServerChannelwhich accepts incoming Socket connections. - setExtendedOption(ChannelOption<T>, T) - Method in class io.netty5.channel.AbstractChannel
-
Override to add support for more
ChannelOptions. - setExtendedOption(ChannelOption<T>, T) - Method in class io.netty5.channel.socket.nio.NioDatagramChannel
- setExtendedOption(ChannelOption<T>, T) - Method in class io.netty5.channel.socket.nio.NioServerSocketChannel
- setExtendedOption(ChannelOption<T>, T) - Method in class io.netty5.channel.socket.nio.NioSocketChannel
- setOption(ChannelOption<T>, T) - Method in class io.netty5.channel.AbstractChannel
- setOption(ChannelOption<T>, T) - Method in interface io.netty5.channel.Channel
-
Sets a configuration property with the specified name and value.
- shutdown(ChannelHandlerContext, ChannelShutdownDirection) - Method in interface io.netty5.channel.ChannelHandler
-
Called once a shutdown operation was requested and should be executed.
- shutdown(ChannelHandlerContext, ChannelShutdownDirection) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- shutdown(ChannelShutdownDirection) - Method in interface io.netty5.channel.Channel
- shutdown(ChannelShutdownDirection) - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Request shutdown one direction of the
Channeland notify theFutureonce the operation completes, either because the operation was successful or because of an error. - shutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.DefaultChannelPipeline
- shutdown(ChannelShutdownDirection) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- shutdownReadSide() - Method in class io.netty5.channel.AbstractChannel
-
Shutdown the read side of this channel.
- shutdownTransport(ChannelShutdownDirection, Promise<Void>) - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- shutdownTransport(ChannelShutdownDirection, Promise<Void>) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Shutdown the given direction of the transport and notify the
Promiseonce the operation was completed. - SimpleChannelInboundHandler<I> - Class in io.netty5.channel
-
ChannelHandlerwhich allows to explicit only handle a specific type of messages. - SimpleChannelInboundHandler() - Constructor for class io.netty5.channel.SimpleChannelInboundHandler
-
see
SimpleChannelInboundHandler(boolean)withtrueas boolean parameter. - SimpleChannelInboundHandler(boolean) - Constructor for class io.netty5.channel.SimpleChannelInboundHandler
-
Create a new instance which will try to detect the types to match out of the type parameter of the class.
- SimpleChannelInboundHandler(Class<? extends I>) - Constructor for class io.netty5.channel.SimpleChannelInboundHandler
-
see
SimpleChannelInboundHandler(Class, boolean)withtrueas boolean value. - SimpleChannelInboundHandler(Class<? extends I>, boolean) - Constructor for class io.netty5.channel.SimpleChannelInboundHandler
-
Create a new instance
- SimpleUserEventChannelHandler<I> - Class in io.netty5.channel
-
ChannelHandlerwhich allows to conveniently only handle a specific type of user events. - SimpleUserEventChannelHandler() - Constructor for class io.netty5.channel.SimpleUserEventChannelHandler
-
see
SimpleUserEventChannelHandler(boolean)withtrueas boolean parameter. - SimpleUserEventChannelHandler(boolean) - Constructor for class io.netty5.channel.SimpleUserEventChannelHandler
-
Create a new instance which will try to detect the types to match out of the type parameter of the class.
- SimpleUserEventChannelHandler(Class<? extends I>) - Constructor for class io.netty5.channel.SimpleUserEventChannelHandler
-
see
SimpleUserEventChannelHandler(Class, boolean)withtrueas boolean value. - SimpleUserEventChannelHandler(Class<? extends I>, boolean) - Constructor for class io.netty5.channel.SimpleUserEventChannelHandler
-
Create a new instance
- SingleThreadEventLoop - Class in io.netty5.channel
- SingleThreadEventLoop(Executor, IoHandler) - Constructor for class io.netty5.channel.SingleThreadEventLoop
-
Create a new instance
- SingleThreadEventLoop(Executor, IoHandler, int, RejectedExecutionHandler) - Constructor for class io.netty5.channel.SingleThreadEventLoop
-
Create a new instance
- SingleThreadEventLoop(Executor, IoHandler, int, RejectedExecutionHandler, int) - Constructor for class io.netty5.channel.SingleThreadEventLoop
-
Create a new instance
- SingleThreadEventLoop(ThreadFactory, IoHandler) - Constructor for class io.netty5.channel.SingleThreadEventLoop
-
Create a new instance
- SingleThreadEventLoop(ThreadFactory, IoHandler, int, RejectedExecutionHandler) - Constructor for class io.netty5.channel.SingleThreadEventLoop
-
Create a new instance
- SingleThreadEventLoop(ThreadFactory, IoHandler, int, RejectedExecutionHandler, int) - Constructor for class io.netty5.channel.SingleThreadEventLoop
-
Create a new instance
- size() - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Get the number of elements in this queue added via one of the
AbstractCoalescingBufferQueue.add(Buffer)methods. - size() - Method in class io.netty5.channel.group.DefaultChannelGroup
- size() - Method in class io.netty5.channel.PendingWriteQueue
-
Returns the number of pending write operations.
- size(Object) - Method in interface io.netty5.channel.MessageSizeEstimator.Handle
-
Calculate the size of the given message.
- SO_BACKLOG - Static variable in class io.netty5.channel.ChannelOption
- SO_BROADCAST - Static variable in class io.netty5.channel.ChannelOption
- SO_KEEPALIVE - Static variable in class io.netty5.channel.ChannelOption
- SO_LINGER - Static variable in class io.netty5.channel.ChannelOption
- SO_RCVBUF - Static variable in class io.netty5.channel.ChannelOption
- SO_REUSEADDR - Static variable in class io.netty5.channel.ChannelOption
- SO_SNDBUF - Static variable in class io.netty5.channel.ChannelOption
- SO_TIMEOUT - Static variable in class io.netty5.channel.ChannelOption
- SocketChannel - Interface in io.netty5.channel.socket
-
A Socket
Channel. - SocketChannelWriteHandleFactory - Class in io.netty5.channel.socket
- SocketChannelWriteHandleFactory(int) - Constructor for class io.netty5.channel.socket.SocketChannelWriteHandleFactory
- SocketChannelWriteHandleFactory(int, long) - Constructor for class io.netty5.channel.socket.SocketChannelWriteHandleFactory
- SocketProtocolFamily - Enum in io.netty5.channel.socket
-
ProtocolFamilyimplementation that is used by the different transport implementations.
T
- TCP_FASTOPEN - Static variable in class io.netty5.channel.ChannelOption
-
Server-side TCP FastOpen.
- TCP_FASTOPEN_CONNECT - Static variable in class io.netty5.channel.ChannelOption
-
Client-side TCP FastOpen.
- TCP_NODELAY - Static variable in class io.netty5.channel.ChannelOption
- toArray() - Method in class io.netty5.channel.group.DefaultChannelGroup
- toArray(T[]) - Method in class io.netty5.channel.group.DefaultChannelGroup
- toJdkFamily() - Method in enum io.netty5.channel.socket.SocketProtocolFamily
-
Return a
ProtocolFamilythat is "known" by the JDK itself and represent the same asSocketProtocolFamily. - toMap() - Method in interface io.netty5.channel.ChannelPipeline
-
Converts this pipeline into an ordered
Mapwhose keys are handler names and whose values are handlers. - toMap() - Method in class io.netty5.channel.DefaultChannelPipeline
- toString() - Method in class io.netty5.bootstrap.AbstractBootstrap
- toString() - Method in class io.netty5.bootstrap.AbstractBootstrapConfig
- toString() - Method in class io.netty5.bootstrap.BootstrapConfig
- toString() - Method in class io.netty5.bootstrap.ServerBootstrapConfig
- toString() - Method in class io.netty5.channel.AbstractChannel
-
Returns the
Stringrepresentation of this channel. - toString() - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
- toString() - Method in class io.netty5.channel.DefaultAddressedEnvelope
- toString() - Method in class io.netty5.channel.DefaultChannelId
- toString() - Method in class io.netty5.channel.DefaultChannelPipeline
-
Returns the
Stringrepresentation of this pipeline. - toString() - Method in class io.netty5.channel.group.DefaultChannelGroup
- toString() - Method in class io.netty5.channel.local.LocalAddress
- toString() - Method in class io.netty5.channel.ReflectiveChannelFactory
- toString() - Method in class io.netty5.channel.ReflectiveServerChannelFactory
- toString() - Method in class io.netty5.channel.socket.DomainSocketAddress
- toString() - Method in class io.netty5.channel.WriteBufferWaterMark
- touch() - Method in class io.netty5.channel.DefaultFileRegion
- touch() - Method in interface io.netty5.channel.FileRegion
- touch(Object) - Method in class io.netty5.channel.DefaultBufferAddressedEnvelope
- touch(Object) - Method in class io.netty5.channel.DefaultFileRegion
- touch(Object) - Method in interface io.netty5.channel.FileRegion
- touch(Object) - Method in class io.netty5.channel.socket.DatagramPacket
- transferred() - Method in class io.netty5.channel.DefaultFileRegion
- transferred() - Method in interface io.netty5.channel.FileRegion
-
Returns the bytes which was transferred already.
- transferTo(WritableByteChannel, long) - Method in class io.netty5.channel.DefaultFileRegion
- transferTo(WritableByteChannel, long) - Method in interface io.netty5.channel.FileRegion
-
Transfers the content of this file region to the specified channel.
- transportExecutor() - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- transportExecutor() - Method in class io.netty5.channel.DefaultChannelPipeline
-
Returns the
EventExecutorthat is used for all the abstract transport operations.
U
- unfreezeTime() - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Unfreeze an event loop that was
frozen. - UNIX - io.netty5.channel.socket.SocketProtocolFamily
-
Unix Domain Socket
- updateBufferReaderOffsets(long) - Method in class io.netty5.channel.AbstractChannel.WriteSink
-
Update the
Buffer.readerOffset()of each buffer and return the number of completely writtenBuffers.
V
- validate() - Method in class io.netty5.bootstrap.AbstractBootstrap
-
Validate all the parameters.
- validate() - Method in class io.netty5.bootstrap.Bootstrap
- validate() - Method in class io.netty5.bootstrap.ServerBootstrap
- validate(T) - Method in class io.netty5.channel.ChannelOption
-
Validate the value which is set for the
ChannelOption. - validateEventLoopGroup(T, String, Class<? extends Channel>) - Static method in class io.netty5.channel.AbstractChannel
-
Validate that the
EventLoopGroupsupports the givenchannel type. - validateFileRegion(DefaultFileRegion, long) - Static method in class io.netty5.channel.AbstractChannel
-
Validate a
DefaultFileRegion - valueOf(Class<?>, String) - Static method in class io.netty5.channel.ChannelOption
- valueOf(String) - Static method in class io.netty5.channel.ChannelOption
-
Returns the
ChannelOptionof the specified name. - valueOf(String) - Static method in enum io.netty5.channel.ChannelShutdownDirection
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.netty5.channel.socket.SocketProtocolFamily
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.netty5.channel.ChannelShutdownDirection
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.netty5.channel.socket.SocketProtocolFamily
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- wakesUpForTask(Runnable) - Method in class io.netty5.channel.SingleThreadEventLoop
- wakeup(boolean) - Method in interface io.netty5.channel.IoHandler
-
Wakeup the
IoHandler, which means if any operation blocks it should be unblocked and return as soon as possible. - wakeup(boolean) - Method in class io.netty5.channel.local.LocalHandler
- wakeup(boolean) - Method in class io.netty5.channel.nio.NioHandler
- wakeup(boolean) - Method in class io.netty5.channel.SingleThreadEventLoop
- writableBytes() - Method in class io.netty5.channel.AbstractChannel
- writableBytes() - Method in interface io.netty5.channel.Channel
-
Returns how many bytes can be written before the
Channelbecomes 'unwritable'. - write(ChannelHandlerContext, Object) - Method in interface io.netty5.channel.ChannelHandler
-
Called once a write operation is made.
- write(ChannelHandlerContext, Object) - Method in class io.netty5.channel.CombinedChannelDuplexHandler
- write(Object) - Method in interface io.netty5.channel.Channel
- write(Object) - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Request to write a message via this
ChannelHandlerContextthrough theChannelPipeline. - write(Object) - Method in class io.netty5.channel.DefaultChannelPipeline
- write(Object) - Method in interface io.netty5.channel.group.ChannelGroup
-
Writes the specified
messageto allChannels in this group. - write(Object) - Method in class io.netty5.channel.group.DefaultChannelGroup
- write(Object) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- write(Object, ChannelMatcher) - Method in interface io.netty5.channel.group.ChannelGroup
-
Writes the specified
messageto allChannels in this group that are matched by the givenChannelMatcher. - write(Object, ChannelMatcher) - Method in class io.netty5.channel.group.DefaultChannelGroup
- WRITE_BUFFER_WATER_MARK - Static variable in class io.netty5.channel.ChannelOption
- WRITE_HANDLE_FACTORY - Static variable in class io.netty5.channel.ChannelOption
- writeAndFlush(Object) - Method in interface io.netty5.channel.Channel
- writeAndFlush(Object) - Method in interface io.netty5.channel.ChannelOutboundInvoker
-
Shortcut for call
ChannelOutboundInvoker.write(Object)andChannelOutboundInvoker.flush(). - writeAndFlush(Object) - Method in class io.netty5.channel.DefaultChannelPipeline
- writeAndFlush(Object) - Method in interface io.netty5.channel.group.ChannelGroup
-
Shortcut for calling
ChannelGroup.write(Object)andChannelGroup.flush(). - writeAndFlush(Object) - Method in class io.netty5.channel.group.DefaultChannelGroup
- writeAndFlush(Object) - Method in class io.netty5.channel.internal.DelegatingChannelHandlerContext
- writeAndFlush(Object, ChannelMatcher) - Method in interface io.netty5.channel.group.ChannelGroup
-
Shortcut for calling
ChannelGroup.write(Object)andChannelGroup.flush()and only act onChannels that are matched by theChannelMatcher. - writeAndFlush(Object, ChannelMatcher) - Method in class io.netty5.channel.group.DefaultChannelGroup
- writeAndRemoveAll(ChannelHandlerContext) - Method in class io.netty5.channel.AbstractCoalescingBufferQueue
-
Writes all remaining elements in this queue.
- WriteBufferWaterMark - Class in io.netty5.channel
-
WriteBufferWaterMarkis used to set low water mark and high water mark for the write buffer. - WriteBufferWaterMark(int, int) - Constructor for class io.netty5.channel.WriteBufferWaterMark
-
Create a new instance.
- writeComplete() - Method in class io.netty5.channel.MaxMessagesWriteHandleFactory.MaxMessagesWriteHandle
- writeComplete() - Method in interface io.netty5.channel.WriteHandleFactory.WriteHandle
-
Method that must be called once the write loop was completed.
- writeFlushed() - Method in class io.netty5.channel.AbstractChannel
-
Writing previous flushed messages if
AbstractChannel.isWriteFlushedScheduled()returnsfalse, otherwise do nothing. - writeFlushedNow() - Method in class io.netty5.channel.AbstractChannel
-
Writing previous flushed messages now.
- writeHandle() - Method in class io.netty5.channel.AbstractChannel
- WriteHandleFactory - Interface in io.netty5.channel
-
Implementations allow to influence how much data / messages are written per write loop invocation.
- WriteHandleFactory.WriteHandle - Interface in io.netty5.channel
-
Handle which allows to customize how data / messages are read.
- writeInbound(Object...) - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Write messages to the inbound of this
Channel. - writeLoopComplete(boolean) - Method in class io.netty5.channel.AbstractChannel
-
Called once the write loop completed.
- writeLoopComplete(boolean) - Method in class io.netty5.channel.local.LocalChannel
- writeLoopComplete(boolean) - Method in class io.netty5.channel.nio.AbstractNioChannel
- writeOneInbound(Object) - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Writes one message to the inbound of this
Channeland does not flush it. - writeOneOutbound(Object) - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Writes one message to the outbound of this
Channeland does not flush it. - writeOutbound(Object...) - Method in class io.netty5.channel.embedded.EmbeddedChannel
-
Write messages to the outbound of this
Channel. - writeTransport(Object, Promise<Void>) - Method in class io.netty5.channel.AbstractChannel.DefaultAbstractChannelPipeline
- writeTransport(Object, Promise<Void>) - Method in class io.netty5.channel.DefaultChannelPipeline
-
Schedules a write operation on the transport.
All Classes All Packages