Netty 5.0.0.Alpha5 · io.netty5.channel

Interface Summary

Modifier and Type	Interface and Description
public interface	AddressedEnvelope< the type of the wrapped message M, the type of the address A extends SocketAddress> A message that wraps another message with a sender address and a recipient address.
public interface	Channel A nexus to a network socket or a component which is capable of I/O operations such as read, write, connect, and bind.
public interface	ChannelFactory<T extends Channel> Creates a new `Channel`.
public interface	ChannelHandler Handles an I/O event or intercepts an I/O operation, and forwards it to its next handler in its `ChannelPipeline`.
public interface	ChannelHandlerContext Enables a `ChannelHandler` to interact with its `ChannelPipeline` and other handlers.
public interface	ChannelId Represents the globally unique identifier of a `Channel`.
public interface	ChannelInboundInvoker
public interface	ChannelOutboundInvoker
public interface	ChannelPipeline A list of `ChannelHandler`s which handles or intercepts inbound events and outbound operations of a `Channel`.
public interface	EventLoop Will handle all the I/O operations for a `IoHandle` once registered.
public interface	EventLoopGroup Special `EventExecutorGroup` which allows registering `IoHandle`s that get processed for later selection during the event loop.
public interface	FileRegion A region of a file that is sent via a `Channel` which supports zero-copy file transfer.
public interface	IoExecutionContext The execution context for an `IoHandler`.
public interface	IoHandle A handle that will process I/O.
public interface	IoHandler Handles IO dispatching for an `EventLoop` All operations except `wakeup(boolean)` and `isCompatible(Class)` MUST be executed on the `EventLoop` thread and should never be called from the user-directly.
public interface	IoHandlerFactory Factory for `IoHandler` instances.
public interface	MessageSizeEstimator Responsible to estimate the size of a message.
public interface	ReadBufferAllocator Implementations of this interface can influence how `Buffer`s are allocated that are used when reading from the transport.
public interface	ReadHandleFactory Implementations allow to influence how much data / messages are read per read loop invocation.
public interface	SelectStrategy Select strategy interface.
public interface	SelectStrategyFactory Factory that creates a new `SelectStrategy` every time.
public interface	ServerChannel A `Channel` that accepts an incoming connection attempts and creates its child `Channel`s by accepting them.
public interface	ServerChannelFactory<T extends ServerChannel> Creates a new `ServerChannel`.
public interface	WriteHandleFactory Implementations allow to influence how much data / messages are written per write loop invocation.

Class Summary

Modifier and Type	Class and Description
public abstract class	AbstractChannel<P extends Channel, L extends SocketAddress, R extends SocketAddress> A skeletal `Channel` implementation.
public abstract class	AbstractCoalescingBufferQueue
public abstract class	AbstractServerChannel<P extends Channel, L extends SocketAddress, R extends SocketAddress> A skeletal `ServerChannel` implementation.
public class	AdaptiveReadHandleFactory The `ReadHandleFactory` that automatically increases and decreases the predicted buffer size on feed back.
public abstract class	BufferAddressedEnvelope< The type of socket address used for recipient and sender. A extends SocketAddress, The concrete sub-type of this class, used for implementing `send()`. T extends BufferAddressedEnvelope<A, T>> Base class for addressed envelopes that have `Buffer` instances as messages.
public class	ChannelException A `RuntimeException` which is thrown when an I/O operation fails.
public class	ChannelFutureListeners `FutureContextListener` listeners that take a context, and listens to the result of a `Future`.
public abstract class	ChannelHandlerAdapter Skeleton implementation of a `ChannelHandler`.
pack-priv class	ChannelHandlerMask
public abstract class	ChannelInitializer< A sub-type of `Channel` C extends Channel> A special `ChannelHandler` which offers an easy way to initialize a `Channel` once it was registered to its `EventLoop`.
public class	ChannelOption< the type of the value which is valid for the `ChannelOption` T> A `ChannelOption` allows to configure a `Channel` in a type-safe way.
pack-priv class	ChannelOutboundBuffer (Transport implementors only) an internal data structure used by `AbstractChannel` to store its pending outbound write requests.
public class	ChannelOutputShutdownException Used to fail pending writes when a channel's output has been shutdown.
public class	ChannelPipelineException A `ChannelException` which is thrown when a `ChannelPipeline` failed to execute an operation.
public class	CoalescingBufferQueue A FIFO queue of bytes where producers add bytes by repeatedly adding `Buffer` and consumers take bytes in arbitrary lengths.
public class	CombinedChannelDuplexHandler<I extends ChannelHandler, O extends ChannelHandler> Combines the inbound handling of one `ChannelHandler` with the outbound handling of another `ChannelHandler`.
public class	ConnectTimeoutException `ConnectException` which will be thrown if a connection could not be established because of a connection timeout.
public class	DefaultAddressedEnvelope< the type of the wrapped message M, the type of the recipient address A extends SocketAddress> The default `AddressedEnvelope` implementation.
public class	DefaultBufferAddressedEnvelope< the type of the recipient and sender addresses. A extends SocketAddress> The default `AddressedEnvelope` implementation for `Buffer` messages.
pack-priv class	DefaultChannelHandlerContext
public class	DefaultChannelId The default `ChannelId` implementation.
public abstract class	DefaultChannelPipeline The default `ChannelPipeline` implementation.
public class	DefaultFileRegion Default `FileRegion` implementation which transfer data from a `FileChannel` or `File`.
public class	DefaultMessageSizeEstimator Default `MessageSizeEstimator` implementation which supports the estimation of the size of `Buffer` and `FileRegion`.
pack-priv class	DefaultSelectStrategy Default select strategy.
public class	DefaultSelectStrategyFactory Factory which uses the default select strategy.
public class	FixedReadHandleFactory The `ReadHandleFactory` that always yields the same buffer size prediction.
public abstract class	MaxMessagesReadHandleFactory Base implementation of `ReadHandleFactory` which allows to limit the number of messages read per read loop.
public class	MaxMessagesWriteHandleFactory
public class	MultithreadEventLoopGroup `EventLoopGroup` implementation that will handle its tasks with multiple threads.
public class	PendingWriteQueue A queue of write operations which are pending for later execution.
public class	ReflectiveChannelFactory<T extends Channel> A `ChannelFactory` that instantiates a new `Channel` by invoking its default constructor reflectively.
public class	ReflectiveServerChannelFactory<T extends ServerChannel> A `ChannelFactory` that instantiates a new `ServerChannel` by invoking its default constructor reflectively.
public class	ServerChannelReadHandleFactory `MaxMessagesReadHandleFactory` implementation which should be used for `ServerChannel`s.
public class	ServerChannelWriteHandleFactory
public abstract class	SimpleChannelInboundHandler<I> `ChannelHandler` which allows to explicit only handle a specific type of messages.
public abstract class	SimpleUserEventChannelHandler<I> `ChannelHandler` which allows to conveniently only handle a specific type of user events.
public class	SingleThreadEventLoop `EventLoop` that execute all its submitted tasks in a single thread and uses an `IoHandler` for IO processing.
pack-priv class	StacklessClosedChannelException Cheap `ClosedChannelException` that does not fill in the stacktrace.
public class	WriteBufferWaterMark `WriteBufferWaterMark` is used to set low water mark and high water mark for the write buffer.

Package io.netty5.channel

Interface Summary

Class Summary

Enum Summary