类的使用
io.netty.channel.ChannelOption

使用ChannelOption的程序包

程序包	说明
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	Benchmarks for io.netty.handler.codec.http2.

io.netty.bootstrap中ChannelOption的使用

返回变量类型为ChannelOption的类型的io.netty.bootstrap中的方法

限定符和类型	方法和说明
java.util.Map<ChannelOption<?>,java.lang.Object>	ServerBootstrapConfig.childOptions() Returns a copy of the configured options which will be used for the child channels.
java.util.Map<ChannelOption<?>,java.lang.Object>	AbstractBootstrapConfig.options() Returns a copy of the configured options.

参数类型为ChannelOption的io.netty.bootstrap中的方法

限定符和类型	方法和说明
<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.

io.netty.channel中ChannelOption的使用

声明为ChannelOption的io.netty.channel中的字段

限定符和类型	字段和说明
static ChannelOption<ByteBufAllocator>	ChannelOption.ALLOCATOR
static ChannelOption<java.lang.Boolean>	ChannelOption.ALLOW_HALF_CLOSURE
static ChannelOption<java.lang.Boolean>	ChannelOption.AUTO_CLOSE If true then the Channel is closed automatically and immediately on write failure.
static ChannelOption<java.lang.Boolean>	ChannelOption.AUTO_READ
static ChannelOption<java.lang.Integer>	ChannelOption.CONNECT_TIMEOUT_MILLIS
static ChannelOption<java.lang.Boolean>	ChannelOption.DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION 已过时。
static ChannelOption<java.net.InetAddress>	ChannelOption.IP_MULTICAST_ADDR
static ChannelOption<java.net.NetworkInterface>	ChannelOption.IP_MULTICAST_IF
static ChannelOption<java.lang.Boolean>	ChannelOption.IP_MULTICAST_LOOP_DISABLED
static ChannelOption<java.lang.Integer>	ChannelOption.IP_MULTICAST_TTL
static ChannelOption<java.lang.Integer>	ChannelOption.IP_TOS
static ChannelOption<java.lang.Integer>	ChannelOption.MAX_MESSAGES_PER_READ 已过时。 Use MaxMessagesRecvByteBufAllocator and MaxMessagesRecvByteBufAllocator.maxMessagesPerRead(int).
static ChannelOption<java.lang.Integer>	ChannelOption.MAX_MESSAGES_PER_WRITE
static ChannelOption<MessageSizeEstimator>	ChannelOption.MESSAGE_SIZE_ESTIMATOR
static ChannelOption<RecvByteBufAllocator>	ChannelOption.RCVBUF_ALLOCATOR
static ChannelOption<java.lang.Boolean>	ChannelOption.SINGLE_EVENTEXECUTOR_PER_GROUP
static ChannelOption<java.lang.Integer>	ChannelOption.SO_BACKLOG
static ChannelOption<java.lang.Boolean>	ChannelOption.SO_BROADCAST
static ChannelOption<java.lang.Boolean>	ChannelOption.SO_KEEPALIVE
static ChannelOption<java.lang.Integer>	ChannelOption.SO_LINGER
static ChannelOption<java.lang.Integer>	ChannelOption.SO_RCVBUF
static ChannelOption<java.lang.Boolean>	ChannelOption.SO_REUSEADDR
static ChannelOption<java.lang.Integer>	ChannelOption.SO_SNDBUF
static ChannelOption<java.lang.Integer>	ChannelOption.SO_TIMEOUT
static ChannelOption<java.lang.Integer>	ChannelOption.TCP_FASTOPEN Server-side TCP FastOpen.
static ChannelOption<java.lang.Boolean>	ChannelOption.TCP_FASTOPEN_CONNECT Client-side TCP FastOpen.
static ChannelOption<java.lang.Boolean>	ChannelOption.TCP_NODELAY
static ChannelOption<java.lang.Integer>	ChannelOption.WRITE_BUFFER_HIGH_WATER_MARK 已过时。 Use WRITE_BUFFER_WATER_MARK
static ChannelOption<java.lang.Integer>	ChannelOption.WRITE_BUFFER_LOW_WATER_MARK 已过时。 Use WRITE_BUFFER_WATER_MARK
static ChannelOption<WriteBufferWaterMark>	ChannelOption.WRITE_BUFFER_WATER_MARK
static ChannelOption<java.lang.Integer>	ChannelOption.WRITE_SPIN_COUNT

