Uses of Class
io.netty.channel.ChannelOption

Packages that use ChannelOption

Package	Description
io.netty.bootstrap	The helper classes with fluent API which enable an easy implementation of typical client side and server side channel initialization.
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.epoll	Optimized transport for linux which uses EPOLL Edge-Triggered Mode for maximal performance.
io.netty.channel.kqueue	BSD specific transport.
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.unix	Unix specific transport.
io.netty.handler.codec.http2	Handlers for sending and receiving HTTP/2 frames.

Uses of ChannelOption in io.netty.bootstrap

Methods in io.netty.bootstrap that return types with arguments of type ChannelOption

Modifier and Type	Method	Description
Map<ChannelOption<?>,Object>	ServerBootstrapConfig.childOptions()	Returns a copy of the configured options which will be used for the child channels.
Map<ChannelOption<?>,Object>	AbstractBootstrapConfig.options()	Returns a copy of the configured options.

Methods in io.netty.bootstrap with parameters of type ChannelOption

Modifier and Type	Method	Description
<T> ServerBootstrap	ServerBootstrap.childOption(ChannelOption<T> childOption, T value)	Allow to specify a ChannelOption which is used for the Channel instances once they get created (after the acceptor accepted the Channel).
<T> B	AbstractBootstrap.option(ChannelOption<T> option, T value)	Allow to specify a ChannelOption which is used for the Channel instances once they got created.

Uses of ChannelOption in io.netty.channel

Fields in io.netty.channel declared as ChannelOption

Modifier and Type	Field	Description
static ChannelOption<ByteBufAllocator>	ChannelOption.ALLOCATOR
static ChannelOption<Boolean>	ChannelOption.ALLOW_HALF_CLOSURE
static ChannelOption<Boolean>	ChannelOption.AUTO_CLOSE	If true then the Channel is closed automatically and immediately on write failure.
static ChannelOption<Boolean>	ChannelOption.AUTO_READ
static ChannelOption<Integer>	ChannelOption.CONNECT_TIMEOUT_MILLIS
static ChannelOption<Boolean>	ChannelOption.DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION	Deprecated.
static ChannelOption<InetAddress>	ChannelOption.IP_MULTICAST_ADDR
static ChannelOption<NetworkInterface>	ChannelOption.IP_MULTICAST_IF
static ChannelOption<Boolean>	ChannelOption.IP_MULTICAST_LOOP_DISABLED
static ChannelOption<Integer>	ChannelOption.IP_MULTICAST_TTL
static ChannelOption<Integer>	ChannelOption.IP_TOS
static ChannelOption<Integer>	ChannelOption.MAX_MESSAGES_PER_READ	Deprecated. Use MaxMessagesRecvByteBufAllocator and MaxMessagesRecvByteBufAllocator.maxMessagesPerRead(int).
static ChannelOption<Integer>	ChannelOption.MAX_MESSAGES_PER_WRITE
static ChannelOption<MessageSizeEstimator>	ChannelOption.MESSAGE_SIZE_ESTIMATOR
static ChannelOption<RecvByteBufAllocator>	ChannelOption.RCVBUF_ALLOCATOR
static ChannelOption<Boolean>	ChannelOption.SINGLE_EVENTEXECUTOR_PER_GROUP
static ChannelOption<Integer>	ChannelOption.SO_BACKLOG
static ChannelOption<Boolean>	ChannelOption.SO_BROADCAST
static ChannelOption<Boolean>	ChannelOption.SO_KEEPALIVE
static ChannelOption<Integer>	ChannelOption.SO_LINGER
static ChannelOption<Integer>	ChannelOption.SO_RCVBUF
static ChannelOption<Boolean>	ChannelOption.SO_REUSEADDR
static ChannelOption<Integer>	ChannelOption.SO_SNDBUF
static ChannelOption<Integer>	ChannelOption.SO_TIMEOUT
static ChannelOption<Integer>	ChannelOption.TCP_FASTOPEN	Server-side TCP FastOpen.
static ChannelOption<Boolean>	ChannelOption.TCP_FASTOPEN_CONNECT	Client-side TCP FastOpen.
static ChannelOption<Boolean>	ChannelOption.TCP_NODELAY
static ChannelOption<Integer>	ChannelOption.WRITE_BUFFER_HIGH_WATER_MARK	Deprecated. Use WRITE_BUFFER_WATER_MARK
static ChannelOption<Integer>	ChannelOption.WRITE_BUFFER_LOW_WATER_MARK	Deprecated. Use WRITE_BUFFER_WATER_MARK
static ChannelOption<WriteBufferWaterMark>	ChannelOption.WRITE_BUFFER_WATER_MARK
static ChannelOption<Integer>	ChannelOption.WRITE_SPIN_COUNT

