Class EpollServerChannelConfig
java.lang.Object
io.netty.channel.DefaultChannelConfig
io.netty.channel.epoll.EpollChannelConfig
io.netty.channel.epoll.EpollServerChannelConfig
- All Implemented Interfaces:
ChannelConfig, ServerSocketChannelConfig
- Direct Known Subclasses:
EpollServerSocketChannelConfig
public class EpollServerChannelConfig
extends EpollChannelConfig
implements ServerSocketChannelConfig
-
Field Summary
Fields inherited from class DefaultChannelConfig
channel -
Method Summary
Modifier and TypeMethodDescriptionintGets the backlog value to specify when the channel binds to a local address.<T> TgetOption(ChannelOption<T> option) Return the value of the givenChannelOptionMap<ChannelOption<?>, Object> Return all setChannelOption's.intGets theStandardSocketOptions.SO_RCVBUFoption.intReturns threshold value of number of pending for fast open connect.booleanGets theStandardSocketOptions.SO_REUSEADDRoption.setAllocator(ByteBufAllocator allocator) Set theByteBufAllocatorwhich is used for the channel to allocate buffers.setAutoRead(boolean autoRead) Sets ifChannelHandlerContext.read()will be invoked automatically so that a user application doesn't need to call it at all.setBacklog(int backlog) Sets the backlog value to specify when the channel binds to a local address.setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.setEpollMode(EpollMode mode) Set theEpollModeused.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 inServerSocket.setPerformancePreferences(int, int, int).setReceiveBufferSize(int receiveBufferSize) Gets theStandardSocketOptions.SO_SNDBUFoption.setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set theRecvByteBufAllocatorwhich is used for the channel to allocate receive buffers.setReuseAddress(boolean reuseAddress) Sets theStandardSocketOptions.SO_REUSEADDRoption.setTcpFastopen(int pendingFastOpenRequestsThreshold) Enables tcpFastOpen on the server channel.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, setAutoClose, setMaxMessagesPerWrite, setOptions, validateMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setOptions
-
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
-
isReuseAddress
public boolean isReuseAddress()Description copied from interface:ServerSocketChannelConfigGets theStandardSocketOptions.SO_REUSEADDRoption.- Specified by:
isReuseAddressin interfaceServerSocketChannelConfig
-
setReuseAddress
Description copied from interface:ServerSocketChannelConfigSets theStandardSocketOptions.SO_REUSEADDRoption.- Specified by:
setReuseAddressin interfaceServerSocketChannelConfig
-
getReceiveBufferSize
public int getReceiveBufferSize()Description copied from interface:ServerSocketChannelConfigGets theStandardSocketOptions.SO_RCVBUFoption.- Specified by:
getReceiveBufferSizein interfaceServerSocketChannelConfig
-
setReceiveBufferSize
Description copied from interface:ServerSocketChannelConfigGets theStandardSocketOptions.SO_SNDBUFoption.- Specified by:
setReceiveBufferSizein interfaceServerSocketChannelConfig
-
getBacklog
public int getBacklog()Description copied from interface:ServerSocketChannelConfigGets the backlog value to specify when the channel binds to a local address.- Specified by:
getBacklogin interfaceServerSocketChannelConfig
-
setBacklog
Description copied from interface:ServerSocketChannelConfigSets the backlog value to specify when the channel binds to a local address.- Specified by:
setBacklogin interfaceServerSocketChannelConfig
-
getTcpFastopen
public int getTcpFastopen()Returns threshold value of number of pending for fast open connect.- See Also:
-
setTcpFastopen
Enables tcpFastOpen on the server channel. If the underlying os doesn't support TCP_FASTOPEN setting this has no effect. This has to be set before doing listen on the socket otherwise this takes no effect.- Parameters:
pendingFastOpenRequestsThreshold- number of requests to be pending for fastopen at a given point in time for security.- See Also:
-
setPerformancePreferences
public EpollServerChannelConfig setPerformancePreferences(int connectionTime, int latency, int bandwidth) Description copied from interface:ServerSocketChannelConfigSets the performance preferences as specified inServerSocket.setPerformancePreferences(int, int, int).- Specified by:
setPerformancePreferencesin interfaceServerSocketChannelConfig
-
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 interfaceServerSocketChannelConfig- 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 interfaceServerSocketChannelConfig- 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 interfaceServerSocketChannelConfig- 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 interfaceServerSocketChannelConfig- 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 interfaceServerSocketChannelConfig- 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 interfaceServerSocketChannelConfig- Overrides:
setAutoReadin classEpollChannelConfig
-
setWriteBufferHighWaterMark
@Deprecated public EpollServerChannelConfig 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- Specified by:
setWriteBufferHighWaterMarkin interfaceServerSocketChannelConfig- 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- Specified by:
setWriteBufferLowWaterMarkin interfaceServerSocketChannelConfig- 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 interfaceServerSocketChannelConfig- 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 interfaceServerSocketChannelConfig- 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
-