Package io.netty.channel.kqueue
Class KQueueServerSocketChannelConfig
- java.lang.Object
-
- io.netty.channel.DefaultChannelConfig
-
- io.netty.channel.kqueue.KQueueChannelConfig
-
- io.netty.channel.kqueue.KQueueServerChannelConfig
-
- io.netty.channel.kqueue.KQueueServerSocketChannelConfig
-
- All Implemented Interfaces:
ChannelConfig
,ServerSocketChannelConfig
public class KQueueServerSocketChannelConfig extends KQueueServerChannelConfig
-
-
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 AcceptFilter
getAcceptFilter()
<T> T
getOption(ChannelOption<T> option)
Return the value of the givenChannelOption
java.util.Map<ChannelOption<?>,java.lang.Object>
getOptions()
Return all setChannelOption
's.boolean
isReusePort()
KQueueServerSocketChannelConfig
setAcceptFilter(AcceptFilter acceptFilter)
KQueueServerSocketChannelConfig
setAllocator(ByteBufAllocator allocator)
Set theByteBufAllocator
which is used for the channel to allocate buffers.KQueueServerSocketChannelConfig
setAutoRead(boolean autoRead)
Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all.KQueueServerSocketChannelConfig
setBacklog(int backlog)
Sets the backlog value to specify when the channel binds to a local address.KQueueServerSocketChannelConfig
setConnectTimeoutMillis(int connectTimeoutMillis)
Sets the connect timeout of the channel in milliseconds.KQueueServerSocketChannelConfig
setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.KQueueServerSocketChannelConfig
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.KQueueServerSocketChannelConfig
setPerformancePreferences(int connectionTime, int latency, int bandwidth)
Sets the performance preferences as specified inServerSocket.setPerformancePreferences(int, int, int)
.KQueueServerSocketChannelConfig
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.KQueueServerSocketChannelConfig
setReceiveBufferSize(int receiveBufferSize)
Gets theStandardSocketOptions.SO_SNDBUF
option.KQueueServerSocketChannelConfig
setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.KQueueServerSocketChannelConfig
setReuseAddress(boolean reuseAddress)
Sets theStandardSocketOptions.SO_REUSEADDR
option.KQueueServerSocketChannelConfig
setReusePort(boolean reusePort)
KQueueServerSocketChannelConfig
setTcpFastOpen(boolean enableTcpFastOpen)
Enables TCP FastOpen on the server channel.KQueueServerSocketChannelConfig
setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Deprecated.KQueueServerSocketChannelConfig
setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Deprecated.KQueueServerSocketChannelConfig
setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.KQueueServerSocketChannelConfig
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.KQueueServerChannelConfig
getBacklog, getReceiveBufferSize, isReuseAddress, isTcpFastOpen
-
Methods inherited from class io.netty.channel.kqueue.KQueueChannelConfig
autoReadCleared, getRcvAllocTransportProvidesGuess
-
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 classKQueueServerChannelConfig
-
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 classKQueueServerChannelConfig
-
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 classKQueueServerChannelConfig
- Returns:
true
if and only if the property has been set
-
setReusePort
public KQueueServerSocketChannelConfig setReusePort(boolean reusePort)
-
isReusePort
public boolean isReusePort()
-
setAcceptFilter
public KQueueServerSocketChannelConfig setAcceptFilter(AcceptFilter acceptFilter)
-
getAcceptFilter
public AcceptFilter getAcceptFilter()
-
setRcvAllocTransportProvidesGuess
public KQueueServerSocketChannelConfig setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)
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 classKQueueServerChannelConfig
-
setReuseAddress
public KQueueServerSocketChannelConfig setReuseAddress(boolean reuseAddress)
Description copied from interface:ServerSocketChannelConfig
Sets theStandardSocketOptions.SO_REUSEADDR
option.- Specified by:
setReuseAddress
in interfaceServerSocketChannelConfig
- Overrides:
setReuseAddress
in classKQueueServerChannelConfig
-
setReceiveBufferSize
public KQueueServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)
Description copied from interface:ServerSocketChannelConfig
Gets theStandardSocketOptions.SO_SNDBUF
option.- Specified by:
setReceiveBufferSize
in interfaceServerSocketChannelConfig
- Overrides:
setReceiveBufferSize
in classKQueueServerChannelConfig
-
setPerformancePreferences
public KQueueServerSocketChannelConfig 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 classKQueueServerChannelConfig
-
setBacklog
public KQueueServerSocketChannelConfig 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
- Overrides:
setBacklog
in classKQueueServerChannelConfig
-
setTcpFastOpen
public KQueueServerSocketChannelConfig setTcpFastOpen(boolean enableTcpFastOpen)
Description copied from class:KQueueServerChannelConfig
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.- Overrides:
setTcpFastOpen
in classKQueueServerChannelConfig
- Parameters:
enableTcpFastOpen
-true
if TCP FastOpen should be enabled for incoming connections.- See Also:
- RFC 7413 Passive Open
-
setConnectTimeoutMillis
public KQueueServerSocketChannelConfig 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 classKQueueServerChannelConfig
- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
setMaxMessagesPerRead
@Deprecated public KQueueServerSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.Description copied from class:DefaultChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceServerSocketChannelConfig
- Overrides:
setMaxMessagesPerRead
in classKQueueServerChannelConfig
-
setWriteSpinCount
public KQueueServerSocketChannelConfig 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 classKQueueServerChannelConfig
-
setAllocator
public KQueueServerSocketChannelConfig 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 classKQueueServerChannelConfig
-
setRecvByteBufAllocator
public KQueueServerSocketChannelConfig 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 classKQueueServerChannelConfig
-
setAutoRead
public KQueueServerSocketChannelConfig 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 classKQueueServerChannelConfig
-
setWriteBufferHighWaterMark
@Deprecated public KQueueServerSocketChannelConfig 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 classKQueueServerChannelConfig
-
setWriteBufferLowWaterMark
@Deprecated public KQueueServerSocketChannelConfig 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 classKQueueServerChannelConfig
-
setWriteBufferWaterMark
public KQueueServerSocketChannelConfig 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 classKQueueServerChannelConfig
-
setMessageSizeEstimator
public KQueueServerSocketChannelConfig 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 classKQueueServerChannelConfig
-
-