Class EpollSocketChannelConfig
java.lang.Object
io.netty.channel.DefaultChannelConfig
io.netty.channel.epoll.EpollChannelConfig
io.netty.channel.epoll.EpollSocketChannelConfig
- All Implemented Interfaces:
ChannelConfig, DuplexChannelConfig, SocketChannelConfig
public final class EpollSocketChannelConfig
extends EpollChannelConfig
implements SocketChannelConfig
-
Field Summary
Fields inherited from class DefaultChannelConfig
channel -
Method Summary
Modifier and TypeMethodDescription<T> TgetOption(ChannelOption<T> option) Return the value of the givenChannelOptionMap<ChannelOption<?>, Object> Return all setChannelOption's.intGets theStandardSocketOptions.SO_RCVBUFoption.intGets theStandardSocketOptions.SO_SNDBUFoption.intGet theSO_BUSY_POLLoption on the socket.intGets theStandardSocketOptions.SO_LINGERoption.intGet theTCP_KEEPCNToption on the socket.intGet theTCP_KEEPIDLEoption on the socket.intGet theTCP_KEEPINTVLoption on the socket.longGet theTCP_NOTSENT_LOWAToption on the socket.intGet theTCP_USER_TIMEOUToption on the socket.intGets theStandardSocketOptions.IP_TOSoption.booleanReturnstrueif and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed.booleanReturnstrueif the IP_BIND_ADDRESS_NO_PORT option is set.booleanbooleanGets theStandardSocketOptions.SO_KEEPALIVEoption.booleanGets theStandardSocketOptions.SO_REUSEADDRoption.booleanGet theTCP_CORKoption on the socket.booleanReturnstrueif TCP fast open is enabled,falseotherwise.booleanGets theStandardSocketOptions.TCP_NODELAYoption.booleansetAllocator(ByteBufAllocator allocator) Set theByteBufAllocatorwhich is used for the channel to allocate buffers.setAllowHalfClosure(boolean allowHalfClosure) Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.setAutoClose(boolean autoClose) Sets whether theChannelshould be closed automatically and immediately on write failure.setAutoRead(boolean autoRead) Sets ifChannelHandlerContext.read()will be invoked automatically so that a user application doesn't need to call it at all.setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.setEpollMode(EpollMode mode) Set theEpollModeused.setIpBindAddressNoPort(boolean ipBindAddressNoPort) Set the IP_BIND_ADDRESS_NO_PORT option on the underlying Channel.setIpTransparent(boolean transparent) setKeepAlive(boolean keepAlive) Sets theStandardSocketOptions.SO_KEEPALIVEoption.setMaxMessagesPerRead(int maxMessagesPerRead) Deprecated.setMessageSizeEstimator(MessageSizeEstimator estimator) Set theMessageSizeEstimatorwhich is used for the channel to detect the size of a message.<T> booleansetOption(ChannelOption<T> option, T value) Sets a configuration property with the specified name and value.setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets the performance preferences as specified inSocket.setPerformancePreferences(int, int, int).setReceiveBufferSize(int receiveBufferSize) Sets theStandardSocketOptions.SO_RCVBUFoption.setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set theRecvByteBufAllocatorwhich is used for the channel to allocate receive buffers.setReuseAddress(boolean reuseAddress) Sets theStandardSocketOptions.SO_REUSEADDRoption.setSendBufferSize(int sendBufferSize) Sets theStandardSocketOptions.SO_SNDBUFoption.setSoBusyPoll(int loopMicros) Set theSO_BUSY_POLLoption on the socket.setSoLinger(int soLinger) Sets theStandardSocketOptions.SO_LINGERoption.setTcpCork(boolean tcpCork) Set theTCP_CORKoption on the socket.setTcpFastOpenConnect(boolean fastOpenConnect) Enables client TCP fast open.setTcpKeepCnt(int probes) Set theTCP_KEEPCNToption on the socket.setTcpKeepCntl(int probes) Deprecated.setTcpKeepIdle(int seconds) Set theTCP_KEEPIDLEoption on the socket.setTcpKeepIntvl(int seconds) Set theTCP_KEEPINTVLoption on the socket.setTcpMd5Sig(Map<InetAddress, byte[]> keys) Set theTCP_MD5SIGoption on the socket.setTcpNoDelay(boolean tcpNoDelay) Sets theStandardSocketOptions.TCP_NODELAYoption.setTcpNotSentLowAt(long tcpNotSentLowAt) Set theTCP_NOTSENT_LOWAToption on the socket.setTcpQuickAck(boolean quickAck) Set theTCP_QUICKACKoption on the socket.setTcpUserTimeout(int milliseconds) Set theTCP_USER_TIMEOUToption on the socket.setTrafficClass(int trafficClass) Sets theStandardSocketOptions.IP_TOSoption.setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Deprecated.setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Deprecated.setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Set theWriteBufferWaterMarkwhich is used for setting the high and low water mark of the write buffer.setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation untilWritableByteChannel.write(ByteBuffer)returns a non-zero value.Methods inherited from class EpollChannelConfig
autoReadCleared, getEpollMode, getMaxBytesPerGatheringWrite, setMaxBytesPerGatheringWrite, socketMethods inherited from class DefaultChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setMaxMessagesPerWrite, setOptions, validate
-
Method Details
-
getOptions
Description copied from interface:ChannelConfigReturn all setChannelOption's.- Specified by:
getOptionsin interfaceChannelConfig- Overrides:
getOptionsin classEpollChannelConfig
-
getOption
Description copied from interface:ChannelConfigReturn the value of the givenChannelOption- Specified by:
getOptionin interfaceChannelConfig- Overrides:
getOptionin classEpollChannelConfig
-
setOption
Description copied from interface:ChannelConfigSets a configuration property with the specified name and value. To override this method properly, you must call the super class:public boolean setOption(ChannelOption<T> option, T value) { if (super.setOption(option, value)) { return true; } if (option.equals(additionalOption)) { .... return true; } return false; }- Specified by:
setOptionin interfaceChannelConfig- Overrides:
setOptionin classEpollChannelConfig- Returns:
trueif and only if the property has been set
-
getReceiveBufferSize
public int getReceiveBufferSize()Description copied from interface:SocketChannelConfigGets theStandardSocketOptions.SO_RCVBUFoption.- Specified by:
getReceiveBufferSizein interfaceSocketChannelConfig
-
getSendBufferSize
public int getSendBufferSize()Description copied from interface:SocketChannelConfigGets theStandardSocketOptions.SO_SNDBUFoption.- Specified by:
getSendBufferSizein interfaceSocketChannelConfig
-
getSoLinger
public int getSoLinger()Description copied from interface:SocketChannelConfigGets theStandardSocketOptions.SO_LINGERoption.- Specified by:
getSoLingerin interfaceSocketChannelConfig
-
getTrafficClass
public int getTrafficClass()Description copied from interface:SocketChannelConfigGets theStandardSocketOptions.IP_TOSoption.- Specified by:
getTrafficClassin interfaceSocketChannelConfig
-
isKeepAlive
public boolean isKeepAlive()Description copied from interface:SocketChannelConfigGets theStandardSocketOptions.SO_KEEPALIVEoption.- Specified by:
isKeepAlivein interfaceSocketChannelConfig
-
isReuseAddress
public boolean isReuseAddress()Description copied from interface:SocketChannelConfigGets theStandardSocketOptions.SO_REUSEADDRoption.- Specified by:
isReuseAddressin interfaceSocketChannelConfig
-
isTcpNoDelay
public boolean isTcpNoDelay()Description copied from interface:SocketChannelConfigGets theStandardSocketOptions.TCP_NODELAYoption. Please note that the default value of this option istrueunlike 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 befalse.- Specified by:
isTcpNoDelayin interfaceSocketChannelConfig
-
isTcpCork
public boolean isTcpCork()Get theTCP_CORKoption on the socket. Seeman 7 tcpfor more details. -
getSoBusyPoll
public int getSoBusyPoll()Get theSO_BUSY_POLLoption on the socket. Seeman 7 tcpfor more details. -
getTcpNotSentLowAt
public long getTcpNotSentLowAt()Get theTCP_NOTSENT_LOWAToption on the socket. Seeman 7 tcpfor more details.- Returns:
- value is a uint32_t
-
getTcpKeepIdle
public int getTcpKeepIdle()Get theTCP_KEEPIDLEoption on the socket. Seeman 7 tcpfor more details. -
getTcpKeepIntvl
public int getTcpKeepIntvl()Get theTCP_KEEPINTVLoption on the socket. Seeman 7 tcpfor more details. -
getTcpKeepCnt
public int getTcpKeepCnt()Get theTCP_KEEPCNToption on the socket. Seeman 7 tcpfor more details. -
getTcpUserTimeout
public int getTcpUserTimeout()Get theTCP_USER_TIMEOUToption on the socket. Seeman 7 tcpfor more details. -
setKeepAlive
Description copied from interface:SocketChannelConfigSets theStandardSocketOptions.SO_KEEPALIVEoption.- Specified by:
setKeepAlivein interfaceSocketChannelConfig
-
setPerformancePreferences
public EpollSocketChannelConfig setPerformancePreferences(int connectionTime, int latency, int bandwidth) Description copied from interface:SocketChannelConfigSets the performance preferences as specified inSocket.setPerformancePreferences(int, int, int).- Specified by:
setPerformancePreferencesin interfaceSocketChannelConfig
-
setReceiveBufferSize
Description copied from interface:SocketChannelConfigSets theStandardSocketOptions.SO_RCVBUFoption.- Specified by:
setReceiveBufferSizein interfaceSocketChannelConfig
-
setReuseAddress
Description copied from interface:SocketChannelConfigSets theStandardSocketOptions.SO_REUSEADDRoption.- Specified by:
setReuseAddressin interfaceSocketChannelConfig
-
setSendBufferSize
Description copied from interface:SocketChannelConfigSets theStandardSocketOptions.SO_SNDBUFoption.- Specified by:
setSendBufferSizein interfaceSocketChannelConfig
-
setSoLinger
Description copied from interface:SocketChannelConfigSets theStandardSocketOptions.SO_LINGERoption.- Specified by:
setSoLingerin interfaceSocketChannelConfig
-
setTcpNoDelay
Description copied from interface:SocketChannelConfigSets theStandardSocketOptions.TCP_NODELAYoption. Please note that the default value of this option istrueunlike 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 befalse.- Specified by:
setTcpNoDelayin interfaceSocketChannelConfig
-
setTcpCork
Set theTCP_CORKoption on the socket. Seeman 7 tcpfor more details. -
setSoBusyPoll
Set theSO_BUSY_POLLoption on the socket. Seeman 7 tcpfor more details. -
setTcpNotSentLowAt
Set theTCP_NOTSENT_LOWAToption on the socket. Seeman 7 tcpfor more details.- Parameters:
tcpNotSentLowAt- is a uint32_t
-
setTrafficClass
Description copied from interface:SocketChannelConfigSets theStandardSocketOptions.IP_TOSoption.- Specified by:
setTrafficClassin interfaceSocketChannelConfig
-
setTcpKeepIdle
Set theTCP_KEEPIDLEoption on the socket. Seeman 7 tcpfor more details. -
setTcpKeepIntvl
Set theTCP_KEEPINTVLoption on the socket. Seeman 7 tcpfor more details. -
setTcpKeepCntl
Deprecated. -
setTcpKeepCnt
Set theTCP_KEEPCNToption on the socket. Seeman 7 tcpfor more details. -
setTcpUserTimeout
Set theTCP_USER_TIMEOUToption on the socket. Seeman 7 tcpfor more details. -
isIpBindAddressNoPort
public boolean isIpBindAddressNoPort()Returnstrueif the IP_BIND_ADDRESS_NO_PORT option is set. -
setIpBindAddressNoPort
Set the IP_BIND_ADDRESS_NO_PORT option on the underlying Channel. Be aware this method needs be called beforeChannel.bind(java.net.SocketAddress)to have any affect. -
isIpTransparent
public boolean isIpTransparent() -
setIpTransparent
-
setTcpMd5Sig
Set theTCP_MD5SIGoption on the socket. Seelinux/tcp.hfor 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. -
setTcpQuickAck
Set theTCP_QUICKACKoption on the socket. See TCP_QUICKACK for more details. -
isTcpQuickAck
public boolean isTcpQuickAck() -
setTcpFastOpenConnect
Enables client TCP fast open.TCP_FASTOPEN_CONNECTnormally 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. -
isTcpFastOpenConnect
public boolean isTcpFastOpenConnect()Returnstrueif TCP fast open is enabled,falseotherwise. -
isAllowHalfClosure
public boolean isAllowHalfClosure()Description copied from interface:DuplexChannelConfigReturnstrueif and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed. Iffalse, the connection is closed automatically when the remote peer shuts down output.- Specified by:
isAllowHalfClosurein interfaceDuplexChannelConfig
-
setAllowHalfClosure
Description copied from interface:DuplexChannelConfigSets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed. Iftruethe connection is not closed when the remote peer shuts down output. Instead,ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object)is invoked with aChannelInputShutdownEventobject. Iffalse, the connection is closed automatically.- Specified by:
setAllowHalfClosurein interfaceDuplexChannelConfig- Specified by:
setAllowHalfClosurein interfaceSocketChannelConfig
-
setConnectTimeoutMillis
Description copied from interface:ChannelConfigSets the connect timeout of the channel in milliseconds. If theChanneldoes not support connect operation, this property is not used at all, and therefore will be ignored.- Specified by:
setConnectTimeoutMillisin interfaceChannelConfig- Specified by:
setConnectTimeoutMillisin interfaceSocketChannelConfig- Overrides:
setConnectTimeoutMillisin classEpollChannelConfig- Parameters:
connectTimeoutMillis- the connect timeout in milliseconds.0to disable.
-
setMaxMessagesPerRead
Deprecated.Description copied from class:DefaultChannelConfig- Specified by:
setMaxMessagesPerReadin interfaceChannelConfig- Specified by:
setMaxMessagesPerReadin interfaceDuplexChannelConfig- Specified by:
setMaxMessagesPerReadin interfaceSocketChannelConfig- Overrides:
setMaxMessagesPerReadin classEpollChannelConfig
-
setWriteSpinCount
Description copied from interface:ChannelConfigSets the maximum loop count for a write operation untilWritableByteChannel.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 is16.- Specified by:
setWriteSpinCountin interfaceChannelConfig- Specified by:
setWriteSpinCountin interfaceDuplexChannelConfig- Specified by:
setWriteSpinCountin interfaceSocketChannelConfig- Overrides:
setWriteSpinCountin classEpollChannelConfig
-
setAllocator
Description copied from interface:ChannelConfigSet theByteBufAllocatorwhich is used for the channel to allocate buffers.- Specified by:
setAllocatorin interfaceChannelConfig- Specified by:
setAllocatorin interfaceDuplexChannelConfig- Specified by:
setAllocatorin interfaceSocketChannelConfig- Overrides:
setAllocatorin classEpollChannelConfig
-
setRecvByteBufAllocator
Description copied from interface:ChannelConfigSet theRecvByteBufAllocatorwhich is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocatorin interfaceChannelConfig- Specified by:
setRecvByteBufAllocatorin interfaceDuplexChannelConfig- Specified by:
setRecvByteBufAllocatorin interfaceSocketChannelConfig- Overrides:
setRecvByteBufAllocatorin classEpollChannelConfig
-
setAutoRead
Description copied from interface:ChannelConfigSets ifChannelHandlerContext.read()will be invoked automatically so that a user application doesn't need to call it at all. The default value istrue.- Specified by:
setAutoReadin interfaceChannelConfig- Specified by:
setAutoReadin interfaceDuplexChannelConfig- Specified by:
setAutoReadin interfaceSocketChannelConfig- Overrides:
setAutoReadin classEpollChannelConfig
-
setAutoClose
Description copied from interface:ChannelConfigSets whether theChannelshould be closed automatically and immediately on write failure. The default istrue.- Specified by:
setAutoClosein interfaceChannelConfig- Specified by:
setAutoClosein interfaceDuplexChannelConfig- Specified by:
setAutoClosein interfaceSocketChannelConfig- Overrides:
setAutoClosein classDefaultChannelConfig
-
setWriteBufferHighWaterMark
@Deprecated public EpollSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Deprecated.Description copied from interface:ChannelConfigSets 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 returnfalse.- Specified by:
setWriteBufferHighWaterMarkin interfaceChannelConfig- Overrides:
setWriteBufferHighWaterMarkin classEpollChannelConfig
-
setWriteBufferLowWaterMark
Deprecated.Description copied from interface:ChannelConfigSets 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 returntrueagain.- Specified by:
setWriteBufferLowWaterMarkin interfaceChannelConfig- Overrides:
setWriteBufferLowWaterMarkin classEpollChannelConfig
-
setWriteBufferWaterMark
Description copied from interface:ChannelConfigSet theWriteBufferWaterMarkwhich is used for setting the high and low water mark of the write buffer.- Specified by:
setWriteBufferWaterMarkin interfaceChannelConfig- Specified by:
setWriteBufferWaterMarkin interfaceDuplexChannelConfig- Specified by:
setWriteBufferWaterMarkin interfaceSocketChannelConfig- Overrides:
setWriteBufferWaterMarkin classEpollChannelConfig
-
setMessageSizeEstimator
Description copied from interface:ChannelConfigSet theMessageSizeEstimatorwhich is used for the channel to detect the size of a message.- Specified by:
setMessageSizeEstimatorin interfaceChannelConfig- Specified by:
setMessageSizeEstimatorin interfaceDuplexChannelConfig- Specified by:
setMessageSizeEstimatorin interfaceSocketChannelConfig- Overrides:
setMessageSizeEstimatorin classEpollChannelConfig
-
setEpollMode
Description copied from class:EpollChannelConfigSet theEpollModeused. Default isEpollMode.EDGE_TRIGGERED. If you want to useDefaultChannelConfig.isAutoRead()falseorDefaultChannelConfig.getMaxMessagesPerRead()and have an accurate behaviour you should useEpollMode.LEVEL_TRIGGERED. Be aware this config setting can only be adjusted before the channel was registered.- Overrides:
setEpollModein classEpollChannelConfig
-
setTcpKeepCnt(int)