返回ChannelOption的io.netty.channel中的方法

限定符和类型	方法和说明
static <T> ChannelOption<T>	ChannelOption.newInstance(java.lang.String name) 已过时。 use valueOf(String).
static <T> ChannelOption<T>	ChannelOption.valueOf(java.lang.Class<?> firstNameComponent, java.lang.String secondNameComponent) Shortcut of valueOf(firstNameComponent.getName() + "#" + secondNameComponent).
static <T> ChannelOption<T>	ChannelOption.valueOf(java.lang.String name) Returns the ChannelOption of the specified name.

返回变量类型为ChannelOption的类型的io.netty.channel中的方法

限定符和类型	方法和说明
java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	ChannelConfig.getOptions() Return all set ChannelOption's.
protected java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultChannelConfig.getOptions(java.util.Map<ChannelOption<?>,java.lang.Object> result, ChannelOption<?>... options)

参数类型为ChannelOption的io.netty.channel中的方法

限定符和类型	方法和说明
<T> T	DefaultChannelConfig.getOption(ChannelOption<T> option)
<T> T	ChannelConfig.getOption(ChannelOption<T> option) Return the value of the given ChannelOption
protected java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultChannelConfig.getOptions(java.util.Map<ChannelOption<?>,java.lang.Object> result, ChannelOption<?>... options)
<T> boolean	DefaultChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	ChannelConfig.setOption(ChannelOption<T> option, T value) Sets a configuration property with the specified name and value.
protected <T> void	DefaultChannelConfig.validate(ChannelOption<T> option, T value)

类型变量类型为ChannelOption的io.netty.channel中的方法参数

限定符和类型	方法和说明
protected java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultChannelConfig.getOptions(java.util.Map<ChannelOption<?>,java.lang.Object> result, ChannelOption<?>... options)
boolean	DefaultChannelConfig.setOptions(java.util.Map<ChannelOption<?>,?> options)
boolean	ChannelConfig.setOptions(java.util.Map<ChannelOption<?>,?> options) Sets the configuration properties from the specified Map.

io.netty.channel.epoll中ChannelOption的使用

io.netty.channel.epoll中ChannelOption的子类

限定符和类型	类和说明
class	EpollChannelOption<T>

声明为ChannelOption的io.netty.channel.epoll中的字段

限定符和类型	字段和说明
static ChannelOption<EpollMode>	EpollChannelOption.EPOLL_MODE
static ChannelOption<java.lang.Boolean>	EpollChannelOption.IP_FREEBIND
static ChannelOption<java.lang.Boolean>	EpollChannelOption.IP_RECVORIGDSTADDR
static ChannelOption<java.lang.Boolean>	EpollChannelOption.IP_TRANSPARENT
static ChannelOption<java.lang.Integer>	EpollChannelOption.MAX_DATAGRAM_PAYLOAD_SIZE
static ChannelOption<java.lang.Integer>	EpollChannelOption.SO_BUSY_POLL
static ChannelOption<java.lang.Boolean>	EpollChannelOption.TCP_CORK
static ChannelOption<java.lang.Integer>	EpollChannelOption.TCP_DEFER_ACCEPT
static ChannelOption<java.lang.Integer>	EpollChannelOption.TCP_FASTOPEN 已过时。 Use TCP_FASTOPEN instead.
static ChannelOption<java.lang.Boolean>	EpollChannelOption.TCP_FASTOPEN_CONNECT 已过时。 Use TCP_FASTOPEN_CONNECT instead.
static ChannelOption<java.lang.Integer>	EpollChannelOption.TCP_KEEPCNT
static ChannelOption<java.lang.Integer>	EpollChannelOption.TCP_KEEPIDLE
static ChannelOption<java.lang.Integer>	EpollChannelOption.TCP_KEEPINTVL
static ChannelOption<java.util.Map<java.net.InetAddress,byte[]>>	EpollChannelOption.TCP_MD5SIG
static ChannelOption<java.lang.Long>	EpollChannelOption.TCP_NOTSENT_LOWAT
static ChannelOption<java.lang.Boolean>	EpollChannelOption.TCP_QUICKACK
static ChannelOption<java.lang.Integer>	EpollChannelOption.TCP_USER_TIMEOUT
static ChannelOption<java.lang.Boolean>	EpollChannelOption.UDP_GRO

