Package io.netty.channel.uring

Class IoUringServerSocketChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.uring.IoUringChannelConfig

io.netty.channel.uring.IoUringServerSocketChannelConfig

All Implemented Interfaces:

ChannelConfig, ServerSocketChannelConfig

final class IoUringServerSocketChannelConfig
extends IoUringChannelConfig
implements ServerSocketChannelConfig

Field Summary

Fields

Modifier and Type	Field	Description
private int	backlog
private int	pendingFastOpenRequestsThreshold

Fields inherited from class io.netty.channel.DefaultChannelConfig

channel

Constructor Summary

Constructors

Constructor	Description
IoUringServerSocketChannelConfig(AbstractIoUringServerChannel channel)

Method Summary

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 given ChannelOption
java.util.Map<ChannelOption<?>,java.lang.Object>	getOptions()	Return all set ChannelOption's.
int	getReceiveBufferSize()	Gets the StandardSocketOptions.SO_RCVBUF option.
int	getTcpDeferAccept()	Returns a positive value if TCP_DEFER_ACCEPT is enabled.
int	getTcpFastopen()	Returns threshold value of number of pending for fast open connect.
boolean	isFreeBind()	Returns true if IP_FREEBIND is enabled, false otherwise.
boolean	isIpTransparent()	Returns true if IP_TRANSPARENT is enabled, false otherwise.
boolean	isReuseAddress()	Gets the StandardSocketOptions.SO_REUSEADDR option.
boolean	isReusePort()	Returns true if the SO_REUSEPORT option is set.
IoUringServerSocketChannelConfig	setAllocator(ByteBufAllocator allocator)	Set the ByteBufAllocator which is used for the channel to allocate buffers.
IoUringServerSocketChannelConfig	setAutoRead(boolean autoRead)	Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
IoUringServerSocketChannelConfig	setBacklog(int backlog)	Sets the backlog value to specify when the channel binds to a local address.
IoUringServerSocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis)	Sets the connect timeout of the channel in milliseconds.
IoUringServerSocketChannelConfig	setFreeBind(boolean freeBind)	If true is used IP_FREEBIND is enabled, false for disable it.
IoUringServerSocketChannelConfig	setIpTransparent(boolean transparent)	If true is used IP_TRANSPARENT is enabled, false for disable it.
IoUringServerSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead)	Deprecated.
IoUringServerSocketChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator)	Set the MessageSizeEstimator 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.
IoUringServerSocketChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth)	Sets the performance preferences as specified in ServerSocket.setPerformancePreferences(int, int, int).
IoUringServerSocketChannelConfig	setReceiveBufferSize(int receiveBufferSize)	Gets the StandardSocketOptions.SO_SNDBUF option.
IoUringServerSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator)	Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
IoUringServerSocketChannelConfig	setReuseAddress(boolean reuseAddress)	Sets the StandardSocketOptions.SO_REUSEADDR option.
IoUringServerSocketChannelConfig	setReusePort(boolean reusePort)	Set the SO_REUSEPORT option on the underlying Channel.
IoUringServerSocketChannelConfig	setTcpDeferAccept(int deferAccept)	Set the TCP_DEFER_ACCEPT option on the socket.
IoUringServerSocketChannelConfig	setTcpFastopen(int pendingFastOpenRequestsThreshold)	Enables tcpFastOpen on the server channel.
IoUringServerSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark)	Deprecated.
IoUringServerSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark)	Deprecated.
IoUringServerSocketChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)	Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
IoUringServerSocketChannelConfig	setWriteSpinCount(int writeSpinCount)	Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

Methods inherited from class io.netty.channel.uring.IoUringChannelConfig

autoReadCleared, setAutoClose, setMaxMessagesPerWrite

Methods inherited from class io.netty.channel.DefaultChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, 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 Detail

backlog

private volatile int backlog

pendingFastOpenRequestsThreshold

private volatile int pendingFastOpenRequestsThreshold

Constructor Detail

IoUringServerSocketChannelConfig

IoUringServerSocketChannelConfig(AbstractIoUringServerChannel channel)

Method Detail

getOptions

public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()

Description copied from interface: ChannelConfig

Return all set ChannelOption's.

Specified by:

getOptions in interface ChannelConfig

Overrides:

getOptions in class DefaultChannelConfig

getOption

public <T> T getOption(ChannelOption<T> option)

Description copied from interface: ChannelConfig

Return the value of the given ChannelOption

Specified by:

getOption in interface ChannelConfig

Overrides:

getOption in class IoUringChannelConfig

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 interface ChannelConfig

Overrides:

setOption in class IoUringChannelConfig

Returns:

true if and only if the property has been set

setPerformancePreferences

public IoUringServerSocketChannelConfig setPerformancePreferences(int connectionTime,
                                                                  int latency,
                                                                  int bandwidth)

Description copied from interface: ServerSocketChannelConfig

Sets the performance preferences as specified in ServerSocket.setPerformancePreferences(int, int, int).

Specified by:

setPerformancePreferences in interface ServerSocketChannelConfig

isReuseAddress

public boolean isReuseAddress()

Description copied from interface: ServerSocketChannelConfig

Gets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

isReuseAddress in interface ServerSocketChannelConfig

setReuseAddress

public IoUringServerSocketChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: ServerSocketChannelConfig

Sets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface ServerSocketChannelConfig

getReceiveBufferSize

public int getReceiveBufferSize()

Description copied from interface: ServerSocketChannelConfig

Gets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

