Package io.netty.channel.epoll
Class EpollServerSocketChannelConfig
java.lang.Object
io.netty.channel.DefaultChannelConfig
io.netty.channel.epoll.EpollChannelConfig
io.netty.channel.epoll.EpollServerChannelConfig
io.netty.channel.epoll.EpollServerSocketChannelConfig
- All Implemented Interfaces:
ChannelConfig
,ServerSocketChannelConfig
public final class EpollServerSocketChannelConfig
extends EpollServerChannelConfig
implements ServerSocketChannelConfig
-
Field Summary
Fields inherited from class io.netty.channel.DefaultChannelConfig
channel
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription<T> T
getOption
(ChannelOption<T> option) Return the value of the givenChannelOption
Map
<ChannelOption<?>, Object> Return all setChannelOption
's.int
Returns a positive value if TCP_DEFER_ACCEPT is enabled.boolean
boolean
boolean
Returnstrue
if the SO_REUSEPORT option is set.setAllocator
(ByteBufAllocator allocator) Set theByteBufAllocator
which 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.setFreeBind
(boolean freeBind) setIpTransparent
(boolean transparent) setMaxMessagesPerRead
(int maxMessagesPerRead) Deprecated.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.setPerformancePreferences
(int connectionTime, int latency, int bandwidth) Sets the performance preferences as specified inServerSocket.setPerformancePreferences(int, int, int)
.setReceiveBufferSize
(int receiveBufferSize) Gets theStandardSocketOptions.SO_SNDBUF
option.setRecvByteBufAllocator
(RecvByteBufAllocator allocator) Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.setReuseAddress
(boolean reuseAddress) Sets theStandardSocketOptions.SO_REUSEADDR
option.setReusePort
(boolean reusePort) Set the SO_REUSEPORT option on the underlying Channel.setTcpDeferAccept
(int deferAccept) Set theTCP_DEFER_ACCEPT
option on the socket.setTcpMd5Sig
(Map<InetAddress, byte[]> keys) Set theTCP_MD5SIG
option on the socket.setWriteBufferHighWaterMark
(int writeBufferHighWaterMark) Deprecated.setWriteBufferLowWaterMark
(int writeBufferLowWaterMark) Deprecated.setWriteBufferWaterMark
(WriteBufferWaterMark writeBufferWaterMark) Set theWriteBufferWaterMark
which 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 io.netty.channel.epoll.EpollServerChannelConfig
getBacklog, getReceiveBufferSize, getTcpFastopen, isReuseAddress, setEpollMode, setTcpFastopen
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
Methods inherited from interface io.netty.channel.socket.ServerSocketChannelConfig
getBacklog, getReceiveBufferSize, isReuseAddress
-
Constructor Details
-
EpollServerSocketChannelConfig
EpollServerSocketChannelConfig(EpollServerSocketChannel channel)
-
-
Method Details
-
getOptions
Description copied from interface:ChannelConfig
Return all setChannelOption
's.- Specified by:
getOptions
in interfaceChannelConfig
- Overrides:
getOptions
in classEpollServerChannelConfig
-
getOption
Description copied from interface:ChannelConfig
Return the value of the givenChannelOption
- Specified by:
getOption
in interfaceChannelConfig
- Overrides:
getOption
in classEpollServerChannelConfig
-
setOption
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 classEpollServerChannelConfig
- Returns:
true
if and only if the property has been set
-
setReuseAddress
Description copied from interface:ServerSocketChannelConfig
Sets theStandardSocketOptions.SO_REUSEADDR
option.- Specified by:
setReuseAddress
in interfaceServerSocketChannelConfig
- Overrides:
setReuseAddress
in classEpollServerChannelConfig
-
setReceiveBufferSize
Description copied from interface:ServerSocketChannelConfig
Gets theStandardSocketOptions.SO_SNDBUF
option.- Specified by:
setReceiveBufferSize
in interfaceServerSocketChannelConfig
- Overrides:
setReceiveBufferSize
in classEpollServerChannelConfig
-
setPerformancePreferences
public EpollServerSocketChannelConfig 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
- Overrides:
setPerformancePreferences
in classEpollServerChannelConfig
-
setBacklog
Description copied from interface:ServerSocketChannelConfig
Sets the backlog value to specify when the channel binds to a local address.- Specified by:
setBacklog
in interfaceServerSocketChannelConfig
- Overrides:
setBacklog
in classEpollServerChannelConfig
-
setConnectTimeoutMillis
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 classEpollServerChannelConfig
- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
setMaxMessagesPerRead
Deprecated.Description copied from class:DefaultChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceServerSocketChannelConfig
- Overrides:
setMaxMessagesPerRead
in classEpollServerChannelConfig
-
setWriteSpinCount
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 classEpollServerChannelConfig
-
setAllocator
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 classEpollServerChannelConfig
-
setRecvByteBufAllocator
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 classEpollServerChannelConfig
-
setAutoRead
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 classEpollServerChannelConfig
-
setWriteBufferHighWaterMark
@Deprecated public EpollServerSocketChannelConfig 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 classEpollServerChannelConfig
-
setWriteBufferLowWaterMark
@Deprecated public EpollServerSocketChannelConfig 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 classEpollServerChannelConfig
-
setWriteBufferWaterMark
public EpollServerSocketChannelConfig 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 classEpollServerChannelConfig
-
setMessageSizeEstimator
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 classEpollServerChannelConfig
-
setTcpMd5Sig
Set theTCP_MD5SIG
option on the socket. Seelinux/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. -
isReusePort
public boolean isReusePort()Returnstrue
if the SO_REUSEPORT option is set. -
setReusePort
Set the SO_REUSEPORT option on the underlying Channel. This will allow to bind multipleEpollSocketChannel
s to the same port and so accept connections with multiple threads. Be aware this method needs be called beforeAbstractChannel.bind(java.net.SocketAddress)
to have any affect. -
isFreeBind
public boolean isFreeBind() -
setFreeBind
-
isIpTransparent
public boolean isIpTransparent() -
setIpTransparent
-
setTcpDeferAccept
Set theTCP_DEFER_ACCEPT
option on the socket. Seeman 7 tcp
for more details. -
getTcpDeferAccept
public int getTcpDeferAccept()Returns a positive value if TCP_DEFER_ACCEPT is enabled.
-