Package io.netty.channel.epoll
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 io.netty.channel.DefaultChannelConfig
channel
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
getBacklog()
Gets the backlog value to specify when the channel binds to a local address.<T> T
getOption(ChannelOption<T> option)
Return the value of the givenChannelOption
java.util.Map<ChannelOption<?>,java.lang.Object>
getOptions()
Return all setChannelOption
's.int
getReceiveBufferSize()
Gets theStandardSocketOptions.SO_RCVBUF
option.int
getTcpFastopen()
Returns threshold value of number of pending for fast open connect.boolean
isReuseAddress()
Gets theStandardSocketOptions.SO_REUSEADDR
option.EpollServerChannelConfig
setAllocator(ByteBufAllocator allocator)
Set theByteBufAllocator
which is used for the channel to allocate buffers.EpollServerChannelConfig
setAutoRead(boolean autoRead)
Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all.EpollServerChannelConfig
setBacklog(int backlog)
Sets the backlog value to specify when the channel binds to a local address.EpollServerChannelConfig
setConnectTimeoutMillis(int connectTimeoutMillis)
Sets the connect timeout of the channel in milliseconds.EpollServerChannelConfig
setEpollMode(EpollMode mode)
Set theEpollMode
used.EpollServerChannelConfig
setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.EpollServerChannelConfig
setMessageSizeEstimator(MessageSizeEstimator estimator)
Set theMessageSizeEstimator
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.EpollServerChannelConfig
setPerformancePreferences(int connectionTime, int latency, int bandwidth)
Sets the performance preferences as specified inServerSocket.setPerformancePreferences(int, int, int)
.EpollServerChannelConfig
setReceiveBufferSize(int receiveBufferSize)
Gets theStandardSocketOptions.SO_SNDBUF
option.EpollServerChannelConfig
setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.EpollServerChannelConfig
setReuseAddress(boolean reuseAddress)
Sets theStandardSocketOptions.SO_REUSEADDR
option.EpollServerChannelConfig
setTcpFastopen(int pendingFastOpenRequestsThreshold)
Enables tcpFastOpen on the server channel.EpollServerChannelConfig
setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Deprecated.EpollServerChannelConfig
setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Deprecated.EpollServerChannelConfig
setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.EpollServerChannelConfig
setWriteSpinCount(int writeSpinCount)
Sets the maximum loop count for a write operation untilWritableByteChannel.write(ByteBuffer)
returns a non-zero value.-
Methods inherited from class io.netty.channel.epoll.EpollChannelConfig
autoReadCleared, getEpollMode, getMaxBytesPerGatheringWrite, setMaxBytesPerGatheringWrite, socket
-
Methods inherited from class io.netty.channel.DefaultChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setMaxMessagesPerWrite, setOptions, validate
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setOptions
-
-
-
-
Method Detail
-
getOptions
public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
Description copied from interface:ChannelConfig
Return all setChannelOption
's.- Specified by:
getOptions
in interfaceChannelConfig
- Overrides:
getOptions
in classEpollChannelConfig
-
getOption
public <T> T getOption(ChannelOption<T> option)
Description copied from interface:ChannelConfig
Return the value of the givenChannelOption
- Specified by:
getOption
in interfaceChannelConfig
- Overrides:
getOption
in classEpollChannelConfig
-
setOption
public <T> boolean setOption(ChannelOption<T> option, T value)
Description copied from interface:ChannelConfig
Sets 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:
setOption
in interfaceChannelConfig
- Overrides:
setOption
in classEpollChannelConfig
- Returns:
true
if and only if the property has been set
-
isReuseAddress
public boolean isReuseAddress()
Description copied from interface:ServerSocketChannelConfig
Gets theStandardSocketOptions.SO_REUSEADDR
option.- Specified by:
isReuseAddress
in interfaceServerSocketChannelConfig
-
setReuseAddress
public EpollServerChannelConfig setReuseAddress(boolean reuseAddress)
Description copied from interface:ServerSocketChannelConfig
Sets theStandardSocketOptions.SO_REUSEADDR
option.- Specified by:
setReuseAddress
in interfaceServerSocketChannelConfig
-
getReceiveBufferSize
public int getReceiveBufferSize()
Description copied from interface:ServerSocketChannelConfig
Gets theStandardSocketOptions.SO_RCVBUF
option.- Specified by:
getReceiveBufferSize
in interfaceServerSocketChannelConfig
-
setReceiveBufferSize
public EpollServerChannelConfig setReceiveBufferSize(int receiveBufferSize)
Description copied from interface:ServerSocketChannelConfig
Gets theStandardSocketOptions.SO_SNDBUF
option.- Specified by:
setReceiveBufferSize
in interfaceServerSocketChannelConfig
-
getBacklog
public int getBacklog()
Description copied from interface:ServerSocketChannelConfig
Gets the backlog value to specify when the channel binds to a local address.- Specified by:
getBacklog
in interfaceServerSocketChannelConfig
-
setBacklog
public EpollServerChannelConfig setBacklog(int backlog)
Description copied from interface:ServerSocketChannelConfig
Sets the backlog value to specify when the channel binds to a local address.- Specified by:
setBacklog
in interfaceServerSocketChannelConfig
-
getTcpFastopen
public int getTcpFastopen()
Returns threshold value of number of pending for fast open connect.- See Also:
- RFC 7413 Passive Open
-
setTcpFastopen
public EpollServerChannelConfig setTcpFastopen(int pendingFastOpenRequestsThreshold)
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:
- RFC 7413 Passive Open
-
setPerformancePreferences
public EpollServerChannelConfig setPerformancePreferences(int connectionTime, int latency, int bandwidth)
Description copied from interface:ServerSocketChannelConfig
Sets the performance preferences as specified inServerSocket.setPerformancePreferences(int, int, int)
.- Specified by:
setPerformancePreferences
in interfaceServerSocketChannelConfig
-
setConnectTimeoutMillis
public EpollServerChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
Description copied from interface:ChannelConfig
Sets the connect timeout of the channel in milliseconds. If theChannel
does not support connect operation, this property is not used at all, and therefore will be ignored.- Specified by:
setConnectTimeoutMillis
in interfaceChannelConfig
- Specified by:
setConnectTimeoutMillis
in interfaceServerSocketChannelConfig
- Overrides:
setConnectTimeoutMillis
in classEpollChannelConfig
- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
setMaxMessagesPerRead
@Deprecated public EpollServerChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.Description copied from class:DefaultChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceServerSocketChannelConfig
- Overrides:
setMaxMessagesPerRead
in classEpollChannelConfig
-
setWriteSpinCount
public EpollServerChannelConfig setWriteSpinCount(int writeSpinCount)
Description copied from interface:ChannelConfig
Sets 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:
setWriteSpinCount
in interfaceChannelConfig
- Specified by:
setWriteSpinCount
in interfaceServerSocketChannelConfig
- Overrides:
setWriteSpinCount
in classEpollChannelConfig
-
setAllocator
public EpollServerChannelConfig setAllocator(ByteBufAllocator allocator)
Description copied from interface:ChannelConfig
Set theByteBufAllocator
which is used for the channel to allocate buffers.- Specified by:
setAllocator
in interfaceChannelConfig
- Specified by:
setAllocator
in interfaceServerSocketChannelConfig
- Overrides:
setAllocator
in classEpollChannelConfig
-
setRecvByteBufAllocator
public EpollServerChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Description copied from interface:ChannelConfig
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocator
in interfaceChannelConfig
- Specified by:
setRecvByteBufAllocator
in interfaceServerSocketChannelConfig
- Overrides:
setRecvByteBufAllocator
in classEpollChannelConfig
-
setAutoRead
public EpollServerChannelConfig setAutoRead(boolean autoRead)
Description copied from interface:ChannelConfig
Sets 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:
setAutoRead
in interfaceChannelConfig
- Specified by:
setAutoRead
in interfaceServerSocketChannelConfig
- Overrides:
setAutoRead
in classEpollChannelConfig
-
setWriteBufferHighWaterMark
@Deprecated public EpollServerChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Deprecated.Description copied from interface: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 returnfalse
.- Specified by:
setWriteBufferHighWaterMark
in interfaceChannelConfig
- Specified by:
setWriteBufferHighWaterMark
in interfaceServerSocketChannelConfig
- Overrides:
setWriteBufferHighWaterMark
in classEpollChannelConfig
-
setWriteBufferLowWaterMark
@Deprecated public EpollServerChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Deprecated.Description copied from interface: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 returntrue
again.- Specified by:
setWriteBufferLowWaterMark
in interfaceChannelConfig
- Specified by:
setWriteBufferLowWaterMark
in interfaceServerSocketChannelConfig
- Overrides:
setWriteBufferLowWaterMark
in classEpollChannelConfig
-
setWriteBufferWaterMark
public EpollServerChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Description copied from interface:ChannelConfig
Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.- Specified by:
setWriteBufferWaterMark
in interfaceChannelConfig
- Specified by:
setWriteBufferWaterMark
in interfaceServerSocketChannelConfig
- Overrides:
setWriteBufferWaterMark
in classEpollChannelConfig
-
setMessageSizeEstimator
public EpollServerChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
Description copied from interface:ChannelConfig
Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.- Specified by:
setMessageSizeEstimator
in interfaceChannelConfig
- Specified by:
setMessageSizeEstimator
in interfaceServerSocketChannelConfig
- Overrides:
setMessageSizeEstimator
in classEpollChannelConfig
-
setEpollMode
public EpollServerChannelConfig setEpollMode(EpollMode mode)
Description copied from class:EpollChannelConfig
Set theEpollMode
used. Default isEpollMode.EDGE_TRIGGERED
. If you want to useDefaultChannelConfig.isAutoRead()
false
orDefaultChannelConfig.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:
setEpollMode
in classEpollChannelConfig
-
-