getReceiveBufferSize in interface ServerSocketChannelConfig

setReceiveBufferSize

public IoUringServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: ServerSocketChannelConfig

Gets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

setReceiveBufferSize in interface ServerSocketChannelConfig

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 interface ServerSocketChannelConfig

setBacklog

public IoUringServerSocketChannelConfig 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 interface ServerSocketChannelConfig

setConnectTimeoutMillis

public IoUringServerSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Description copied from interface: ChannelConfig

Sets the connect timeout of the channel in milliseconds. If the Channel does not support connect operation, this property is not used at all, and therefore will be ignored.

Specified by:

setConnectTimeoutMillis in interface ChannelConfig

Specified by:

setConnectTimeoutMillis in interface ServerSocketChannelConfig

Overrides:

setConnectTimeoutMillis in class IoUringChannelConfig

Parameters:

connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.

setMaxMessagesPerRead

@Deprecated
public IoUringServerSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Description copied from class: DefaultChannelConfig

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface ServerSocketChannelConfig

Overrides:

setMaxMessagesPerRead in class IoUringChannelConfig

setWriteSpinCount

public IoUringServerSocketChannelConfig setWriteSpinCount(int writeSpinCount)

Description copied from interface: ChannelConfig

Sets the maximum loop count for a write operation until WritableByteChannel.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 is 16.

Specified by:

setWriteSpinCount in interface ChannelConfig

Specified by:

setWriteSpinCount in interface ServerSocketChannelConfig

Overrides:

setWriteSpinCount in class IoUringChannelConfig

setAllocator

public IoUringServerSocketChannelConfig setAllocator(ByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the ByteBufAllocator which is used for the channel to allocate buffers.

Specified by:

setAllocator in interface ChannelConfig

Specified by:

setAllocator in interface ServerSocketChannelConfig

Overrides:

setAllocator in class IoUringChannelConfig

setRecvByteBufAllocator

public IoUringServerSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

Specified by:

setRecvByteBufAllocator in interface ServerSocketChannelConfig

Overrides:

setRecvByteBufAllocator in class IoUringChannelConfig

setAutoRead

public IoUringServerSocketChannelConfig setAutoRead(boolean autoRead)

Description copied from interface: ChannelConfig

Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all. The default value is true.

Specified by:

setAutoRead in interface ChannelConfig

Specified by:

setAutoRead in interface ServerSocketChannelConfig

Overrides:

setAutoRead in class IoUringChannelConfig

setWriteBufferHighWaterMark

@Deprecated
public IoUringServerSocketChannelConfig 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 return false.

Specified by:

setWriteBufferHighWaterMark in interface ChannelConfig

Specified by:

setWriteBufferHighWaterMark in interface ServerSocketChannelConfig

Overrides:

setWriteBufferHighWaterMark in class IoUringChannelConfig

setWriteBufferLowWaterMark

@Deprecated
public IoUringServerSocketChannelConfig 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 return true again.

Specified by:

setWriteBufferLowWaterMark in interface ChannelConfig

Specified by:

setWriteBufferLowWaterMark in interface ServerSocketChannelConfig

Overrides:

setWriteBufferLowWaterMark in class IoUringChannelConfig

setWriteBufferWaterMark

public IoUringServerSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Description copied from interface: ChannelConfig

Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.

Specified by:

setWriteBufferWaterMark in interface ChannelConfig

Specified by:

setWriteBufferWaterMark in interface ServerSocketChannelConfig

Overrides:

setWriteBufferWaterMark in class IoUringChannelConfig

setMessageSizeEstimator

public IoUringServerSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Description copied from interface: ChannelConfig

Set the MessageSizeEstimator which is used for the channel to detect the size of a message.

Specified by:

setMessageSizeEstimator in interface ChannelConfig

Specified by:

setMessageSizeEstimator in interface ServerSocketChannelConfig

Overrides:

setMessageSizeEstimator in class IoUringChannelConfig

isReusePort

public boolean isReusePort()

Returns true if the SO_REUSEPORT option is set.

setReusePort

public IoUringServerSocketChannelConfig setReusePort(boolean reusePort)

Set the SO_REUSEPORT option on the underlying Channel. This will allow to bind multiple ServerSocketChannels to the same port and so accept connections with multiple threads. Be aware this method needs be called before Channel.bind(java.net.SocketAddress) to have any affect.

isFreeBind

public boolean isFreeBind()

Returns true if IP_FREEBIND is enabled, false otherwise.

setFreeBind

public IoUringServerSocketChannelConfig setFreeBind(boolean freeBind)

If true is used IP_FREEBIND is enabled, false for disable it. Default is disabled.

isIpTransparent

public boolean isIpTransparent()

Returns true if IP_TRANSPARENT is enabled, false otherwise.

setIpTransparent

public IoUringServerSocketChannelConfig setIpTransparent(boolean transparent)

If true is used IP_TRANSPARENT is enabled, false for disable it. Default is disabled.

setTcpDeferAccept

public IoUringServerSocketChannelConfig setTcpDeferAccept(int deferAccept)

Set the TCP_DEFER_ACCEPT option on the socket. See man 7 tcp for more details.

getTcpDeferAccept

public int getTcpDeferAccept()

Returns a positive value if TCP_DEFER_ACCEPT is enabled.

getTcpFastopen

public int getTcpFastopen()

Returns threshold value of number of pending for fast open connect.

See Also:

RFC 7413 Passive Open

setTcpFastopen

public IoUringServerSocketChannelConfig 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