返回变量类型为ChannelOption的类型的io.netty.channel.epoll中的方法

限定符和类型	方法和说明
java.util.Map<ChannelOption<?>,java.lang.Object>	EpollSocketChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	EpollServerSocketChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	EpollServerChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	EpollDomainSocketChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	EpollDomainDatagramChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	EpollDatagramChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	EpollChannelConfig.getOptions()

参数类型为ChannelOption的io.netty.channel.epoll中的方法

限定符和类型	方法和说明
<T> T	EpollSocketChannelConfig.getOption(ChannelOption<T> option)
<T> T	EpollServerSocketChannelConfig.getOption(ChannelOption<T> option)
<T> T	EpollServerChannelConfig.getOption(ChannelOption<T> option)
<T> T	EpollDomainSocketChannelConfig.getOption(ChannelOption<T> option)
<T> T	EpollDomainDatagramChannelConfig.getOption(ChannelOption<T> option)
<T> T	EpollDatagramChannelConfig.getOption(ChannelOption<T> option)
<T> T	EpollChannelConfig.getOption(ChannelOption<T> option)
<T> boolean	EpollSocketChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	EpollServerSocketChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	EpollServerChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	EpollDomainSocketChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	EpollDomainDatagramChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	EpollDatagramChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	EpollChannelConfig.setOption(ChannelOption<T> option, T value)

io.netty.channel.kqueue中ChannelOption的使用

io.netty.channel.kqueue中ChannelOption的子类

限定符和类型	类和说明
class	KQueueChannelOption<T>

声明为ChannelOption的io.netty.channel.kqueue中的字段

限定符和类型	字段和说明
static ChannelOption<java.lang.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<java.lang.Integer>	KQueueChannelOption.SO_SNDLOWAT
static ChannelOption<java.lang.Boolean>	KQueueChannelOption.TCP_NOPUSH

返回变量类型为ChannelOption的类型的io.netty.channel.kqueue中的方法

限定符和类型	方法和说明
java.util.Map<ChannelOption<?>,java.lang.Object>	KQueueSocketChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	KQueueServerSocketChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	KQueueServerChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	KQueueDomainSocketChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	KQueueDomainDatagramChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	KQueueDatagramChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	KQueueChannelConfig.getOptions()

参数类型为ChannelOption的io.netty.channel.kqueue中的方法

限定符和类型	方法和说明
<T> T	KQueueSocketChannelConfig.getOption(ChannelOption<T> option)
<T> T	KQueueServerSocketChannelConfig.getOption(ChannelOption<T> option)
<T> T	KQueueServerChannelConfig.getOption(ChannelOption<T> option)
<T> T	KQueueDomainSocketChannelConfig.getOption(ChannelOption<T> option)
<T> T	KQueueDomainDatagramChannelConfig.getOption(ChannelOption<T> option)
<T> T	KQueueDatagramChannelConfig.getOption(ChannelOption<T> option)
<T> T	KQueueChannelConfig.getOption(ChannelOption<T> option)
<T> boolean	KQueueSocketChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	KQueueServerSocketChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	KQueueServerChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	KQueueDomainSocketChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	KQueueDomainDatagramChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	KQueueDatagramChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	KQueueChannelConfig.setOption(ChannelOption<T> option, T value)

io.netty.channel.rxtx中ChannelOption的使用

io.netty.channel.rxtx中ChannelOption的子类

