Package io.netty.channel.kqueue
Class KQueueServerChannelConfig
java.lang.Object
io.netty.channel.DefaultChannelConfig
io.netty.channel.kqueue.KQueueChannelConfig
io.netty.channel.kqueue.KQueueServerChannelConfig
- All Implemented Interfaces:
ChannelConfig
,ServerSocketChannelConfig
- Direct Known Subclasses:
KQueueServerSocketChannelConfig
@UnstableApi
public class KQueueServerChannelConfig
extends KQueueChannelConfig
implements ServerSocketChannelConfig
-
Field Summary
FieldsFields inherited from class io.netty.channel.DefaultChannelConfig
channel
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
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
Map
<ChannelOption<?>, Object> Return all setChannelOption
's.int
Gets theStandardSocketOptions.SO_RCVBUF
option.boolean
Gets theStandardSocketOptions.SO_REUSEADDR
option.boolean
Returnstrue
if TCP FastOpen is enabled.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.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)
.setRcvAllocTransportProvidesGuess
(boolean transportProvidesGuess) If this istrue
then theRecvByteBufAllocator.Handle.guess()
will be overridden to always attempt to read as many bytes as kqueue says are available.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.setTcpFastOpen
(boolean enableTcpFastOpen) Enables TCP FastOpen on the server channel.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.kqueue.KQueueChannelConfig
autoReadCleared, getMaxBytesPerGatheringWrite, getRcvAllocTransportProvidesGuess, setMaxBytesPerGatheringWrite
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
-
Field Details
-
backlog
private volatile int backlog -
enableTcpFastOpen
private volatile boolean enableTcpFastOpen
-
-
Constructor Details
-
KQueueServerChannelConfig
KQueueServerChannelConfig(AbstractKQueueChannel channel)
-
-
Method Details
-
getOptions
Description copied from interface:ChannelConfig
Return all setChannelOption
's.- Specified by:
getOptions
in interfaceChannelConfig
- Overrides:
getOptions
in classKQueueChannelConfig
-
getOption
Description copied from interface:ChannelConfig
Return the value of the givenChannelOption
- Specified by:
getOption
in interfaceChannelConfig
- Overrides:
getOption
in classKQueueChannelConfig
-
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 classKQueueChannelConfig
- 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
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
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
Description copied from interface:ServerSocketChannelConfig
Sets the backlog value to specify when the channel binds to a local address.- Specified by:
setBacklog
in interfaceServerSocketChannelConfig
-
isTcpFastOpen
public boolean isTcpFastOpen()Returnstrue
if TCP FastOpen is enabled.- See Also:
-
setTcpFastOpen
Enables TCP FastOpen 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:
enableTcpFastOpen
-true
if TCP FastOpen should be enabled for incomming connections.- See Also:
-
setRcvAllocTransportProvidesGuess
Description copied from class:KQueueChannelConfig
If this istrue
then theRecvByteBufAllocator.Handle.guess()
will be overridden to always attempt to read as many bytes as kqueue says are available.- Overrides:
setRcvAllocTransportProvidesGuess
in classKQueueChannelConfig
-
setPerformancePreferences
public KQueueServerChannelConfig 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
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 classKQueueChannelConfig
- 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 classKQueueChannelConfig
-
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 classKQueueChannelConfig
-
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 classKQueueChannelConfig
-
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 classKQueueChannelConfig
-
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 classKQueueChannelConfig
-
setWriteBufferHighWaterMark
@Deprecated public KQueueServerChannelConfig 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 classKQueueChannelConfig
-
setWriteBufferLowWaterMark
@Deprecated public KQueueServerChannelConfig 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 classKQueueChannelConfig
-
setWriteBufferWaterMark
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 classKQueueChannelConfig
-
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 classKQueueChannelConfig
-