Package | Description |
---|---|
io.netty.channel |
The core channel API which is asynchronous and event-driven abstraction of
various transports such as a
NIO Channel.
|
io.netty.channel.embedded |
A virtual
Channel that helps wrapping a series of handlers to
unit test the handlers or use them in non-I/O context. |
io.netty.channel.epoll |
Optimized transport for linux which uses EPOLL Edge-Triggered Mode
for maximal performance.
|
io.netty.channel.kqueue |
BSD specific transport.
|
io.netty.channel.local |
A virtual transport that enables the communication between the two
parties in the same virtual machine.
|
io.netty.channel.rxtx |
A serial and parallel port communication transport based on RXTX.
|
io.netty.channel.sctp |
Abstract SCTP socket interfaces which extend the core channel API.
|
io.netty.channel.socket |
Abstract TCP and UDP socket interfaces which extend the core channel API.
|
io.netty.channel.socket.nio |
NIO-based socket channel
API implementation - recommended for a large number of connections (>= 1000).
|
io.netty.channel.socket.oio |
Old blocking I/O based socket channel API implementation - recommended for
a small number of connections (< 1000).
|
io.netty.channel.udt |
UDT Transport.
|
io.netty.channel.unix |
Unix specific transport.
|
Modifier and Type | Class and Description |
---|---|
class |
DefaultChannelConfig
The default
ChannelConfig implementation. |
Modifier and Type | Method and Description |
---|---|
ChannelConfig |
Channel.config()
Returns the configuration of this channel.
|
ChannelConfig |
DefaultChannelConfig.setAllocator(ByteBufAllocator allocator) |
ChannelConfig |
ChannelConfig.setAllocator(ByteBufAllocator allocator)
Set the
ByteBufAllocator which is used for the channel
to allocate buffers. |
ChannelConfig |
DefaultChannelConfig.setAutoClose(boolean autoClose) |
ChannelConfig |
ChannelConfig.setAutoClose(boolean autoClose)
Sets whether the
Channel should be closed automatically and immediately on write failure. |
ChannelConfig |
DefaultChannelConfig.setAutoRead(boolean autoRead) |
ChannelConfig |
ChannelConfig.setAutoRead(boolean autoRead)
Sets if
ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't
need to call it at all. |
ChannelConfig |
DefaultChannelConfig.setConnectTimeoutMillis(int connectTimeoutMillis) |
ChannelConfig |
ChannelConfig.setConnectTimeoutMillis(int connectTimeoutMillis)
Sets the connect timeout of the channel in milliseconds.
|
ChannelConfig |
DefaultChannelConfig.setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.
|
ChannelConfig |
ChannelConfig.setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.
Use
MaxMessagesRecvByteBufAllocator and
MaxMessagesRecvByteBufAllocator.maxMessagesPerRead(int) .
Sets the maximum number of messages to read per read loop. If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages. |
ChannelConfig |
DefaultChannelConfig.setMaxMessagesPerWrite(int maxMessagesPerWrite)
Set the maximum number of message to write per eventloop run.
|
ChannelConfig |
DefaultChannelConfig.setMessageSizeEstimator(MessageSizeEstimator estimator) |
ChannelConfig |
ChannelConfig.setMessageSizeEstimator(MessageSizeEstimator estimator)
Set the
MessageSizeEstimator which is used for the channel
to detect the size of a message. |
ChannelConfig |
DefaultChannelConfig.setRecvByteBufAllocator(RecvByteBufAllocator allocator) |
ChannelConfig |
ChannelConfig.setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Set the
RecvByteBufAllocator which is used for the channel to allocate receive buffers. |
ChannelConfig |
DefaultChannelConfig.setWriteBufferHighWaterMark(int writeBufferHighWaterMark) |
ChannelConfig |
ChannelConfig.setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Sets the high water mark of the write buffer.
|
ChannelConfig |
DefaultChannelConfig.setWriteBufferLowWaterMark(int writeBufferLowWaterMark) |
ChannelConfig |
ChannelConfig.setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Sets the low water mark of the write buffer.
|
ChannelConfig |
DefaultChannelConfig.setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) |
ChannelConfig |
ChannelConfig.setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Set the
WriteBufferWaterMark which is used for setting the high and low
water mark of the write buffer. |
ChannelConfig |
DefaultChannelConfig.setWriteSpinCount(int writeSpinCount) |
ChannelConfig |
ChannelConfig.setWriteSpinCount(int writeSpinCount)
Sets the maximum loop count for a write operation until
WritableByteChannel.write(ByteBuffer) returns a non-zero value. |
Modifier and Type | Method and Description |
---|---|
void |
RecvByteBufAllocator.Handle.reset(ChannelConfig config)
Deprecated.
Reset any counters that have accumulated and recommend how many messages/bytes should be read for the next
read loop.
|
void |
RecvByteBufAllocator.DelegatingHandle.reset(ChannelConfig config) |
void |
DefaultMaxMessagesRecvByteBufAllocator.MaxMessageHandle.reset(ChannelConfig config)
Only
getMaxMessagesPerRead() is used. |
Modifier and Type | Method and Description |
---|---|
ChannelConfig |
EmbeddedChannel.config() |
Constructor and Description |
---|
EmbeddedChannel(ChannelId channelId,
boolean hasDisconnect,
ChannelConfig config,
ChannelHandler... handlers)
Create a new instance with the channel ID set to the given ID and the pipeline
initialized with the specified handlers.
|
Modifier and Type | Class and Description |
---|---|
class |
EpollChannelConfig |
class |
EpollDatagramChannelConfig |
class |
EpollDomainDatagramChannelConfig |
class |
EpollDomainSocketChannelConfig |
class |
EpollServerChannelConfig |
class |
EpollServerSocketChannelConfig |
class |
EpollSocketChannelConfig |
Modifier and Type | Class and Description |
---|---|
class |
KQueueChannelConfig |
class |
KQueueDatagramChannelConfig |
class |
KQueueDomainDatagramChannelConfig |
class |
KQueueDomainSocketChannelConfig |
class |
KQueueServerChannelConfig |
class |
KQueueServerSocketChannelConfig |
class |
KQueueSocketChannelConfig |
Modifier and Type | Method and Description |
---|---|
ChannelConfig |
LocalChannel.config() |
ChannelConfig |
LocalServerChannel.config() |
Modifier and Type | Interface and Description |
---|---|
interface |
RxtxChannelConfig
Deprecated.
this transport will be removed in the next major version.
|
Modifier and Type | Interface and Description |
---|---|
interface |
SctpChannelConfig
A
ChannelConfig for a SctpChannel . |
interface |
SctpServerChannelConfig
A
ChannelConfig for a SctpServerChannelConfig . |
Modifier and Type | Class and Description |
---|---|
class |
DefaultSctpChannelConfig
The default
SctpChannelConfig implementation for SCTP. |
class |
DefaultSctpServerChannelConfig
The default
SctpServerChannelConfig implementation for SCTP. |
Modifier and Type | Interface and Description |
---|---|
interface |
DatagramChannelConfig
A
ChannelConfig for a DatagramChannel . |
interface |
DuplexChannelConfig
A
ChannelConfig for a DuplexChannel . |
interface |
ServerSocketChannelConfig
A
ChannelConfig for a ServerSocketChannel . |
interface |
SocketChannelConfig
A
ChannelConfig for a SocketChannel . |
Modifier and Type | Class and Description |
---|---|
class |
DefaultDatagramChannelConfig
The default
DatagramChannelConfig implementation. |
class |
DefaultServerSocketChannelConfig
The default
ServerSocketChannelConfig implementation. |
class |
DefaultSocketChannelConfig
The default
SocketChannelConfig implementation. |
Modifier and Type | Method and Description |
---|---|
ChannelConfig |
NioServerDomainSocketChannel.config() |
ChannelConfig |
NioDomainSocketChannel.config() |
Modifier and Type | Interface and Description |
---|---|
interface |
OioDatagramChannelConfig
Deprecated.
use NIO / EPOLL / KQUEUE transport.
|
interface |
OioServerSocketChannelConfig
Deprecated.
use NIO / EPOLL / KQUEUE transport.
|
interface |
OioSocketChannelConfig
Deprecated.
use NIO / EPOLL / KQUEUE transport.
|
Modifier and Type | Class and Description |
---|---|
class |
DefaultOioServerSocketChannelConfig
Deprecated.
use NIO / EPOLL / KQUEUE transport.
|
class |
DefaultOioSocketChannelConfig
Deprecated.
use NIO / EPOLL / KQUEUE transport.
|
Modifier and Type | Interface and Description |
---|---|
interface |
UdtChannelConfig
Deprecated.
The UDT transport is no longer maintained and will be removed.
|
interface |
UdtServerChannelConfig
Deprecated.
The UDT transport is no longer maintained and will be removed.
|
Modifier and Type | Class and Description |
---|---|
class |
DefaultUdtChannelConfig
Deprecated.
The UDT transport is no longer maintained and will be removed.
|
class |
DefaultUdtServerChannelConfig
Deprecated.
The UDT transport is no longer maintained and will be removed.
|
Modifier and Type | Interface and Description |
---|---|
interface |
DomainDatagramChannelConfig
A
ChannelConfig for a DomainDatagramChannel . |
interface |
DomainSocketChannelConfig
Special
ChannelConfig for DomainSocketChannel s. |
Copyright © 2008–2024 The Netty Project. All rights reserved.