public final class EpollSocketChannelConfig extends EpollChannelConfig implements SocketChannelConfig
channel| 限定符和类型 | 方法和说明 |
|---|---|
<T> T |
getOption(ChannelOption<T> option)
Return the value of the given
ChannelOption |
java.util.Map<ChannelOption<?>,java.lang.Object> |
getOptions()
Return all set
ChannelOption's. |
int |
getReceiveBufferSize()
Gets the
StandardSocketOptions.SO_RCVBUF option. |
int |
getSendBufferSize()
Gets the
StandardSocketOptions.SO_SNDBUF option. |
int |
getSoBusyPoll()
Get the
SO_BUSY_POLL option on the socket. |
int |
getSoLinger()
Gets the
StandardSocketOptions.SO_LINGER option. |
int |
getTcpKeepCnt()
Get the
TCP_KEEPCNT option on the socket. |
int |
getTcpKeepIdle()
Get the
TCP_KEEPIDLE option on the socket. |
int |
getTcpKeepIntvl()
Get the
TCP_KEEPINTVL option on the socket. |
long |
getTcpNotSentLowAt()
Get the
TCP_NOTSENT_LOWAT option on the socket. |
int |
getTcpUserTimeout()
Get the
TCP_USER_TIMEOUT option on the socket. |
int |
getTrafficClass()
Gets the
StandardSocketOptions.IP_TOS option. |
boolean |
isAllowHalfClosure()
Returns
true if and only if the channel should not close itself when its remote
peer shuts down output to make the connection half-closed. |
boolean |
isIpTransparent()
|
boolean |
isKeepAlive()
Gets the
StandardSocketOptions.SO_KEEPALIVE option. |
boolean |
isReuseAddress()
Gets the
StandardSocketOptions.SO_REUSEADDR option. |
boolean |
isTcpCork()
Get the
TCP_CORK option on the socket. |
boolean |
isTcpFastOpenConnect()
Returns
true if TCP fast open is enabled, false otherwise. |
boolean |
isTcpNoDelay()
Gets the
StandardSocketOptions.TCP_NODELAY option. |
boolean |
isTcpQuickAck()
|
EpollSocketChannelConfig |
setAllocator(ByteBufAllocator allocator)
Set the
ByteBufAllocator which is used for the channel
to allocate buffers. |
EpollSocketChannelConfig |
setAllowHalfClosure(boolean allowHalfClosure)
Sets whether the channel should not close itself when its remote peer shuts down output to
make the connection half-closed.
|
EpollSocketChannelConfig |
setAutoClose(boolean autoClose)
Sets whether the
Channel should be closed automatically and immediately on write failure. |
EpollSocketChannelConfig |
setAutoRead(boolean autoRead)
Sets if
ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't
need to call it at all. |
EpollSocketChannelConfig |
setConnectTimeoutMillis(int connectTimeoutMillis)
Sets the connect timeout of the channel in milliseconds.
|
EpollSocketChannelConfig |
setEpollMode(EpollMode mode)
Set the
EpollMode used. |
EpollSocketChannelConfig |
setIpTransparent(boolean transparent)
|
EpollSocketChannelConfig |
setKeepAlive(boolean keepAlive)
Sets the
StandardSocketOptions.SO_KEEPALIVE option. |
EpollSocketChannelConfig |
setMaxMessagesPerRead(int maxMessagesPerRead)
已过时。
|
EpollSocketChannelConfig |
setMessageSizeEstimator(MessageSizeEstimator estimator)
Set the
MessageSizeEstimator which is used for the channel
to detect the size of a message. |
<T> boolean |
setOption(ChannelOption<T> option,
T value)
Sets a configuration property with the specified name and value.
|
EpollSocketChannelConfig |
setPerformancePreferences(int connectionTime,
int latency,
int bandwidth)
Sets the performance preferences as specified in
Socket.setPerformancePreferences(int, int, int). |
EpollSocketChannelConfig |
setReceiveBufferSize(int receiveBufferSize)
Sets the
StandardSocketOptions.SO_RCVBUF option. |
EpollSocketChannelConfig |
setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Set the
RecvByteBufAllocator which is used for the channel to allocate receive buffers. |
EpollSocketChannelConfig |
setReuseAddress(boolean reuseAddress)
Sets the
StandardSocketOptions.SO_REUSEADDR option. |
EpollSocketChannelConfig |
setSendBufferSize(int sendBufferSize)
Sets the
StandardSocketOptions.SO_SNDBUF option. |
EpollSocketChannelConfig |
setSoBusyPoll(int loopMicros)
Set the
SO_BUSY_POLL option on the socket. |
EpollSocketChannelConfig |
setSoLinger(int soLinger)
Sets the
StandardSocketOptions.SO_LINGER option. |
EpollSocketChannelConfig |
setTcpCork(boolean tcpCork)
Set the
TCP_CORK option on the socket. |
EpollSocketChannelConfig |
setTcpFastOpenConnect(boolean fastOpenConnect)
Enables client TCP fast open.
|
EpollSocketChannelConfig |
setTcpKeepCnt(int probes)
Set the
TCP_KEEPCNT option on the socket. |
EpollSocketChannelConfig |
setTcpKeepCntl(int probes)
已过时。
|
EpollSocketChannelConfig |
setTcpKeepIdle(int seconds)
Set the
TCP_KEEPIDLE option on the socket. |
EpollSocketChannelConfig |
setTcpKeepIntvl(int seconds)
Set the
TCP_KEEPINTVL option on the socket. |
EpollSocketChannelConfig |
setTcpMd5Sig(java.util.Map<java.net.InetAddress,byte[]> keys)
Set the
TCP_MD5SIG option on the socket. |
EpollSocketChannelConfig |
setTcpNoDelay(boolean tcpNoDelay)
Sets the
StandardSocketOptions.TCP_NODELAY option. |
EpollSocketChannelConfig |
setTcpNotSentLowAt(long tcpNotSentLowAt)
Set the
TCP_NOTSENT_LOWAT option on the socket. |
EpollSocketChannelConfig |
setTcpQuickAck(boolean quickAck)
Set the
TCP_QUICKACK option on the socket. |
EpollSocketChannelConfig |
setTcpUserTimeout(int milliseconds)
Set the
TCP_USER_TIMEOUT option on the socket. |
EpollSocketChannelConfig |
setTrafficClass(int trafficClass)
Sets the
StandardSocketOptions.IP_TOS option. |
EpollSocketChannelConfig |
setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
已过时。
|
EpollSocketChannelConfig |
setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
已过时。
|
EpollSocketChannelConfig |
setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Set the
WriteBufferWaterMark which is used for setting the high and low
water mark of the write buffer. |
EpollSocketChannelConfig |
setWriteSpinCount(int writeSpinCount)
Sets the maximum loop count for a write operation until
WritableByteChannel.write(ByteBuffer) returns a non-zero value. |
autoReadCleared, getEpollMode, getMaxBytesPerGatheringWrite, setMaxBytesPerGatheringWrite, socketgetAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setMaxMessagesPerWrite, setOptions, validatepublic java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
ChannelConfigChannelOption's.getOptions 在接口中 ChannelConfiggetOptions 在类中 EpollChannelConfigpublic <T> T getOption(ChannelOption<T> option)
ChannelConfigChannelOptiongetOption 在接口中 ChannelConfiggetOption 在类中 EpollChannelConfigpublic <T> boolean setOption(ChannelOption<T> option, T value)
ChannelConfig
public boolean setOption(ChannelOption<T> option, T value) {
if (super.setOption(option, value)) {
return true;
}
if (option.equals(additionalOption)) {
....
return true;
}
return false;
}
setOption 在接口中 ChannelConfigsetOption 在类中 EpollChannelConfigtrue if and only if the property has been setpublic int getReceiveBufferSize()
SocketChannelConfigStandardSocketOptions.SO_RCVBUF option.getReceiveBufferSize 在接口中 SocketChannelConfigpublic int getSendBufferSize()
SocketChannelConfigStandardSocketOptions.SO_SNDBUF option.getSendBufferSize 在接口中 SocketChannelConfigpublic int getSoLinger()
SocketChannelConfigStandardSocketOptions.SO_LINGER option.getSoLinger 在接口中 SocketChannelConfigpublic int getTrafficClass()
SocketChannelConfigStandardSocketOptions.IP_TOS option.getTrafficClass 在接口中 SocketChannelConfigpublic boolean isKeepAlive()
SocketChannelConfigStandardSocketOptions.SO_KEEPALIVE option.isKeepAlive 在接口中 SocketChannelConfigpublic boolean isReuseAddress()
SocketChannelConfigStandardSocketOptions.SO_REUSEADDR option.isReuseAddress 在接口中 SocketChannelConfigpublic boolean isTcpNoDelay()
SocketChannelConfigStandardSocketOptions.TCP_NODELAY option. Please note that the default value of this option
is true unlike the operating system default (false). However, for some buggy platforms, such as
Android, that shows erratic behavior with Nagle's algorithm disabled, the default value remains to be
false.isTcpNoDelay 在接口中 SocketChannelConfigpublic boolean isTcpCork()
TCP_CORK option on the socket. See man 7 tcp for more details.public int getSoBusyPoll()
SO_BUSY_POLL option on the socket. See man 7 tcp for more details.public long getTcpNotSentLowAt()
TCP_NOTSENT_LOWAT option on the socket. See man 7 tcp for more details.public int getTcpKeepIdle()
TCP_KEEPIDLE option on the socket. See man 7 tcp for more details.public int getTcpKeepIntvl()
TCP_KEEPINTVL option on the socket. See man 7 tcp for more details.public int getTcpKeepCnt()
TCP_KEEPCNT option on the socket. See man 7 tcp for more details.public int getTcpUserTimeout()
TCP_USER_TIMEOUT option on the socket. See man 7 tcp for more details.public EpollSocketChannelConfig setKeepAlive(boolean keepAlive)
SocketChannelConfigStandardSocketOptions.SO_KEEPALIVE option.setKeepAlive 在接口中 SocketChannelConfigpublic EpollSocketChannelConfig setPerformancePreferences(int connectionTime, int latency, int bandwidth)
SocketChannelConfigSocket.setPerformancePreferences(int, int, int).setPerformancePreferences 在接口中 SocketChannelConfigpublic EpollSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)
SocketChannelConfigStandardSocketOptions.SO_RCVBUF option.setReceiveBufferSize 在接口中 SocketChannelConfigpublic EpollSocketChannelConfig setReuseAddress(boolean reuseAddress)
SocketChannelConfigStandardSocketOptions.SO_REUSEADDR option.setReuseAddress 在接口中 SocketChannelConfigpublic EpollSocketChannelConfig setSendBufferSize(int sendBufferSize)
SocketChannelConfigStandardSocketOptions.SO_SNDBUF option.setSendBufferSize 在接口中 SocketChannelConfigpublic EpollSocketChannelConfig setSoLinger(int soLinger)
SocketChannelConfigStandardSocketOptions.SO_LINGER option.setSoLinger 在接口中 SocketChannelConfigpublic EpollSocketChannelConfig setTcpNoDelay(boolean tcpNoDelay)
SocketChannelConfigStandardSocketOptions.TCP_NODELAY option. Please note that the default value of this option
is true unlike the operating system default (false). However, for some buggy platforms, such as
Android, that shows erratic behavior with Nagle's algorithm disabled, the default value remains to be
false.setTcpNoDelay 在接口中 SocketChannelConfigpublic EpollSocketChannelConfig setTcpCork(boolean tcpCork)
TCP_CORK option on the socket. See man 7 tcp for more details.public EpollSocketChannelConfig setSoBusyPoll(int loopMicros)
SO_BUSY_POLL option on the socket. See man 7 tcp for more details.public EpollSocketChannelConfig setTcpNotSentLowAt(long tcpNotSentLowAt)
TCP_NOTSENT_LOWAT option on the socket. See man 7 tcp for more details.tcpNotSentLowAt - is a uint32_tpublic EpollSocketChannelConfig setTrafficClass(int trafficClass)
SocketChannelConfigStandardSocketOptions.IP_TOS option.setTrafficClass 在接口中 SocketChannelConfigpublic EpollSocketChannelConfig setTcpKeepIdle(int seconds)
TCP_KEEPIDLE option on the socket. See man 7 tcp for more details.public EpollSocketChannelConfig setTcpKeepIntvl(int seconds)
TCP_KEEPINTVL option on the socket. See man 7 tcp for more details.@Deprecated public EpollSocketChannelConfig setTcpKeepCntl(int probes)
setTcpKeepCnt(int)public EpollSocketChannelConfig setTcpKeepCnt(int probes)
TCP_KEEPCNT option on the socket. See man 7 tcp for more details.public EpollSocketChannelConfig setTcpUserTimeout(int milliseconds)
TCP_USER_TIMEOUT option on the socket. See man 7 tcp for more details.public boolean isIpTransparent()
public EpollSocketChannelConfig setIpTransparent(boolean transparent)
public EpollSocketChannelConfig setTcpMd5Sig(java.util.Map<java.net.InetAddress,byte[]> keys)
TCP_MD5SIG option on the socket. See linux/tcp.h for more details.
Keys can only be set on, not read to prevent a potential leak, as they are confidential.
Allowing them being read would mean anyone with access to the channel could get them.public EpollSocketChannelConfig setTcpQuickAck(boolean quickAck)
TCP_QUICKACK option on the socket.
See TCP_QUICKACK
for more details.public boolean isTcpQuickAck()
public EpollSocketChannelConfig setTcpFastOpenConnect(boolean fastOpenConnect)
TCP_FASTOPEN_CONNECT normally
requires Linux kernel 4.11 or later, so instead we use the traditional fast open
client socket mechanics that work with kernel 3.6 and later. See this
LWN article for more info.public boolean isTcpFastOpenConnect()
true if TCP fast open is enabled, false otherwise.public boolean isAllowHalfClosure()
DuplexChannelConfigtrue if and only if the channel should not close itself when its remote
peer shuts down output to make the connection half-closed. If false, the connection
is closed automatically when the remote peer shuts down output.isAllowHalfClosure 在接口中 DuplexChannelConfigpublic EpollSocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)
DuplexChannelConfigtrue the connection is not closed when the
remote peer shuts down output. Instead,
ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object)
is invoked with a ChannelInputShutdownEvent object. If false, the connection
is closed automatically.setAllowHalfClosure 在接口中 DuplexChannelConfigsetAllowHalfClosure 在接口中 SocketChannelConfigpublic EpollSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
ChannelConfigChannel does not support connect operation, this property is not
used at all, and therefore will be ignored.setConnectTimeoutMillis 在接口中 ChannelConfigsetConnectTimeoutMillis 在接口中 SocketChannelConfigsetConnectTimeoutMillis 在类中 EpollChannelConfigconnectTimeoutMillis - the connect timeout in milliseconds.
0 to disable.@Deprecated public EpollSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
DefaultChannelConfigsetMaxMessagesPerRead 在接口中 ChannelConfigsetMaxMessagesPerRead 在接口中 DuplexChannelConfigsetMaxMessagesPerRead 在接口中 SocketChannelConfigsetMaxMessagesPerRead 在类中 EpollChannelConfigpublic EpollSocketChannelConfig setWriteSpinCount(int writeSpinCount)
ChannelConfigWritableByteChannel.write(ByteBuffer) returns a non-zero value.
It is similar to what a spin lock is used for in concurrency programming.
It improves memory utilization and write throughput depending on
the platform that JVM runs on. The default value is 16.setWriteSpinCount 在接口中 ChannelConfigsetWriteSpinCount 在接口中 DuplexChannelConfigsetWriteSpinCount 在接口中 SocketChannelConfigsetWriteSpinCount 在类中 EpollChannelConfigpublic EpollSocketChannelConfig setAllocator(ByteBufAllocator allocator)
ChannelConfigByteBufAllocator which is used for the channel
to allocate buffers.setAllocator 在接口中 ChannelConfigsetAllocator 在接口中 DuplexChannelConfigsetAllocator 在接口中 SocketChannelConfigsetAllocator 在类中 EpollChannelConfigpublic EpollSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
ChannelConfigRecvByteBufAllocator which is used for the channel to allocate receive buffers.setRecvByteBufAllocator 在接口中 ChannelConfigsetRecvByteBufAllocator 在接口中 DuplexChannelConfigsetRecvByteBufAllocator 在接口中 SocketChannelConfigsetRecvByteBufAllocator 在类中 EpollChannelConfigpublic EpollSocketChannelConfig setAutoRead(boolean autoRead)
ChannelConfigChannelHandlerContext.read() will be invoked automatically so that a user application doesn't
need to call it at all. The default value is true.setAutoRead 在接口中 ChannelConfigsetAutoRead 在接口中 DuplexChannelConfigsetAutoRead 在接口中 SocketChannelConfigsetAutoRead 在类中 EpollChannelConfigpublic EpollSocketChannelConfig setAutoClose(boolean autoClose)
ChannelConfigChannel should be closed automatically and immediately on write failure.
The default is true.setAutoClose 在接口中 ChannelConfigsetAutoClose 在接口中 DuplexChannelConfigsetAutoClose 在接口中 SocketChannelConfigsetAutoClose 在类中 DefaultChannelConfig@Deprecated public EpollSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
ChannelConfig
Sets the high water mark of the write buffer. If the number of bytes
queued in the write buffer exceeds this value, Channel.isWritable()
will start to return false.
@Deprecated public EpollSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
ChannelConfig
Sets the low water mark of the write buffer. Once the number of bytes
queued in the write buffer exceeded the
high water mark and then
dropped down below this value, Channel.isWritable() will start to return
true again.
setWriteBufferLowWaterMark 在接口中 ChannelConfigsetWriteBufferLowWaterMark 在类中 EpollChannelConfigpublic EpollSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
ChannelConfigWriteBufferWaterMark which is used for setting the high and low
water mark of the write buffer.setWriteBufferWaterMark 在接口中 ChannelConfigsetWriteBufferWaterMark 在接口中 DuplexChannelConfigsetWriteBufferWaterMark 在接口中 SocketChannelConfigsetWriteBufferWaterMark 在类中 EpollChannelConfigpublic EpollSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
ChannelConfigMessageSizeEstimator which is used for the channel
to detect the size of a message.setMessageSizeEstimator 在接口中 ChannelConfigsetMessageSizeEstimator 在接口中 DuplexChannelConfigsetMessageSizeEstimator 在接口中 SocketChannelConfigsetMessageSizeEstimator 在类中 EpollChannelConfigpublic EpollSocketChannelConfig setEpollMode(EpollMode mode)
EpollChannelConfigEpollMode used. Default is
EpollMode.EDGE_TRIGGERED. If you want to use DefaultChannelConfig.isAutoRead() false or
DefaultChannelConfig.getMaxMessagesPerRead() and have an accurate behaviour you should use
EpollMode.LEVEL_TRIGGERED.
Be aware this config setting can only be adjusted before the channel was registered.setEpollMode 在类中 EpollChannelConfig