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:

io.netty.channel.ChannelConfig, io.netty.channel.socket.ServerSocketChannelConfig

Direct Known Subclasses:

EpollServerSocketChannelConfig

public class EpollServerChannelConfig
extends EpollChannelConfig
implements io.netty.channel.socket.ServerSocketChannelConfig

Field Summary

Fields inherited from class io.netty.channel.DefaultChannelConfig

channel

Method Summary

Modifier and Type	Method and Description
int	getBacklog()
<T> T	getOption(io.netty.channel.ChannelOption<T> option)
Map<io.netty.channel.ChannelOption<?>,Object>	getOptions()
int	getReceiveBufferSize()
int	getTcpFastopen() Returns threshold value of number of pending for fast open connect.
boolean	isReuseAddress()
EpollServerChannelConfig	setAllocator(io.netty.buffer.ByteBufAllocator allocator)
EpollServerChannelConfig	setAutoRead(boolean autoRead)
EpollServerChannelConfig	setBacklog(int backlog)
EpollServerChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis)
EpollServerChannelConfig	setEpollMode(EpollMode mode) Set the EpollMode used.
EpollServerChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Deprecated.
EpollServerChannelConfig	setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)
<T> boolean	setOption(io.netty.channel.ChannelOption<T> option, T value)
EpollServerChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth)
EpollServerChannelConfig	setReceiveBufferSize(int receiveBufferSize)
EpollServerChannelConfig	setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)
EpollServerChannelConfig	setReuseAddress(boolean reuseAddress)
EpollServerChannelConfig	setTcpFastopen(int pendingFastOpenRequestsThreshold) Enables tcpFastOpen on the server channel.
EpollServerChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Deprecated.
EpollServerChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Deprecated.
EpollServerChannelConfig	setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)
EpollServerChannelConfig	setWriteSpinCount(int writeSpinCount)

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

Method Detail

getOptions

public Map<io.netty.channel.ChannelOption<?>,Object> getOptions()

Specified by:

getOptions in interface io.netty.channel.ChannelConfig

Overrides:

getOptions in class EpollChannelConfig

getOption

public <T> T getOption(io.netty.channel.ChannelOption<T> option)

Specified by:

getOption in interface io.netty.channel.ChannelConfig

Overrides:

getOption in class EpollChannelConfig

setOption

public <T> boolean setOption(io.netty.channel.ChannelOption<T> option,
                             T value)

Specified by:

setOption in interface io.netty.channel.ChannelConfig

Overrides:

setOption in class EpollChannelConfig

isReuseAddress

public boolean isReuseAddress()

Specified by:

isReuseAddress in interface io.netty.channel.socket.ServerSocketChannelConfig

setReuseAddress

public EpollServerChannelConfig setReuseAddress(boolean reuseAddress)

Specified by:

setReuseAddress in interface io.netty.channel.socket.ServerSocketChannelConfig

getReceiveBufferSize

public int getReceiveBufferSize()

Specified by:

getReceiveBufferSize in interface io.netty.channel.socket.ServerSocketChannelConfig

setReceiveBufferSize

public EpollServerChannelConfig setReceiveBufferSize(int receiveBufferSize)

Specified by:

setReceiveBufferSize in interface io.netty.channel.socket.ServerSocketChannelConfig

getBacklog

public int getBacklog()

Specified by:

getBacklog in interface io.netty.channel.socket.ServerSocketChannelConfig

setBacklog

public EpollServerChannelConfig setBacklog(int backlog)

Specified by:

setBacklog in interface io.netty.channel.socket.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)

Specified by:

setPerformancePreferences in interface io.netty.channel.socket.ServerSocketChannelConfig

setConnectTimeoutMillis

public EpollServerChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Specified by:

setConnectTimeoutMillis in interface io.netty.channel.ChannelConfig

Specified by:

setConnectTimeoutMillis in interface io.netty.channel.socket.ServerSocketChannelConfig

Overrides:

setConnectTimeoutMillis in class EpollChannelConfig

setMaxMessagesPerRead

@Deprecated
public EpollServerChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Specified by:

setMaxMessagesPerRead in interface io.netty.channel.ChannelConfig

Specified by:

setMaxMessagesPerRead in interface io.netty.channel.socket.ServerSocketChannelConfig

Overrides:

setMaxMessagesPerRead in class EpollChannelConfig

setWriteSpinCount

public EpollServerChannelConfig setWriteSpinCount(int writeSpinCount)

Specified by:

setWriteSpinCount in interface io.netty.channel.ChannelConfig

Specified by:

setWriteSpinCount in interface io.netty.channel.socket.ServerSocketChannelConfig

Overrides:

setWriteSpinCount in class EpollChannelConfig

setAllocator

public EpollServerChannelConfig setAllocator(io.netty.buffer.ByteBufAllocator allocator)

Specified by:

setAllocator in interface io.netty.channel.ChannelConfig

Specified by:

setAllocator in interface io.netty.channel.socket.ServerSocketChannelConfig

Overrides:

setAllocator in class EpollChannelConfig

setRecvByteBufAllocator

public EpollServerChannelConfig setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)

Specified by:

setRecvByteBufAllocator in interface io.netty.channel.ChannelConfig

Specified by:

setRecvByteBufAllocator in interface io.netty.channel.socket.ServerSocketChannelConfig

Overrides:

setRecvByteBufAllocator in class EpollChannelConfig

setAutoRead

public EpollServerChannelConfig setAutoRead(boolean autoRead)

Specified by:

setAutoRead in interface io.netty.channel.ChannelConfig

Specified by:

setAutoRead in interface io.netty.channel.socket.ServerSocketChannelConfig

Overrides:

setAutoRead in class EpollChannelConfig

setWriteBufferHighWaterMark

@Deprecated
public EpollServerChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Deprecated.

Specified by:

setWriteBufferHighWaterMark in interface io.netty.channel.ChannelConfig

Specified by:

setWriteBufferHighWaterMark in interface io.netty.channel.socket.ServerSocketChannelConfig

Overrides:

setWriteBufferHighWaterMark in class EpollChannelConfig

setWriteBufferLowWaterMark

@Deprecated
public EpollServerChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Deprecated.

Specified by:

setWriteBufferLowWaterMark in interface io.netty.channel.ChannelConfig

Specified by:

setWriteBufferLowWaterMark in interface io.netty.channel.socket.ServerSocketChannelConfig

Overrides:

setWriteBufferLowWaterMark in class EpollChannelConfig

setWriteBufferWaterMark

public EpollServerChannelConfig setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)

Specified by:

setWriteBufferWaterMark in interface io.netty.channel.ChannelConfig

Specified by:

setWriteBufferWaterMark in interface io.netty.channel.socket.ServerSocketChannelConfig

Overrides:

setWriteBufferWaterMark in class EpollChannelConfig

setMessageSizeEstimator

public EpollServerChannelConfig setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)

Specified by:

setMessageSizeEstimator in interface io.netty.channel.ChannelConfig

Specified by:

setMessageSizeEstimator in interface io.netty.channel.socket.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