限定符和类型	类和说明
class	RxtxChannelOption<T> 已过时。 this transport will be removed in the next major version.

声明为ChannelOption的io.netty.channel.rxtx中的字段

限定符和类型	字段和说明
static ChannelOption<java.lang.Integer>	RxtxChannelOption.BAUD_RATE 已过时。
static ChannelOption<RxtxChannelConfig.Databits>	RxtxChannelOption.DATA_BITS 已过时。
static ChannelOption<java.lang.Boolean>	RxtxChannelOption.DTR 已过时。
static ChannelOption<RxtxChannelConfig.Paritybit>	RxtxChannelOption.PARITY_BIT 已过时。
static ChannelOption<java.lang.Integer>	RxtxChannelOption.READ_TIMEOUT 已过时。
static ChannelOption<java.lang.Boolean>	RxtxChannelOption.RTS 已过时。
static ChannelOption<RxtxChannelConfig.Stopbits>	RxtxChannelOption.STOP_BITS 已过时。
static ChannelOption<java.lang.Integer>	RxtxChannelOption.WAIT_TIME 已过时。

io.netty.channel.sctp中ChannelOption的使用

io.netty.channel.sctp中ChannelOption的子类

限定符和类型	类和说明
class	SctpChannelOption<T> Option for configuring the SCTP transport

声明为ChannelOption的io.netty.channel.sctp中的字段

限定符和类型	字段和说明
static ChannelOption<java.lang.Boolean>	SctpChannelOption.SCTP_DISABLE_FRAGMENTS
static ChannelOption<java.lang.Boolean>	SctpChannelOption.SCTP_EXPLICIT_COMPLETE
static ChannelOption<java.lang.Integer>	SctpChannelOption.SCTP_FRAGMENT_INTERLEAVE
static ChannelOption<SctpStandardSocketOptions.InitMaxStreams>	SctpChannelOption.SCTP_INIT_MAXSTREAMS
static ChannelOption<java.lang.Boolean>	SctpChannelOption.SCTP_NODELAY
static ChannelOption<java.net.SocketAddress>	SctpChannelOption.SCTP_PRIMARY_ADDR
static ChannelOption<java.net.SocketAddress>	SctpChannelOption.SCTP_SET_PEER_PRIMARY_ADDR

返回变量类型为ChannelOption的类型的io.netty.channel.sctp中的方法

限定符和类型	方法和说明
java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultSctpServerChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultSctpChannelConfig.getOptions()

参数类型为ChannelOption的io.netty.channel.sctp中的方法

限定符和类型	方法和说明
<T> T	DefaultSctpServerChannelConfig.getOption(ChannelOption<T> option)
<T> T	DefaultSctpChannelConfig.getOption(ChannelOption<T> option)
<T> boolean	DefaultSctpServerChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	DefaultSctpChannelConfig.setOption(ChannelOption<T> option, T value)

io.netty.channel.socket中ChannelOption的使用

返回变量类型为ChannelOption的类型的io.netty.channel.socket中的方法

限定符和类型	方法和说明
java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultSocketChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultServerSocketChannelConfig.getOptions()
java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultDatagramChannelConfig.getOptions()

参数类型为ChannelOption的io.netty.channel.socket中的方法

限定符和类型	方法和说明
<T> T	DefaultSocketChannelConfig.getOption(ChannelOption<T> option)
<T> T	DefaultServerSocketChannelConfig.getOption(ChannelOption<T> option)
<T> T	DefaultDatagramChannelConfig.getOption(ChannelOption<T> option)
<T> boolean	DefaultSocketChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	DefaultServerSocketChannelConfig.setOption(ChannelOption<T> option, T value)
<T> boolean	DefaultDatagramChannelConfig.setOption(ChannelOption<T> option, T value)

io.netty.channel.socket.nio中ChannelOption的使用

io.netty.channel.socket.nio中ChannelOption的子类

限定符和类型	类和说明
class	NioChannelOption<T> Provides ChannelOption over a given SocketOption which is then passed through the underlying NetworkChannel.