Methods in io.netty.channel that return ChannelOption

Modifier and Type	Method	Description
static <T> ChannelOption<T>	ChannelOption.newInstance(String name)	Deprecated. use valueOf(String).
static <T> ChannelOption<T>	ChannelOption.valueOf(Class<?> firstNameComponent, String secondNameComponent)	Shortcut of valueOf(firstNameComponent.getName() + "#" + secondNameComponent).
static <T> ChannelOption<T>	ChannelOption.valueOf(String name)	Returns the ChannelOption of the specified name.

Methods in io.netty.channel that return types with arguments of type ChannelOption

Modifier and Type	Method	Description
Map<ChannelOption<?>,Object>	ChannelConfig.getOptions()	Return all set ChannelOption'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 ChannelOption

Modifier and Type	Method	Description
<T> T	ChannelConfig.getOption(ChannelOption<T> option)	Return the value of the given ChannelOption
<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 ChannelOption

Modifier and Type	Method	Description
protected Map<ChannelOption<?>,Object>	DefaultChannelConfig.getOptions(Map<ChannelOption<?>,Object> result, ChannelOption<?>... options)
boolean	ChannelConfig.setOptions(Map<ChannelOption<?>,?> options)	Sets the configuration properties from the specified Map.
boolean	DefaultChannelConfig.setOptions(Map<ChannelOption<?>,?> options)

Uses of ChannelOption in io.netty.channel.epoll

Subclasses of ChannelOption in io.netty.channel.epoll

Modifier and Type	Class	Description
class	EpollChannelOption<T>

Fields in io.netty.channel.epoll declared as ChannelOption

Modifier and Type	Field	Description
static ChannelOption<EpollMode>	EpollChannelOption.EPOLL_MODE
static ChannelOption<Boolean>	EpollChannelOption.IP_FREEBIND
static ChannelOption<Boolean>	EpollChannelOption.IP_RECVORIGDSTADDR
static ChannelOption<Boolean>	EpollChannelOption.IP_TRANSPARENT
static ChannelOption<Integer>	EpollChannelOption.MAX_DATAGRAM_PAYLOAD_SIZE
static ChannelOption<Integer>	EpollChannelOption.SO_BUSY_POLL
static ChannelOption<Boolean>	EpollChannelOption.TCP_CORK
static ChannelOption<Integer>	EpollChannelOption.TCP_DEFER_ACCEPT
static ChannelOption<Integer>	EpollChannelOption.TCP_FASTOPEN	Deprecated. Use TCP_FASTOPEN instead.
static ChannelOption<Boolean>	EpollChannelOption.TCP_FASTOPEN_CONNECT	Deprecated. Use TCP_FASTOPEN_CONNECT instead.
static ChannelOption<Integer>	EpollChannelOption.TCP_KEEPCNT
static ChannelOption<Integer>	EpollChannelOption.TCP_KEEPIDLE
static ChannelOption<Integer>	EpollChannelOption.TCP_KEEPINTVL
static ChannelOption<Map<InetAddress,byte[]>>	EpollChannelOption.TCP_MD5SIG
static ChannelOption<Long>	EpollChannelOption.TCP_NOTSENT_LOWAT
static ChannelOption<Boolean>	EpollChannelOption.TCP_QUICKACK
static ChannelOption<Integer>	EpollChannelOption.TCP_USER_TIMEOUT
static ChannelOption<Boolean>	EpollChannelOption.UDP_GRO

