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

Modifier and Type	Field and Description
protected io.netty.channel.epoll.AbstractEpollChannel	channel

Method Summary

Modifier and Type	Method and 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
Map<ChannelOption<?>,Object>	getOptions() Return all set ChannelOption's.
int	getReceiveBufferSize() Gets the StandardSocketOptions.SO_RCVBUF option.
int	getTcpFastopen() Returns threshold value of number of pending for fast open connect.
boolean	isReuseAddress() Gets the StandardSocketOptions.SO_REUSEADDR option.
EpollServerChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
EpollServerChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.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 the EpollMode used.
EpollServerChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Deprecated.
EpollServerChannelConfig	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.
EpollServerChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets the performance preferences as specified in ServerSocket.setPerformancePreferences(int, int, int).
EpollServerChannelConfig	setReceiveBufferSize(int receiveBufferSize) Gets the StandardSocketOptions.SO_SNDBUF option.
EpollServerChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
EpollServerChannelConfig	setReuseAddress(boolean reuseAddress) Sets the StandardSocketOptions.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 the WriteBufferWaterMark 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 until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

Methods inherited from class io.netty.channel.epoll.EpollChannelConfig

autoReadCleared, getEpollMode

Methods inherited from class io.netty.channel.DefaultChannelConfig

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

channel

protected final io.netty.channel.epoll.AbstractEpollChannel channel

Method Detail

getOptions

public Map<ChannelOption<?>,Object> getOptions()

Description copied from interface: ChannelConfig

Return all set ChannelOption's.

Specified by:

getOptions in interface ChannelConfig

Overrides:

getOptions in class EpollChannelConfig

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 EpollChannelConfig

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 EpollChannelConfig

Returns:

true if and only if the property has been set

isReuseAddress

public boolean isReuseAddress()

Description copied from interface: ServerSocketChannelConfig

Gets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

isReuseAddress in interface ServerSocketChannelConfig

setReuseAddress

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

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 doesnt 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 RFC 7413 Passive Open

See Also:

RFC 7413 TCP FastOpen

setPerformancePreferences

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

setConnectTimeoutMillis

public EpollServerChannelConfig 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 EpollChannelConfig

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

Specified by:

setMaxMessagesPerRead in interface ServerSocketChannelConfig

Overrides:

setMaxMessagesPerRead in class EpollChannelConfig

setWriteSpinCount

public EpollServerChannelConfig 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 EpollChannelConfig

setAllocator

public EpollServerChannelConfig 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 EpollChannelConfig

setRecvByteBufAllocator

public EpollServerChannelConfig 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 EpollChannelConfig

setAutoRead

public EpollServerChannelConfig 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 EpollChannelConfig

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 return false.

Specified by:

setWriteBufferHighWaterMark in interface ChannelConfig

Specified by:

setWriteBufferHighWaterMark in interface ServerSocketChannelConfig

Overrides:

setWriteBufferHighWaterMark in class EpollChannelConfig

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 return true again.

Specified by:

setWriteBufferLowWaterMark in interface ChannelConfig

Specified by:

setWriteBufferLowWaterMark in interface ServerSocketChannelConfig

Overrides:

setWriteBufferLowWaterMark in class EpollChannelConfig

setWriteBufferWaterMark

public EpollServerChannelConfig 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 EpollChannelConfig

setMessageSizeEstimator

public EpollServerChannelConfig 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 EpollChannelConfig

setEpollMode

public EpollServerChannelConfig setEpollMode(EpollMode mode)

Description copied from class: EpollChannelConfig

Set the EpollMode used. Default is EpollMode.EDGE_TRIGGERED. If you want to use DefaultChannelConfig.isAutoRead() false or DefaultChannelConfig.getMaxMessagesPerRead() and have an accurate behaviour you should use EpollMode.LEVEL_TRIGGERED. Be aware this config setting can only be adjusted before the channel was registered.

Overrides:

setEpollMode in class EpollChannelConfig