Uses of Class
io.netty.channel.ChannelOption
Packages that use ChannelOption
Package
Description
The helper classes with fluent API which enable an easy implementation of
typical client side and server side channel initialization.
The core channel API which is asynchronous and event-driven abstraction of
various transports such as a
NIO Channel.
Optimized transport for linux which uses EPOLL Edge-Triggered Mode
for maximal performance.
BSD specific transport.
Abstract SCTP socket interfaces which extend the core channel API.
Abstract TCP and UDP socket interfaces which extend the core channel API.
NIO-based socket channel
API implementation - recommended for a large number of connections (>= 1000).
Old blocking I/O based socket channel API implementation - recommended for
a small number of connections (< 1000).
Unix specific transport.
Handlers for sending and receiving HTTP/2 frames.
-
Uses of ChannelOption in io.netty.bootstrap
Fields in io.netty.bootstrap with type parameters of type ChannelOptionModifier and TypeFieldDescriptionprivate final Map
<ChannelOption<?>, Object> ServerBootstrap.childOptions
private final Map
<ChannelOption<?>, Object> AbstractBootstrap.options
Methods in io.netty.bootstrap that return types with arguments of type ChannelOptionModifier and TypeMethodDescription(package private) final Map
<ChannelOption<?>, Object> ServerBootstrap.childOptions()
Map
<ChannelOption<?>, Object> ServerBootstrapConfig.childOptions()
Returns a copy of the configured options which will be used for the child channels.(package private) final Map.Entry<ChannelOption<?>,
Object>[] AbstractBootstrap.newOptionsArray()
(package private) static Map.Entry<ChannelOption<?>,
Object>[] AbstractBootstrap.newOptionsArray
(Map<ChannelOption<?>, Object> options) (package private) final Map
<ChannelOption<?>, Object> AbstractBootstrap.options()
final Map
<ChannelOption<?>, Object> AbstractBootstrapConfig.options()
Returns a copy of the configured options.(package private) final Map
<ChannelOption<?>, Object> AbstractBootstrap.options0()
Methods in io.netty.bootstrap with parameters of type ChannelOptionModifier and TypeMethodDescription<T> ServerBootstrap
ServerBootstrap.childOption
(ChannelOption<T> childOption, T value) Allow to specify aChannelOption
which is used for theChannel
instances once they get created (after the acceptor accepted theChannel
).<T> B
AbstractBootstrap.option
(ChannelOption<T> option, T value) Allow to specify aChannelOption
which is used for theChannel
instances once they got created.private static void
AbstractBootstrap.setChannelOption
(Channel channel, ChannelOption<?> option, Object value, InternalLogger logger) Method parameters in io.netty.bootstrap with type arguments of type ChannelOptionModifier and TypeMethodDescription(package private) static Map.Entry<ChannelOption<?>,
Object>[] AbstractBootstrap.newOptionsArray
(Map<ChannelOption<?>, Object> options) -
Uses of ChannelOption in io.netty.channel
Fields in io.netty.channel declared as ChannelOptionModifier and TypeFieldDescriptionstatic final ChannelOption
<ByteBufAllocator> ChannelOption.ALLOCATOR
static final ChannelOption
<Boolean> ChannelOption.ALLOW_HALF_CLOSURE
static final ChannelOption
<Boolean> ChannelOption.AUTO_CLOSE
Iftrue
then theChannel
is closed automatically and immediately on write failure.static final ChannelOption
<Boolean> ChannelOption.AUTO_READ
static final ChannelOption
<Integer> ChannelOption.CONNECT_TIMEOUT_MILLIS
static final ChannelOption
<Boolean> ChannelOption.DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION
Deprecated.static final ChannelOption
<InetAddress> ChannelOption.IP_MULTICAST_ADDR
static final ChannelOption
<NetworkInterface> ChannelOption.IP_MULTICAST_IF
static final ChannelOption
<Boolean> ChannelOption.IP_MULTICAST_LOOP_DISABLED
static final ChannelOption
<Integer> ChannelOption.IP_MULTICAST_TTL
static final ChannelOption
<Integer> ChannelOption.IP_TOS
static final ChannelOption
<Integer> ChannelOption.MAX_MESSAGES_PER_READ
Deprecated.static final ChannelOption
<Integer> ChannelOption.MAX_MESSAGES_PER_WRITE
static final ChannelOption
<MessageSizeEstimator> ChannelOption.MESSAGE_SIZE_ESTIMATOR
static final ChannelOption
<RecvByteBufAllocator> ChannelOption.RCVBUF_ALLOCATOR
static final ChannelOption
<Boolean> ChannelOption.SINGLE_EVENTEXECUTOR_PER_GROUP
static final ChannelOption
<Integer> ChannelOption.SO_BACKLOG
static final ChannelOption
<Boolean> ChannelOption.SO_BROADCAST
static final ChannelOption
<Boolean> ChannelOption.SO_KEEPALIVE
static final ChannelOption
<Integer> ChannelOption.SO_LINGER
static final ChannelOption
<Integer> ChannelOption.SO_RCVBUF
static final ChannelOption
<Boolean> ChannelOption.SO_REUSEADDR
static final ChannelOption
<Integer> ChannelOption.SO_SNDBUF
static final ChannelOption
<Integer> ChannelOption.SO_TIMEOUT
static final ChannelOption
<Integer> ChannelOption.TCP_FASTOPEN
Server-side TCP FastOpen.static final ChannelOption
<Boolean> ChannelOption.TCP_FASTOPEN_CONNECT
Client-side TCP FastOpen.static final ChannelOption
<Boolean> ChannelOption.TCP_NODELAY
static final ChannelOption
<Integer> ChannelOption.WRITE_BUFFER_HIGH_WATER_MARK
Deprecated.static final ChannelOption
<Integer> ChannelOption.WRITE_BUFFER_LOW_WATER_MARK
Deprecated.static final ChannelOption
<WriteBufferWaterMark> ChannelOption.WRITE_BUFFER_WATER_MARK
static final ChannelOption
<Integer> ChannelOption.WRITE_SPIN_COUNT
Fields in io.netty.channel with type parameters of type ChannelOptionModifier and TypeFieldDescriptionprivate static final ConstantPool
<ChannelOption<Object>> ChannelOption.pool
Methods in io.netty.channel that return ChannelOptionModifier and TypeMethodDescriptionstatic <T> ChannelOption
<T> ChannelOption.newInstance
(String name) Deprecated.usevalueOf(String)
.static <T> ChannelOption
<T> static <T> ChannelOption
<T> Returns theChannelOption
of the specified name.Methods in io.netty.channel that return types with arguments of type ChannelOptionModifier and TypeMethodDescriptionMap
<ChannelOption<?>, Object> ChannelConfig.getOptions()
Return all setChannelOption
's.Map
<ChannelOption<?>, Object> DefaultChannelConfig.getOptions()
protected Map
<ChannelOption<?>, Object> DefaultChannelConfig.getOptions
(Map<ChannelOption<?>, Object> result, ChannelOption<?>... options) Methods in io.netty.channel with parameters of type ChannelOptionModifier and TypeMethodDescription<T> T
ChannelConfig.getOption
(ChannelOption<T> option) Return the value of the givenChannelOption
<T> T
DefaultChannelConfig.getOption
(ChannelOption<T> option) protected Map
<ChannelOption<?>, Object> DefaultChannelConfig.getOptions
(Map<ChannelOption<?>, Object> result, ChannelOption<?>... options) <T> boolean
ChannelConfig.setOption
(ChannelOption<T> option, T value) Sets a configuration property with the specified name and value.<T> boolean
DefaultChannelConfig.setOption
(ChannelOption<T> option, T value) protected <T> void
DefaultChannelConfig.validate
(ChannelOption<T> option, T value) Method parameters in io.netty.channel with type arguments of type ChannelOptionModifier and TypeMethodDescriptionprotected Map
<ChannelOption<?>, Object> DefaultChannelConfig.getOptions
(Map<ChannelOption<?>, Object> result, ChannelOption<?>... options) boolean
ChannelConfig.setOptions
(Map<ChannelOption<?>, ?> options) Sets the configuration properties from the specifiedMap
.boolean
DefaultChannelConfig.setOptions
(Map<ChannelOption<?>, ?> options) -
Uses of ChannelOption in io.netty.channel.epoll
Subclasses of ChannelOption in io.netty.channel.epollFields in io.netty.channel.epoll declared as ChannelOptionModifier and TypeFieldDescriptionstatic final ChannelOption
<EpollMode> EpollChannelOption.EPOLL_MODE
static final ChannelOption
<Boolean> EpollChannelOption.IP_BIND_ADDRESS_NO_PORT
static final ChannelOption
<Boolean> EpollChannelOption.IP_FREEBIND
static final ChannelOption
<Boolean> EpollChannelOption.IP_RECVORIGDSTADDR
static final ChannelOption
<Boolean> EpollChannelOption.IP_TRANSPARENT
static final ChannelOption
<Integer> EpollChannelOption.MAX_DATAGRAM_PAYLOAD_SIZE
static final ChannelOption
<Integer> EpollChannelOption.SO_BUSY_POLL
static final ChannelOption
<Boolean> EpollChannelOption.TCP_CORK
static final ChannelOption
<Integer> EpollChannelOption.TCP_DEFER_ACCEPT
static final ChannelOption
<Integer> EpollChannelOption.TCP_FASTOPEN
Deprecated.UseTCP_FASTOPEN
instead.static final ChannelOption
<Boolean> EpollChannelOption.TCP_FASTOPEN_CONNECT
Deprecated.UseTCP_FASTOPEN_CONNECT
instead.static final ChannelOption
<Integer> EpollChannelOption.TCP_KEEPCNT
static final ChannelOption
<Integer> EpollChannelOption.TCP_KEEPIDLE
static final ChannelOption
<Integer> EpollChannelOption.TCP_KEEPINTVL
static final ChannelOption
<Map<InetAddress, byte[]>> EpollChannelOption.TCP_MD5SIG
static final ChannelOption
<Long> EpollChannelOption.TCP_NOTSENT_LOWAT
static final ChannelOption
<Boolean> EpollChannelOption.TCP_QUICKACK
static final ChannelOption
<Integer> EpollChannelOption.TCP_USER_TIMEOUT
static final ChannelOption
<Boolean> EpollChannelOption.UDP_GRO
Methods in io.netty.channel.epoll that return types with arguments of type ChannelOptionModifier and TypeMethodDescriptionMap
<ChannelOption<?>, Object> EpollChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> EpollDatagramChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> EpollDomainDatagramChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> EpollDomainSocketChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> EpollServerChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> EpollServerSocketChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> EpollSocketChannelConfig.getOptions()
Methods in io.netty.channel.epoll with parameters of type ChannelOptionModifier and TypeMethodDescription<T> T
EpollChannelConfig.getOption
(ChannelOption<T> option) <T> T
EpollDatagramChannelConfig.getOption
(ChannelOption<T> option) <T> T
EpollDomainDatagramChannelConfig.getOption
(ChannelOption<T> option) <T> T
EpollDomainSocketChannelConfig.getOption
(ChannelOption<T> option) <T> T
EpollServerChannelConfig.getOption
(ChannelOption<T> option) <T> T
EpollServerSocketChannelConfig.getOption
(ChannelOption<T> option) <T> T
EpollSocketChannelConfig.getOption
(ChannelOption<T> option) <T> boolean
EpollChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
EpollDatagramChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
EpollDomainDatagramChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
EpollDomainSocketChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
EpollServerChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
EpollServerSocketChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
EpollSocketChannelConfig.setOption
(ChannelOption<T> option, T value) -
Uses of ChannelOption in io.netty.channel.kqueue
Subclasses of ChannelOption in io.netty.channel.kqueueFields in io.netty.channel.kqueue declared as ChannelOptionModifier and TypeFieldDescriptionstatic final ChannelOption
<Boolean> KQueueChannelOption.RCV_ALLOC_TRANSPORT_PROVIDES_GUESS
If this istrue
then theRecvByteBufAllocator.Handle.guess()
will be overridden to always attempt to read as many bytes as kqueue says are available.static final ChannelOption
<AcceptFilter> KQueueChannelOption.SO_ACCEPTFILTER
static final ChannelOption
<Integer> KQueueChannelOption.SO_SNDLOWAT
static final ChannelOption
<Boolean> KQueueChannelOption.TCP_NOPUSH
Methods in io.netty.channel.kqueue that return types with arguments of type ChannelOptionModifier and TypeMethodDescriptionMap
<ChannelOption<?>, Object> KQueueChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> KQueueDatagramChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> KQueueDomainDatagramChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> KQueueDomainSocketChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> KQueueServerChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> KQueueServerSocketChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> KQueueSocketChannelConfig.getOptions()
Methods in io.netty.channel.kqueue with parameters of type ChannelOptionModifier and TypeMethodDescription<T> T
KQueueChannelConfig.getOption
(ChannelOption<T> option) <T> T
KQueueDatagramChannelConfig.getOption
(ChannelOption<T> option) <T> T
KQueueDomainDatagramChannelConfig.getOption
(ChannelOption<T> option) <T> T
KQueueDomainSocketChannelConfig.getOption
(ChannelOption<T> option) <T> T
KQueueServerChannelConfig.getOption
(ChannelOption<T> option) <T> T
KQueueServerSocketChannelConfig.getOption
(ChannelOption<T> option) <T> T
KQueueSocketChannelConfig.getOption
(ChannelOption<T> option) <T> boolean
KQueueChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
KQueueDatagramChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
KQueueDomainDatagramChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
KQueueDomainSocketChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
KQueueServerChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
KQueueServerSocketChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
KQueueSocketChannelConfig.setOption
(ChannelOption<T> option, T value) -
Uses of ChannelOption in io.netty.channel.sctp
Subclasses of ChannelOption in io.netty.channel.sctpModifier and TypeClassDescriptionfinal class
Option for configuring the SCTP transportFields in io.netty.channel.sctp declared as ChannelOptionModifier and TypeFieldDescriptionstatic final ChannelOption
<Boolean> SctpChannelOption.SCTP_DISABLE_FRAGMENTS
static final ChannelOption
<Boolean> SctpChannelOption.SCTP_EXPLICIT_COMPLETE
static final ChannelOption
<Integer> SctpChannelOption.SCTP_FRAGMENT_INTERLEAVE
static final ChannelOption
<SctpStandardSocketOptions.InitMaxStreams> SctpChannelOption.SCTP_INIT_MAXSTREAMS
static final ChannelOption
<Boolean> SctpChannelOption.SCTP_NODELAY
static final ChannelOption
<SocketAddress> SctpChannelOption.SCTP_PRIMARY_ADDR
static final ChannelOption
<SocketAddress> SctpChannelOption.SCTP_SET_PEER_PRIMARY_ADDR
Methods in io.netty.channel.sctp that return types with arguments of type ChannelOptionModifier and TypeMethodDescriptionMap
<ChannelOption<?>, Object> DefaultSctpChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> DefaultSctpServerChannelConfig.getOptions()
Methods in io.netty.channel.sctp with parameters of type ChannelOptionModifier and TypeMethodDescription<T> T
DefaultSctpChannelConfig.getOption
(ChannelOption<T> option) <T> T
DefaultSctpServerChannelConfig.getOption
(ChannelOption<T> option) <T> boolean
DefaultSctpChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
DefaultSctpServerChannelConfig.setOption
(ChannelOption<T> option, T value) -
Uses of ChannelOption in io.netty.channel.socket
Methods in io.netty.channel.socket that return types with arguments of type ChannelOptionModifier and TypeMethodDescriptionMap
<ChannelOption<?>, Object> DefaultDatagramChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> DefaultServerSocketChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> DefaultSocketChannelConfig.getOptions()
Methods in io.netty.channel.socket with parameters of type ChannelOptionModifier and TypeMethodDescription<T> T
DefaultDatagramChannelConfig.getOption
(ChannelOption<T> option) <T> T
DefaultServerSocketChannelConfig.getOption
(ChannelOption<T> option) <T> T
DefaultSocketChannelConfig.getOption
(ChannelOption<T> option) <T> boolean
DefaultDatagramChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
DefaultServerSocketChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
DefaultSocketChannelConfig.setOption
(ChannelOption<T> option, T value) -
Uses of ChannelOption in io.netty.channel.socket.nio
Subclasses of ChannelOption in io.netty.channel.socket.nioModifier and TypeClassDescriptionfinal class
ProvidesChannelOption
over a givenSocketOption
which is then passed through the underlyingNetworkChannel
.Methods in io.netty.channel.socket.nio that return ChannelOptionModifier and TypeMethodDescription(package private) static ChannelOption[]
NioChannelOption.getOptions
(Channel jdkChannel) static <T> ChannelOption
<T> NioChannelOption.of
(SocketOption<T> option) Returns aChannelOption
for the givenSocketOption
.Methods in io.netty.channel.socket.nio that return types with arguments of type ChannelOptionModifier and TypeMethodDescriptionMap
<ChannelOption<?>, Object> NioDatagramChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> NioDomainSocketChannel.NioDomainSocketChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> NioServerDomainSocketChannel.NioDomainServerSocketChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> NioServerSocketChannel.NioServerSocketChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> NioSocketChannel.NioSocketChannelConfig.getOptions()
Methods in io.netty.channel.socket.nio with parameters of type ChannelOptionModifier and TypeMethodDescription<T> T
NioDatagramChannelConfig.getOption
(ChannelOption<T> option) <T> T
NioDomainSocketChannel.NioDomainSocketChannelConfig.getOption
(ChannelOption<T> option) <T> T
NioServerDomainSocketChannel.NioDomainServerSocketChannelConfig.getOption
(ChannelOption<T> option) <T> T
NioServerSocketChannel.NioServerSocketChannelConfig.getOption
(ChannelOption<T> option) <T> T
NioSocketChannel.NioSocketChannelConfig.getOption
(ChannelOption<T> option) <T> boolean
NioDatagramChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
NioDomainSocketChannel.NioDomainSocketChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
NioServerDomainSocketChannel.NioDomainServerSocketChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
NioServerSocketChannel.NioServerSocketChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
NioSocketChannel.NioSocketChannelConfig.setOption
(ChannelOption<T> option, T value) -
Uses of ChannelOption in io.netty.channel.socket.oio
Methods in io.netty.channel.socket.oio that return types with arguments of type ChannelOptionModifier and TypeMethodDescriptionMap
<ChannelOption<?>, Object> DefaultOioDatagramChannelConfig.getOptions()
Map
<ChannelOption<?>, Object> DefaultOioServerSocketChannelConfig.getOptions()
Deprecated.Map
<ChannelOption<?>, Object> DefaultOioSocketChannelConfig.getOptions()
Deprecated.Methods in io.netty.channel.socket.oio with parameters of type ChannelOptionModifier and TypeMethodDescription<T> T
DefaultOioDatagramChannelConfig.getOption
(ChannelOption<T> option) <T> T
DefaultOioServerSocketChannelConfig.getOption
(ChannelOption<T> option) Deprecated.<T> T
DefaultOioSocketChannelConfig.getOption
(ChannelOption<T> option) Deprecated.<T> boolean
DefaultOioDatagramChannelConfig.setOption
(ChannelOption<T> option, T value) <T> boolean
DefaultOioServerSocketChannelConfig.setOption
(ChannelOption<T> option, T value) Deprecated.<T> boolean
DefaultOioSocketChannelConfig.setOption
(ChannelOption<T> option, T value) Deprecated. -
Uses of ChannelOption in io.netty.channel.unix
Subclasses of ChannelOption in io.netty.channel.unixModifier and TypeClassDescriptionclass
A generic socket option.final class
final class
class
Fields in io.netty.channel.unix declared as ChannelOptionModifier and TypeFieldDescriptionstatic final ChannelOption
<DomainSocketReadMode> UnixChannelOption.DOMAIN_SOCKET_READ_MODE
static final ChannelOption
<Boolean> UnixChannelOption.SO_REUSEPORT
-
Uses of ChannelOption in io.netty.handler.codec.http2
Subclasses of ChannelOption in io.netty.handler.codec.http2Modifier and TypeClassDescriptionfinal class
ChannelOption
s that are specific toHttp2StreamChannel
s.Fields in io.netty.handler.codec.http2 declared as ChannelOptionModifier and TypeFieldDescriptionstatic final ChannelOption
<Boolean> Http2StreamChannelOption.AUTO_STREAM_FLOW_CONTROL
When set totrue
Http2WindowUpdateFrame
s will be automatically be generated and written forHttp2StreamChannel
s as soon as frames are passed to the user viaChannelPipeline.fireChannelRead(Object)
.Fields in io.netty.handler.codec.http2 with type parameters of type ChannelOptionModifier and TypeFieldDescriptionprivate final Map
<ChannelOption<?>, Object> Http2StreamChannelBootstrap.options
Methods in io.netty.handler.codec.http2 that return types with arguments of type ChannelOptionModifier and TypeMethodDescriptionMap
<ChannelOption<?>, Object> AbstractHttp2StreamChannel.Http2StreamChannelConfig.getOptions()
Methods in io.netty.handler.codec.http2 with parameters of type ChannelOptionModifier and TypeMethodDescription<T> T
AbstractHttp2StreamChannel.Http2StreamChannelConfig.getOption
(ChannelOption<T> option) Http2StreamChannelBootstrap.option
(ChannelOption<T> option, T value) Allow to specify aChannelOption
which is used for theHttp2StreamChannel
instances once they got created.private static void
Http2StreamChannelBootstrap.setChannelOption
(Channel channel, ChannelOption<?> option, Object value) <T> boolean
AbstractHttp2StreamChannel.Http2StreamChannelConfig.setOption
(ChannelOption<T> option, T value)
MaxMessagesRecvByteBufAllocator
andMaxMessagesRecvByteBufAllocator.maxMessagesPerRead(int)
.