Methods in io.netty.channel.epoll that return types with arguments of type ChannelOption

Modifier and Type	Method	Description
Map<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 ChannelOption

Modifier and Type	Method	Description
<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.kqueue

Modifier and Type	Class	Description
class	KQueueChannelOption<T>

Fields in io.netty.channel.kqueue declared as ChannelOption

Modifier and Type	Field	Description
static ChannelOption<Boolean>	KQueueChannelOption.RCV_ALLOC_TRANSPORT_PROVIDES_GUESS	If this is true then the RecvByteBufAllocator.Handle.guess() will be overridden to always attempt to read as many bytes as kqueue says are available.
static ChannelOption<AcceptFilter>	KQueueChannelOption.SO_ACCEPTFILTER
static ChannelOption<Integer>	KQueueChannelOption.SO_SNDLOWAT
static ChannelOption<Boolean>	KQueueChannelOption.TCP_NOPUSH

Methods in io.netty.channel.kqueue that return types with arguments of type ChannelOption

Modifier and Type	Method	Description
Map<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 ChannelOption

Modifier and Type	Method	Description
<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.socket

Methods in io.netty.channel.socket that return types with arguments of type ChannelOption

Modifier and Type	Method	Description
Map<ChannelOption<?>,Object>	DefaultDatagramChannelConfig.getOptions()
Map<ChannelOption<?>,Object>	DefaultServerSocketChannelConfig.getOptions()
Map<ChannelOption<?>,Object>	DefaultSocketChannelConfig.getOptions()

Methods in io.netty.channel.socket with parameters of type ChannelOption

Modifier and Type	Method	Description
<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.nio

Modifier and Type	Class	Description
class	NioChannelOption<T>	Provides ChannelOption over a given SocketOption which is then passed through the underlying NetworkChannel.

Methods in io.netty.channel.socket.nio that return ChannelOption

Modifier and Type	Method	Description
static <T> ChannelOption<T>	NioChannelOption.of(SocketOption<T> option)	Returns a ChannelOption for the given SocketOption.

Uses of ChannelOption in io.netty.channel.socket.oio

Methods in io.netty.channel.socket.oio that return types with arguments of type ChannelOption

Modifier and Type	Method	Description
Map<ChannelOption<?>,Object>	DefaultOioServerSocketChannelConfig.getOptions()	Deprecated.
Map<ChannelOption<?>,Object>	DefaultOioSocketChannelConfig.getOptions()	Deprecated.

Methods in io.netty.channel.socket.oio with parameters of type ChannelOption

Modifier and Type	Method	Description
<T> T	DefaultOioServerSocketChannelConfig.getOption(ChannelOption<T> option)	Deprecated.
<T> T	DefaultOioSocketChannelConfig.getOption(ChannelOption<T> option)	Deprecated.
<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.unix

Modifier and Type	Class	Description
class	UnixChannelOption<T>

Fields in io.netty.channel.unix declared as ChannelOption

Modifier and Type	Field	Description
static ChannelOption<DomainSocketReadMode>	UnixChannelOption.DOMAIN_SOCKET_READ_MODE
static ChannelOption<Boolean>	UnixChannelOption.SO_REUSEPORT

Uses of ChannelOption in io.netty.handler.codec.http2

Methods in io.netty.handler.codec.http2 with parameters of type ChannelOption

Modifier and Type	Method	Description
<T> Http2StreamChannelBootstrap	Http2StreamChannelBootstrap.option(ChannelOption<T> option, T value)	Allow to specify a ChannelOption which is used for the Http2StreamChannel instances once they got created.