返回ChannelOption的io.netty.channel.socket.nio中的方法

限定符和类型	方法和说明
static <T> ChannelOption<T>	NioChannelOption.of(java.net.SocketOption<T> option) Returns a ChannelOption for the given SocketOption.

io.netty.channel.socket.oio中ChannelOption的使用

返回变量类型为ChannelOption的类型的io.netty.channel.socket.oio中的方法

限定符和类型	方法和说明
java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultOioSocketChannelConfig.getOptions() 已过时。
java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultOioServerSocketChannelConfig.getOptions() 已过时。

参数类型为ChannelOption的io.netty.channel.socket.oio中的方法

限定符和类型	方法和说明
<T> T	DefaultOioSocketChannelConfig.getOption(ChannelOption<T> option) 已过时。
<T> T	DefaultOioServerSocketChannelConfig.getOption(ChannelOption<T> option) 已过时。
<T> boolean	DefaultOioSocketChannelConfig.setOption(ChannelOption<T> option, T value) 已过时。
<T> boolean	DefaultOioServerSocketChannelConfig.setOption(ChannelOption<T> option, T value) 已过时。

io.netty.channel.udt中ChannelOption的使用

io.netty.channel.udt中ChannelOption的子类

限定符和类型	类和说明
class	UdtChannelOption<T> 已过时。 The UDT transport is no longer maintained and will be removed.

声明为ChannelOption的io.netty.channel.udt中的字段

限定符和类型	字段和说明
static ChannelOption<java.lang.Integer>	UdtChannelOption.PROTOCOL_RECEIVE_BUFFER_SIZE 已过时。 See OptionUDT#Protocol_Receive_Buffer_Size.
static ChannelOption<java.lang.Integer>	UdtChannelOption.PROTOCOL_SEND_BUFFER_SIZE 已过时。 See OptionUDT#Protocol_Send_Buffer_Size.
static ChannelOption<java.lang.Integer>	UdtChannelOption.SYSTEM_RECEIVE_BUFFER_SIZE 已过时。 See OptionUDT#System_Receive_Buffer_Size.
static ChannelOption<java.lang.Integer>	UdtChannelOption.SYSTEM_SEND_BUFFER_SIZE 已过时。 See OptionUDT#System_Send_Buffer_Size.

返回变量类型为ChannelOption的类型的io.netty.channel.udt中的方法

限定符和类型	方法和说明
java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultUdtServerChannelConfig.getOptions() 已过时。
java.util.Map<ChannelOption<?>,java.lang.Object>	DefaultUdtChannelConfig.getOptions() 已过时。

参数类型为ChannelOption的io.netty.channel.udt中的方法

限定符和类型	方法和说明
<T> T	DefaultUdtServerChannelConfig.getOption(ChannelOption<T> option) 已过时。
<T> T	DefaultUdtChannelConfig.getOption(ChannelOption<T> option) 已过时。
<T> boolean	DefaultUdtServerChannelConfig.setOption(ChannelOption<T> option, T value) 已过时。
<T> boolean	DefaultUdtChannelConfig.setOption(ChannelOption<T> option, T value) 已过时。

io.netty.channel.unix中ChannelOption的使用

io.netty.channel.unix中ChannelOption的子类

限定符和类型	类和说明
class	GenericUnixChannelOption<T> A generic socket option.
class	IntegerUnixChannelOption A GenericUnixChannelOption which uses an Integer as optval.
class	RawUnixChannelOption A GenericUnixChannelOption which uses an ByteBuffer as optval.
class	UnixChannelOption<T>

声明为ChannelOption的io.netty.channel.unix中的字段

限定符和类型	字段和说明
static ChannelOption<DomainSocketReadMode>	UnixChannelOption.DOMAIN_SOCKET_READ_MODE
static ChannelOption<java.lang.Boolean>	UnixChannelOption.SO_REUSEPORT

io.netty.handler.codec.http2中ChannelOption的使用

参数类型为ChannelOption的io.netty.handler.codec.http2中的方法

限定符和类型	方法和说明
<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.