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.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.
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.
final 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

Subclasses with type arguments of type ChannelOption in io.netty.channel

Modifier and Type	Class	Description
class	ChannelOption<T>	A ChannelOption allows to configure a ChannelConfig in a type-safe way.

Fields in io.netty.channel declared as ChannelOption

Modifier and Type	Field	Description
static final ChannelOption<ByteBufAllocator>	ChannelOption.ALLOCATOR
static final ChannelOption<Boolean>	ChannelOption.ALLOW_HALF_CLOSURE
static final ChannelOption<Boolean>	ChannelOption.AUTO_CLOSE	If true then the Channel 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. Use MaxMessagesRecvByteBufAllocator and MaxMessagesRecvByteBufAllocator.maxMessagesPerRead(int).
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. Use ChannelOption.WRITE_BUFFER_WATER_MARK
static final ChannelOption<Integer>	ChannelOption.WRITE_BUFFER_LOW_WATER_MARK	Deprecated. Use ChannelOption.WRITE_BUFFER_WATER_MARK
static final ChannelOption<WriteBufferWaterMark>	ChannelOption.WRITE_BUFFER_WATER_MARK
static final 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 ChannelOption.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
final class	EpollChannelOption<T>

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

Modifier and Type	Field	Description
static 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. Use ChannelOption.TCP_FASTOPEN instead.
static final ChannelOption<Boolean>	EpollChannelOption.TCP_FASTOPEN_CONNECT	Deprecated. Use ChannelOption.TCP_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 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
final class	KQueueChannelOption<T>

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

Modifier and Type	Field	Description
static final 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 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 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.rxtx

Subclasses of ChannelOption in io.netty.channel.rxtx

Modifier and Type	Class	Description
final class	RxtxChannelOption<T>	Deprecated. this transport will be removed in the next major version.

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

Modifier and Type	Field	Description
static final ChannelOption<Integer>	RxtxChannelOption.BAUD_RATE	Deprecated.
static final ChannelOption<RxtxChannelConfig.Databits>	RxtxChannelOption.DATA_BITS	Deprecated.
static final ChannelOption<Boolean>	RxtxChannelOption.DTR	Deprecated.
static final ChannelOption<RxtxChannelConfig.Paritybit>	RxtxChannelOption.PARITY_BIT	Deprecated.
static final ChannelOption<Integer>	RxtxChannelOption.READ_TIMEOUT	Deprecated.
static final ChannelOption<Boolean>	RxtxChannelOption.RTS	Deprecated.
static final ChannelOption<RxtxChannelConfig.Stopbits>	RxtxChannelOption.STOP_BITS	Deprecated.
static final ChannelOption<Integer>	RxtxChannelOption.WAIT_TIME	Deprecated.

Uses of ChannelOption in io.netty.channel.sctp

Subclasses of ChannelOption in io.netty.channel.sctp

Modifier and Type	Class	Description
final class	SctpChannelOption<T>	Option for configuring the SCTP transport

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

Modifier and Type	Field	Description
static 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<com.sun.nio.sctp.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 ChannelOption

Modifier and Type	Method	Description
Map<ChannelOption<?>, Object>	DefaultSctpChannelConfig.getOptions()
Map<ChannelOption<?>, Object>	DefaultSctpServerChannelConfig.getOptions()

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

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

Subclasses of ChannelOption in io.netty.channel.udt

Modifier and Type	Class	Description
final class	UdtChannelOption<T>	Deprecated. The UDT transport is no longer maintained and will be removed.

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

Modifier and Type	Field	Description
static final ChannelOption<Integer>	UdtChannelOption.PROTOCOL_RECEIVE_BUFFER_SIZE	Deprecated. See OptionUDT.Protocol_Receive_Buffer_Size.
static final ChannelOption<Integer>	UdtChannelOption.PROTOCOL_SEND_BUFFER_SIZE	Deprecated. See OptionUDT.Protocol_Send_Buffer_Size.
static final ChannelOption<Integer>	UdtChannelOption.SYSTEM_RECEIVE_BUFFER_SIZE	Deprecated. See OptionUDT.System_Receive_Buffer_Size.
static final ChannelOption<Integer>	UdtChannelOption.SYSTEM_SEND_BUFFER_SIZE	Deprecated. See OptionUDT.System_Send_Buffer_Size.

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

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

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

Modifier and Type	Method	Description
<T> T	DefaultUdtChannelConfig.getOption(ChannelOption<T> option)	Deprecated.
<T> T	DefaultUdtServerChannelConfig.getOption(ChannelOption<T> option)	Deprecated.
<T> boolean	DefaultUdtChannelConfig.setOption(ChannelOption<T> option, T value)	Deprecated.
<T> boolean	DefaultUdtServerChannelConfig.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	GenericUnixChannelOption<T>	A generic socket option.
final class	IntegerUnixChannelOption	A GenericUnixChannelOption which uses an Integer as optval.
final class	RawUnixChannelOption	A GenericUnixChannelOption which uses an ByteBuffer as optval.
class	UnixChannelOption<T>

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

Modifier and Type	Field	Description
static 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.http2

Modifier and Type	Class	Description
final class	Http2StreamChannelOption<T>	ChannelOptions that are specific to Http2StreamChannels.

Fields in io.netty.handler.codec.http2 declared as ChannelOption

Modifier and Type	Field	Description
static final ChannelOption<Boolean>	Http2StreamChannelOption.AUTO_STREAM_FLOW_CONTROL	When set to true Http2WindowUpdateFrames will be automatically be generated and written for Http2StreamChannels as soon as frames are passed to the user via ChannelPipeline.fireChannelRead(Object).

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.