Netty 4.1.107.Final · io.netty.channel.epoll.EpollSocketChannelConfig

Modifier and Type	Field and Description
private volatile boolean	allowHalfClosure
private volatile boolean	tcpFastopen

Access	Constructor and Description
pack-priv	EpollSocketChannelConfig(EpollSocketChannel channel) Creates a new instance.

Modifier and Type	Method and Description
private void	calculateMaxBytesPerGatheringWrite()
public <T> T	getOption(ChannelOption<T> option) Overrides io.netty.channel.epoll.EpollChannelConfig.getOption. Implements io.netty.channel.ChannelConfig.getOption. Return the value of the given `ChannelOption`
public Map<ChannelOption<?>, Object>	getOptions() Overrides io.netty.channel.epoll.EpollChannelConfig.getOptions. Implements io.netty.channel.ChannelConfig.getOptions. Return all set `ChannelOption`'s.
public int	getReceiveBufferSize() Implements io.netty.channel.socket.SocketChannelConfig.getReceiveBufferSize. Gets the `StandardSocketOptions#SO_RCVBUF` option.
public int	getSendBufferSize() Implements io.netty.channel.socket.SocketChannelConfig.getSendBufferSize. Gets the `StandardSocketOptions#SO_SNDBUF` option.
public int	getSoBusyPoll() Get the `SO_BUSY_POLL` option on the socket.
public int	getSoLinger() Implements io.netty.channel.socket.SocketChannelConfig.getSoLinger. Gets the `StandardSocketOptions#SO_LINGER` option.
public int	getTcpKeepCnt() Get the `TCP_KEEPCNT` option on the socket.
public int	getTcpKeepIdle() Get the `TCP_KEEPIDLE` option on the socket.
public int	getTcpKeepIntvl() Get the `TCP_KEEPINTVL` option on the socket.
public long	Returns: value is a uint32_t getTcpNotSentLowAt() Get the `TCP_NOTSENT_LOWAT` option on the socket.
public int	getTcpUserTimeout() Get the `TCP_USER_TIMEOUT` option on the socket.
public int	getTrafficClass() Implements io.netty.channel.socket.SocketChannelConfig.getTrafficClass. Gets the `StandardSocketOptions#IP_TOS` option.
public boolean	isAllowHalfClosure() Implements io.netty.channel.socket.DuplexChannelConfig.isAllowHalfClosure. Returns `true` if and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
public boolean	isIpTransparent() Returns `true` if IP_TRANSPARENT is enabled, `false` otherwise.
public boolean	isKeepAlive() Implements io.netty.channel.socket.SocketChannelConfig.isKeepAlive. Gets the `StandardSocketOptions#SO_KEEPALIVE` option.
public boolean	isReuseAddress() Implements io.netty.channel.socket.SocketChannelConfig.isReuseAddress. Gets the `StandardSocketOptions#SO_REUSEADDR` option.
public boolean	isTcpCork() Get the `TCP_CORK` option on the socket.
public boolean	isTcpFastOpenConnect() Returns `true` if TCP fast open is enabled, `false` otherwise.
public boolean	isTcpNoDelay() Implements io.netty.channel.socket.SocketChannelConfig.isTcpNoDelay. Gets the `StandardSocketOptions#TCP_NODELAY` option.
public boolean	isTcpQuickAck() Returns `true` if TCP_QUICKACK is enabled, `false` otherwise.
public EpollSocketChannelConfig	setAllocator(ByteBufAllocator allocator) Overrides io.netty.channel.epoll.EpollChannelConfig.setAllocator. Implements io.netty.channel.socket.SocketChannelConfig.setAllocator, io.netty.channel.ChannelConfig.setAllocator. Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
public EpollSocketChannelConfig	setAllowHalfClosure(boolean allowHalfClosure) Implements io.netty.channel.socket.SocketChannelConfig.setAllowHalfClosure. Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
public EpollSocketChannelConfig	setAutoClose(boolean autoClose) Overrides io.netty.channel.DefaultChannelConfig.setAutoClose. Implements io.netty.channel.socket.SocketChannelConfig.setAutoClose, io.netty.channel.ChannelConfig.setAutoClose. Sets whether the `Channel` should be closed automatically and immediately on write failure.
public EpollSocketChannelConfig	setAutoRead(boolean autoRead) Overrides io.netty.channel.epoll.EpollChannelConfig.setAutoRead. Implements io.netty.channel.socket.SocketChannelConfig.setAutoRead, io.netty.channel.ChannelConfig.setAutoRead. Sets if `ChannelHandlerContext#read()` will be invoked automatically so that a user application doesn't need to call it at all.
public EpollSocketChannelConfig	setConnectTimeoutMillis(int the connect timeout in milliseconds. `0` to disable. connectTimeoutMillis) Overrides io.netty.channel.epoll.EpollChannelConfig.setConnectTimeoutMillis. Implements io.netty.channel.socket.SocketChannelConfig.setConnectTimeoutMillis, io.netty.channel.ChannelConfig.setConnectTimeoutMillis. Sets the connect timeout of the channel in milliseconds.
public EpollSocketChannelConfig	setEpollMode(EpollMode mode) Overrides io.netty.channel.epoll.EpollChannelConfig.setEpollMode. Set the `EpollMode` used.
public EpollSocketChannelConfig	setIpTransparent(boolean transparent) If `true` is used IP_TRANSPARENT is enabled, `false` for disable it.
public EpollSocketChannelConfig	setKeepAlive(boolean keepAlive) Implements io.netty.channel.socket.SocketChannelConfig.setKeepAlive. Sets the `StandardSocketOptions#SO_KEEPALIVE` option.
public EpollSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Overrides io.netty.channel.epoll.EpollChannelConfig.setMaxMessagesPerRead. Implements io.netty.channel.socket.SocketChannelConfig.setMaxMessagesPerRead, io.netty.channel.ChannelConfig.setMaxMessagesPerRead. Deprecated
public EpollSocketChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Overrides io.netty.channel.epoll.EpollChannelConfig.setMessageSizeEstimator. Implements io.netty.channel.socket.SocketChannelConfig.setMessageSizeEstimator, io.netty.channel.ChannelConfig.setMessageSizeEstimator. Set the `MessageSizeEstimator` which is used for the channel to detect the size of a message.
public <T> boolean	setOption(ChannelOption<T> option, T value) Overrides io.netty.channel.epoll.EpollChannelConfig.setOption. Implements io.netty.channel.ChannelConfig.setOption. Sets a configuration property with the specified name and value.
public EpollSocketChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Implements io.netty.channel.socket.SocketChannelConfig.setPerformancePreferences. Sets the performance preferences as specified in `Socket#setPerformancePreferences(int, int, int)`.
public EpollSocketChannelConfig	setReceiveBufferSize(int receiveBufferSize) Implements io.netty.channel.socket.SocketChannelConfig.setReceiveBufferSize. Sets the `StandardSocketOptions#SO_RCVBUF` option.
public EpollSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Overrides io.netty.channel.epoll.EpollChannelConfig.setRecvByteBufAllocator. Implements io.netty.channel.socket.SocketChannelConfig.setRecvByteBufAllocator, io.netty.channel.ChannelConfig.setRecvByteBufAllocator. Set the `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.
public EpollSocketChannelConfig	setReuseAddress(boolean reuseAddress) Implements io.netty.channel.socket.SocketChannelConfig.setReuseAddress. Sets the `StandardSocketOptions#SO_REUSEADDR` option.
public EpollSocketChannelConfig	setSendBufferSize(int sendBufferSize) Implements io.netty.channel.socket.SocketChannelConfig.setSendBufferSize. Sets the `StandardSocketOptions#SO_SNDBUF` option.
public EpollSocketChannelConfig	setSoBusyPoll(int loopMicros) Set the `SO_BUSY_POLL` option on the socket.
public EpollSocketChannelConfig	setSoLinger(int soLinger) Implements io.netty.channel.socket.SocketChannelConfig.setSoLinger. Sets the `StandardSocketOptions#SO_LINGER` option.
public EpollSocketChannelConfig	setTcpCork(boolean tcpCork) Set the `TCP_CORK` option on the socket.
public EpollSocketChannelConfig	setTcpFastOpenConnect(boolean fastOpenConnect) Enables client TCP fast open.
public EpollSocketChannelConfig	setTcpKeepCnt(int probes) Set the `TCP_KEEPCNT` option on the socket.
public EpollSocketChannelConfig	setTcpKeepCntl(int probes) Deprecated use `setTcpKeepCnt(int)`
public EpollSocketChannelConfig	setTcpKeepIdle(int seconds) Set the `TCP_KEEPIDLE` option on the socket.
public EpollSocketChannelConfig	setTcpKeepIntvl(int seconds) Set the `TCP_KEEPINTVL` option on the socket.
public EpollSocketChannelConfig	setTcpMd5Sig(Map<InetAddress, byte[]> keys) Set the `TCP_MD5SIG` option on the socket.
public EpollSocketChannelConfig	setTcpNoDelay(boolean tcpNoDelay) Implements io.netty.channel.socket.SocketChannelConfig.setTcpNoDelay. Sets the `StandardSocketOptions#TCP_NODELAY` option.
public EpollSocketChannelConfig	setTcpNotSentLowAt(long is a uint32_t tcpNotSentLowAt) Set the `TCP_NOTSENT_LOWAT` option on the socket.
public EpollSocketChannelConfig	setTcpQuickAck(boolean quickAck) Set the `TCP_QUICKACK` option on the socket.
public EpollSocketChannelConfig	setTcpUserTimeout(int milliseconds) Set the `TCP_USER_TIMEOUT` option on the socket.
public EpollSocketChannelConfig	setTrafficClass(int trafficClass) Implements io.netty.channel.socket.SocketChannelConfig.setTrafficClass. Sets the `StandardSocketOptions#IP_TOS` option.
public EpollSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Overrides io.netty.channel.epoll.EpollChannelConfig.setWriteBufferHighWaterMark. Implements io.netty.channel.ChannelConfig.setWriteBufferHighWaterMark. Deprecated Sets the high water mark of the write buffer.
public EpollSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Overrides io.netty.channel.epoll.EpollChannelConfig.setWriteBufferLowWaterMark. Implements io.netty.channel.ChannelConfig.setWriteBufferLowWaterMark. Deprecated Sets the low water mark of the write buffer.
public EpollSocketChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Overrides io.netty.channel.epoll.EpollChannelConfig.setWriteBufferWaterMark. Implements io.netty.channel.socket.SocketChannelConfig.setWriteBufferWaterMark, io.netty.channel.ChannelConfig.setWriteBufferWaterMark. Set the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.
public EpollSocketChannelConfig	setWriteSpinCount(int writeSpinCount) Overrides io.netty.channel.epoll.EpollChannelConfig.setWriteSpinCount. Implements io.netty.channel.socket.SocketChannelConfig.setWriteSpinCount, io.netty.channel.ChannelConfig.setWriteSpinCount. Sets the maximum loop count for a write operation until `WritableByteChannel#write(ByteBuffer)` returns a non-zero value.

allowHalfClosure	back to summary
private volatile boolean allowHalfClosure

tcpFastopen	back to summary
private volatile boolean tcpFastopen

EpollSocketChannelConfig	back to summary
pack-priv EpollSocketChannelConfig(EpollSocketChannel channel) Creates a new instance.

Method Detail

calculateMaxBytesPerGatheringWrite	back to summary
private void calculateMaxBytesPerGatheringWrite()

getOption back to summary

getOption	back to summary
public <T> T getOption(ChannelOption<T> option) Overrides io.netty.channel.epoll.EpollChannelConfig.getOption. Implements io.netty.channel.ChannelConfig.getOption. Doc from io.netty.channel.ChannelConfig.getOption. Return the value of the given `ChannelOption` Annotations @SuppressWarnings:unchecked @Override

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

Overrides io.netty.channel.epoll.EpollChannelConfig.getOption.

Implements io.netty.channel.ChannelConfig.getOption.

Doc from io.netty.channel.ChannelConfig.getOption.

Return the value of the given ChannelOption

Annotations

@SuppressWarnings:unchecked
@Override

getOptions back to summary

getOptions	back to summary
public Map<ChannelOption<?>, Object> getOptions() Overrides io.netty.channel.epoll.EpollChannelConfig.getOptions. Implements io.netty.channel.ChannelConfig.getOptions. Doc from io.netty.channel.ChannelConfig.getOptions. Return all set `ChannelOption`'s. Annotations @Override

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

Overrides io.netty.channel.epoll.EpollChannelConfig.getOptions.

Implements io.netty.channel.ChannelConfig.getOptions.

Doc from io.netty.channel.ChannelConfig.getOptions.

Return all set ChannelOption's.

Annotations

@Override

getReceiveBufferSize back to summary

getReceiveBufferSize	back to summary
public int getReceiveBufferSize() Implements io.netty.channel.socket.SocketChannelConfig.getReceiveBufferSize. Doc from io.netty.channel.socket.SocketChannelConfig.getReceiveBufferSize. Gets the `StandardSocketOptions#SO_RCVBUF` option. Annotations @Override

public int getReceiveBufferSize()

Implements io.netty.channel.socket.SocketChannelConfig.getReceiveBufferSize.

Doc from io.netty.channel.socket.SocketChannelConfig.getReceiveBufferSize.

Gets the StandardSocketOptions#SO_RCVBUF option.

Annotations

@Override

getSendBufferSize back to summary

getSendBufferSize	back to summary
public int getSendBufferSize() Implements io.netty.channel.socket.SocketChannelConfig.getSendBufferSize. Doc from io.netty.channel.socket.SocketChannelConfig.getSendBufferSize. Gets the `StandardSocketOptions#SO_SNDBUF` option. Annotations @Override

public int getSendBufferSize()

Implements io.netty.channel.socket.SocketChannelConfig.getSendBufferSize.

Doc from io.netty.channel.socket.SocketChannelConfig.getSendBufferSize.

Gets the StandardSocketOptions#SO_SNDBUF option.

Annotations

@Override

getSoBusyPoll	back to summary
public int getSoBusyPoll() Get the `SO_BUSY_POLL` option on the socket. See `man 7 tcp` for more details.

getSoLinger back to summary

getSoLinger	back to summary
public int getSoLinger() Implements io.netty.channel.socket.SocketChannelConfig.getSoLinger. Doc from io.netty.channel.socket.SocketChannelConfig.getSoLinger. Gets the `StandardSocketOptions#SO_LINGER` option. Annotations @Override

public int getSoLinger()

Implements io.netty.channel.socket.SocketChannelConfig.getSoLinger.

Doc from io.netty.channel.socket.SocketChannelConfig.getSoLinger.

Gets the StandardSocketOptions#SO_LINGER option.

Annotations

@Override

getTcpKeepCnt	back to summary
public int getTcpKeepCnt() Get the `TCP_KEEPCNT` option on the socket. See `man 7 tcp` for more details.

getTcpKeepIdle	back to summary
public int getTcpKeepIdle() Get the `TCP_KEEPIDLE` option on the socket. See `man 7 tcp` for more details.

getTcpKeepIntvl	back to summary
public int getTcpKeepIntvl() Get the `TCP_KEEPINTVL` option on the socket. See `man 7 tcp` for more details.

getTcpNotSentLowAt back to summary

getTcpNotSentLowAt	back to summary
public long getTcpNotSentLowAt() Get the `TCP_NOTSENT_LOWAT` option on the socket. See `man 7 tcp` for more details. Returns:long value is a uint32_t

public long getTcpNotSentLowAt()

Get the TCP_NOTSENT_LOWAT option on the socket. See man 7 tcp for more details.

Returns:long: value is a uint32_t

getTcpUserTimeout	back to summary
public int getTcpUserTimeout() Get the `TCP_USER_TIMEOUT` option on the socket. See `man 7 tcp` for more details.

getTrafficClass back to summary

getTrafficClass	back to summary
public int getTrafficClass() Implements io.netty.channel.socket.SocketChannelConfig.getTrafficClass. Doc from io.netty.channel.socket.SocketChannelConfig.getTrafficClass. Gets the `StandardSocketOptions#IP_TOS` option. Annotations @Override

public int getTrafficClass()

Implements io.netty.channel.socket.SocketChannelConfig.getTrafficClass.

Doc from io.netty.channel.socket.SocketChannelConfig.getTrafficClass.

Gets the StandardSocketOptions#IP_TOS option.

Annotations

@Override

isAllowHalfClosure back to summary

isAllowHalfClosure	back to summary
public boolean isAllowHalfClosure() Implements io.netty.channel.socket.DuplexChannelConfig.isAllowHalfClosure. Doc from io.netty.channel.socket.DuplexChannelConfig.isAllowHalfClosure. Returns `true` if and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If `false`, the connection is closed automatically when the remote peer shuts down output. Annotations @Override

public boolean isAllowHalfClosure()

Implements io.netty.channel.socket.DuplexChannelConfig.isAllowHalfClosure.

Doc from io.netty.channel.socket.DuplexChannelConfig.isAllowHalfClosure.

Returns true if and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If false, the connection is closed automatically when the remote peer shuts down output.

Annotations

@Override

isIpTransparent	back to summary
public boolean isIpTransparent() Returns `true` if IP_TRANSPARENT is enabled, `false` otherwise.

isKeepAlive back to summary

isKeepAlive	back to summary
public boolean isKeepAlive() Implements io.netty.channel.socket.SocketChannelConfig.isKeepAlive. Doc from io.netty.channel.socket.SocketChannelConfig.isKeepAlive. Gets the `StandardSocketOptions#SO_KEEPALIVE` option. Annotations @Override

public boolean isKeepAlive()

Implements io.netty.channel.socket.SocketChannelConfig.isKeepAlive.

Doc from io.netty.channel.socket.SocketChannelConfig.isKeepAlive.

Gets the StandardSocketOptions#SO_KEEPALIVE option.

Annotations

@Override

isReuseAddress back to summary

isReuseAddress	back to summary
public boolean isReuseAddress() Implements io.netty.channel.socket.SocketChannelConfig.isReuseAddress. Doc from io.netty.channel.socket.SocketChannelConfig.isReuseAddress. Gets the `StandardSocketOptions#SO_REUSEADDR` option. Annotations @Override

public boolean isReuseAddress()

Implements io.netty.channel.socket.SocketChannelConfig.isReuseAddress.

Doc from io.netty.channel.socket.SocketChannelConfig.isReuseAddress.

Gets the StandardSocketOptions#SO_REUSEADDR option.

Annotations

@Override

isTcpCork	back to summary
public boolean isTcpCork() Get the `TCP_CORK` option on the socket. See `man 7 tcp` for more details.

isTcpFastOpenConnect	back to summary
public boolean isTcpFastOpenConnect() Returns `true` if TCP fast open is enabled, `false` otherwise.

isTcpNoDelay back to summary

isTcpNoDelay	back to summary
public boolean isTcpNoDelay() Implements io.netty.channel.socket.SocketChannelConfig.isTcpNoDelay. Doc from io.netty.channel.socket.SocketChannelConfig.isTcpNoDelay. Gets the `StandardSocketOptions#TCP_NODELAY` option. Please note that the default value of this option is `true` unlike the operating system default (`false`). However, for some buggy platforms, such as Android, that shows erratic behavior with Nagle's algorithm disabled, the default value remains to be `false`. Annotations @Override

public boolean isTcpNoDelay()

Implements io.netty.channel.socket.SocketChannelConfig.isTcpNoDelay.

Doc from io.netty.channel.socket.SocketChannelConfig.isTcpNoDelay.

Gets the StandardSocketOptions#TCP_NODELAY option. Please note that the default value of this option is true unlike the operating system default (false). However, for some buggy platforms, such as Android, that shows erratic behavior with Nagle's algorithm disabled, the default value remains to be false.

Annotations

@Override

isTcpQuickAck	back to summary
public boolean isTcpQuickAck() Returns `true` if TCP_QUICKACK is enabled, `false` otherwise.

setAllocator back to summary

setAllocator	back to summary
public EpollSocketChannelConfig setAllocator(ByteBufAllocator allocator) Overrides io.netty.channel.epoll.EpollChannelConfig.setAllocator. Implements io.netty.channel.socket.SocketChannelConfig.setAllocator, io.netty.channel.ChannelConfig.setAllocator. Doc from io.netty.channel.ChannelConfig.setAllocator. Set the `ByteBufAllocator` which is used for the channel to allocate buffers. Annotations @Override

public EpollSocketChannelConfig setAllocator(ByteBufAllocator allocator)

Overrides io.netty.channel.epoll.EpollChannelConfig.setAllocator.

Implements io.netty.channel.socket.SocketChannelConfig.setAllocator, io.netty.channel.ChannelConfig.setAllocator.

Doc from io.netty.channel.ChannelConfig.setAllocator.

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

Annotations

@Override

setAllowHalfClosure back to summary

setAllowHalfClosure	back to summary
public EpollSocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure) Implements io.netty.channel.socket.SocketChannelConfig.setAllowHalfClosure. Doc from io.netty.channel.socket.DuplexChannelConfig.setAllowHalfClosure. Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If `true` the connection is not closed when the remote peer shuts down output. Instead, `ChannelInboundHandler#userEventTriggered(ChannelHandlerContext, Object)` is invoked with a `ChannelInputShutdownEvent` object. If `false`, the connection is closed automatically. Annotations @Override

public EpollSocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)

Implements io.netty.channel.socket.SocketChannelConfig.setAllowHalfClosure.

Doc from io.netty.channel.socket.DuplexChannelConfig.setAllowHalfClosure.

Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If true the connection is not closed when the remote peer shuts down output. Instead, ChannelInboundHandler#userEventTriggered(ChannelHandlerContext, Object) is invoked with a ChannelInputShutdownEvent object. If false, the connection is closed automatically.

Annotations

@Override

setAutoClose back to summary

setAutoClose	back to summary
public EpollSocketChannelConfig setAutoClose(boolean autoClose) Overrides io.netty.channel.DefaultChannelConfig.setAutoClose. Implements io.netty.channel.socket.SocketChannelConfig.setAutoClose, io.netty.channel.ChannelConfig.setAutoClose. Doc from io.netty.channel.ChannelConfig.setAutoClose. Sets whether the `Channel` should be closed automatically and immediately on write failure. The default is `true`. Annotations @Override

public EpollSocketChannelConfig setAutoClose(boolean autoClose)

Overrides io.netty.channel.DefaultChannelConfig.setAutoClose.

Implements io.netty.channel.socket.SocketChannelConfig.setAutoClose, io.netty.channel.ChannelConfig.setAutoClose.

Doc from io.netty.channel.ChannelConfig.setAutoClose.

Sets whether the Channel should be closed automatically and immediately on write failure. The default is true.

Annotations

@Override

setAutoRead back to summary

setAutoRead	back to summary
public EpollSocketChannelConfig setAutoRead(boolean autoRead) Overrides io.netty.channel.epoll.EpollChannelConfig.setAutoRead. Implements io.netty.channel.socket.SocketChannelConfig.setAutoRead, io.netty.channel.ChannelConfig.setAutoRead. Doc from io.netty.channel.ChannelConfig.setAutoRead. 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`. Annotations @Override

public EpollSocketChannelConfig setAutoRead(boolean autoRead)

Overrides io.netty.channel.epoll.EpollChannelConfig.setAutoRead.

Implements io.netty.channel.socket.SocketChannelConfig.setAutoRead, io.netty.channel.ChannelConfig.setAutoRead.

Doc from io.netty.channel.ChannelConfig.setAutoRead.

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.

Annotations

@Override

setConnectTimeoutMillis back to summary

setConnectTimeoutMillis	back to summary
public EpollSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis) Overrides io.netty.channel.epoll.EpollChannelConfig.setConnectTimeoutMillis. Implements io.netty.channel.socket.SocketChannelConfig.setConnectTimeoutMillis, io.netty.channel.ChannelConfig.setConnectTimeoutMillis. Doc from io.netty.channel.ChannelConfig.setConnectTimeoutMillis. 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. Parameters connectTimeoutMillis:int the connect timeout in milliseconds. `0` to disable. Annotations @Override

public EpollSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Overrides io.netty.channel.epoll.EpollChannelConfig.setConnectTimeoutMillis.

Implements io.netty.channel.socket.SocketChannelConfig.setConnectTimeoutMillis, io.netty.channel.ChannelConfig.setConnectTimeoutMillis.

Doc from io.netty.channel.ChannelConfig.setConnectTimeoutMillis.

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.

Parameters

connectTimeoutMillis:int: the connect timeout in milliseconds. 0 to disable.

Annotations

@Override

setEpollMode back to summary

setEpollMode	back to summary
public EpollSocketChannelConfig setEpollMode(EpollMode mode) Overrides io.netty.channel.epoll.EpollChannelConfig.setEpollMode. Doc from io.netty.channel.epoll.EpollChannelConfig.setEpollMode. Set the `EpollMode` used. Default is `EpollMode#EDGE_TRIGGERED`. If you want to use `isAutoRead()` `false` or `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. Annotations @Override

public EpollSocketChannelConfig setEpollMode(EpollMode mode)

Overrides io.netty.channel.epoll.EpollChannelConfig.setEpollMode.

Doc from io.netty.channel.epoll.EpollChannelConfig.setEpollMode.

Set the EpollMode used. Default is EpollMode#EDGE_TRIGGERED. If you want to use isAutoRead() false or 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.

Annotations

@Override

setIpTransparent	back to summary
public EpollSocketChannelConfig setIpTransparent(boolean transparent) If `true` is used IP_TRANSPARENT is enabled, `false` for disable it. Default is disabled.

setKeepAlive back to summary

setKeepAlive	back to summary
public EpollSocketChannelConfig setKeepAlive(boolean keepAlive) Implements io.netty.channel.socket.SocketChannelConfig.setKeepAlive. Doc from io.netty.channel.socket.SocketChannelConfig.setKeepAlive. Sets the `StandardSocketOptions#SO_KEEPALIVE` option. Annotations @Override

public EpollSocketChannelConfig setKeepAlive(boolean keepAlive)

Implements io.netty.channel.socket.SocketChannelConfig.setKeepAlive.

Doc from io.netty.channel.socket.SocketChannelConfig.setKeepAlive.

Sets the StandardSocketOptions#SO_KEEPALIVE option.

Annotations

@Override

setMaxMessagesPerRead	back to summary
public EpollSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead) Overrides io.netty.channel.epoll.EpollChannelConfig.setMaxMessagesPerRead. Implements io.netty.channel.socket.SocketChannelConfig.setMaxMessagesPerRead, io.netty.channel.ChannelConfig.setMaxMessagesPerRead. Doc from io.netty.channel.DefaultChannelConfig.setMaxMessagesPerRead. Deprecated Annotations @Override @Deprecated

setMaxMessagesPerRead

back to summary

public EpollSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Overrides io.netty.channel.epoll.EpollChannelConfig.setMaxMessagesPerRead.

Implements io.netty.channel.socket.SocketChannelConfig.setMaxMessagesPerRead, io.netty.channel.ChannelConfig.setMaxMessagesPerRead.

Doc from io.netty.channel.DefaultChannelConfig.setMaxMessagesPerRead.

Deprecated

Annotations

@Override
@Deprecated

setMessageSizeEstimator back to summary

setMessageSizeEstimator	back to summary
public EpollSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator) Overrides io.netty.channel.epoll.EpollChannelConfig.setMessageSizeEstimator. Implements io.netty.channel.socket.SocketChannelConfig.setMessageSizeEstimator, io.netty.channel.ChannelConfig.setMessageSizeEstimator. Doc from io.netty.channel.ChannelConfig.setMessageSizeEstimator. Set the `MessageSizeEstimator` which is used for the channel to detect the size of a message. Annotations @Override

public EpollSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Overrides io.netty.channel.epoll.EpollChannelConfig.setMessageSizeEstimator.

Implements io.netty.channel.socket.SocketChannelConfig.setMessageSizeEstimator, io.netty.channel.ChannelConfig.setMessageSizeEstimator.

Doc from io.netty.channel.ChannelConfig.setMessageSizeEstimator.

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

Annotations

@Override

setOption back to summary

setOption	back to summary
public <T> boolean setOption(ChannelOption<T> option, T value) Overrides io.netty.channel.epoll.EpollChannelConfig.setOption. Implements io.netty.channel.ChannelConfig.setOption. Doc from io.netty.channel.ChannelConfig.setOption. 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; } Returns:boolean `true` if and only if the property has been set Annotations @Override

public <T> boolean setOption(ChannelOption<T> option, T value)

Overrides io.netty.channel.epoll.EpollChannelConfig.setOption.

Implements io.netty.channel.ChannelConfig.setOption.

Doc from io.netty.channel.ChannelConfig.setOption.

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;
}

Returns:boolean

true if and only if the property has been set

Annotations

@Override

setPerformancePreferences back to summary

setPerformancePreferences	back to summary
public EpollSocketChannelConfig setPerformancePreferences(int connectionTime, int latency, int bandwidth) Implements io.netty.channel.socket.SocketChannelConfig.setPerformancePreferences. Doc from io.netty.channel.socket.SocketChannelConfig.setPerformancePreferences. Sets the performance preferences as specified in `Socket#setPerformancePreferences(int, int, int)`. Annotations @Override

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

Implements io.netty.channel.socket.SocketChannelConfig.setPerformancePreferences.

Doc from io.netty.channel.socket.SocketChannelConfig.setPerformancePreferences.

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

Annotations

@Override

setReceiveBufferSize back to summary

setReceiveBufferSize	back to summary
public EpollSocketChannelConfig setReceiveBufferSize(int receiveBufferSize) Implements io.netty.channel.socket.SocketChannelConfig.setReceiveBufferSize. Doc from io.netty.channel.socket.SocketChannelConfig.setReceiveBufferSize. Sets the `StandardSocketOptions#SO_RCVBUF` option. Annotations @Override

public EpollSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

Implements io.netty.channel.socket.SocketChannelConfig.setReceiveBufferSize.

Doc from io.netty.channel.socket.SocketChannelConfig.setReceiveBufferSize.

Sets the StandardSocketOptions#SO_RCVBUF option.

Annotations

@Override

setRecvByteBufAllocator back to summary

setRecvByteBufAllocator	back to summary
public EpollSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator) Overrides io.netty.channel.epoll.EpollChannelConfig.setRecvByteBufAllocator. Implements io.netty.channel.socket.SocketChannelConfig.setRecvByteBufAllocator, io.netty.channel.ChannelConfig.setRecvByteBufAllocator. Doc from io.netty.channel.ChannelConfig.setRecvByteBufAllocator. Set the `RecvByteBufAllocator` which is used for the channel to allocate receive buffers. Annotations @Override

public EpollSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Overrides io.netty.channel.epoll.EpollChannelConfig.setRecvByteBufAllocator.

Implements io.netty.channel.socket.SocketChannelConfig.setRecvByteBufAllocator, io.netty.channel.ChannelConfig.setRecvByteBufAllocator.

Doc from io.netty.channel.ChannelConfig.setRecvByteBufAllocator.

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

Annotations

@Override

setReuseAddress back to summary

setReuseAddress	back to summary
public EpollSocketChannelConfig setReuseAddress(boolean reuseAddress) Implements io.netty.channel.socket.SocketChannelConfig.setReuseAddress. Doc from io.netty.channel.socket.SocketChannelConfig.setReuseAddress. Sets the `StandardSocketOptions#SO_REUSEADDR` option. Annotations @Override

public EpollSocketChannelConfig setReuseAddress(boolean reuseAddress)

Implements io.netty.channel.socket.SocketChannelConfig.setReuseAddress.

Doc from io.netty.channel.socket.SocketChannelConfig.setReuseAddress.

Sets the StandardSocketOptions#SO_REUSEADDR option.

Annotations

@Override

setSendBufferSize back to summary

setSendBufferSize	back to summary
public EpollSocketChannelConfig setSendBufferSize(int sendBufferSize) Implements io.netty.channel.socket.SocketChannelConfig.setSendBufferSize. Doc from io.netty.channel.socket.SocketChannelConfig.setSendBufferSize. Sets the `StandardSocketOptions#SO_SNDBUF` option. Annotations @Override

public EpollSocketChannelConfig setSendBufferSize(int sendBufferSize)

Implements io.netty.channel.socket.SocketChannelConfig.setSendBufferSize.

Doc from io.netty.channel.socket.SocketChannelConfig.setSendBufferSize.

Sets the StandardSocketOptions#SO_SNDBUF option.

Annotations

@Override

setSoBusyPoll	back to summary
public EpollSocketChannelConfig setSoBusyPoll(int loopMicros) Set the `SO_BUSY_POLL` option on the socket. See `man 7 tcp` for more details.

setSoLinger back to summary

setSoLinger	back to summary
public EpollSocketChannelConfig setSoLinger(int soLinger) Implements io.netty.channel.socket.SocketChannelConfig.setSoLinger. Doc from io.netty.channel.socket.SocketChannelConfig.setSoLinger. Sets the `StandardSocketOptions#SO_LINGER` option. Annotations @Override

public EpollSocketChannelConfig setSoLinger(int soLinger)

Implements io.netty.channel.socket.SocketChannelConfig.setSoLinger.

Doc from io.netty.channel.socket.SocketChannelConfig.setSoLinger.

Sets the StandardSocketOptions#SO_LINGER option.

Annotations

@Override

setTcpCork	back to summary
public EpollSocketChannelConfig setTcpCork(boolean tcpCork) Set the `TCP_CORK` option on the socket. See `man 7 tcp` for more details.

setTcpFastOpenConnect	back to summary
public EpollSocketChannelConfig setTcpFastOpenConnect(boolean fastOpenConnect) Enables client TCP fast open. `TCP_FASTOPEN_CONNECT` normally requires Linux kernel 4.11 or later, so instead we use the traditional fast open client socket mechanics that work with kernel 3.6 and later. See this LWN article for more info.

setTcpKeepCnt	back to summary
public EpollSocketChannelConfig setTcpKeepCnt(int probes) Set the `TCP_KEEPCNT` option on the socket. See `man 7 tcp` for more details.

setTcpKeepCntl	back to summary
public EpollSocketChannelConfig setTcpKeepCntl(int probes) Deprecated use `setTcpKeepCnt(int)` Annotations @Deprecated

setTcpKeepIdle	back to summary
public EpollSocketChannelConfig setTcpKeepIdle(int seconds) Set the `TCP_KEEPIDLE` option on the socket. See `man 7 tcp` for more details.

setTcpKeepIntvl	back to summary
public EpollSocketChannelConfig setTcpKeepIntvl(int seconds) Set the `TCP_KEEPINTVL` option on the socket. See `man 7 tcp` for more details.

setTcpMd5Sig	back to summary
public EpollSocketChannelConfig setTcpMd5Sig(Map<InetAddress, byte[]> keys) Set the `TCP_MD5SIG` option on the socket. See `linux/tcp.h` for more details. Keys can only be set on, not read to prevent a potential leak, as they are confidential. Allowing them being read would mean anyone with access to the channel could get them.

setTcpNoDelay back to summary

public EpollSocketChannelConfig setTcpNoDelay(boolean tcpNoDelay)

Implements io.netty.channel.socket.SocketChannelConfig.setTcpNoDelay.

Doc from io.netty.channel.socket.SocketChannelConfig.setTcpNoDelay.

Sets the StandardSocketOptions#TCP_NODELAY option. Please note that the default value of this option is true unlike the operating system default (false). However, for some buggy platforms, such as Android, that shows erratic behavior with Nagle's algorithm disabled, the default value remains to be false.

Annotations

@Override

setTcpNotSentLowAt back to summary

public EpollSocketChannelConfig setTcpNotSentLowAt(long tcpNotSentLowAt)

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

Parameters

tcpNotSentLowAt:long: is a uint32_t

setTcpQuickAck	back to summary
public EpollSocketChannelConfig setTcpQuickAck(boolean quickAck) Set the `TCP_QUICKACK` option on the socket. See TCP_QUICKACK for more details.

setTcpUserTimeout	back to summary
public EpollSocketChannelConfig setTcpUserTimeout(int milliseconds) Set the `TCP_USER_TIMEOUT` option on the socket. See `man 7 tcp` for more details.

setTrafficClass back to summary

public EpollSocketChannelConfig setTrafficClass(int trafficClass)

Implements io.netty.channel.socket.SocketChannelConfig.setTrafficClass.

Doc from io.netty.channel.socket.SocketChannelConfig.setTrafficClass.

Sets the StandardSocketOptions#IP_TOS option.

Annotations

@Override

setWriteBufferHighWaterMark back to summary

public EpollSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Overrides io.netty.channel.epoll.EpollChannelConfig.setWriteBufferHighWaterMark.

Implements io.netty.channel.ChannelConfig.setWriteBufferHighWaterMark.

Doc from io.netty.channel.ChannelConfig.setWriteBufferHighWaterMark.

Deprecated

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.

Annotations

@Override
@Deprecated

setWriteBufferLowWaterMark back to summary

public EpollSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Overrides io.netty.channel.epoll.EpollChannelConfig.setWriteBufferLowWaterMark.

Implements io.netty.channel.ChannelConfig.setWriteBufferLowWaterMark.

Doc from io.netty.channel.ChannelConfig.setWriteBufferLowWaterMark.

Deprecated

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.

Annotations

@Override
@Deprecated

setWriteBufferWaterMark back to summary

public EpollSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Overrides io.netty.channel.epoll.EpollChannelConfig.setWriteBufferWaterMark.

Implements io.netty.channel.socket.SocketChannelConfig.setWriteBufferWaterMark, io.netty.channel.ChannelConfig.setWriteBufferWaterMark.

Doc from io.netty.channel.ChannelConfig.setWriteBufferWaterMark.

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

Annotations

@Override

setWriteSpinCount back to summary

public EpollSocketChannelConfig setWriteSpinCount(int writeSpinCount)

Overrides io.netty.channel.epoll.EpollChannelConfig.setWriteSpinCount.

Implements io.netty.channel.socket.SocketChannelConfig.setWriteSpinCount, io.netty.channel.ChannelConfig.setWriteSpinCount.

Doc from io.netty.channel.ChannelConfig.setWriteSpinCount.

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.

Annotations

@Override

public final Class EpollSocketChannelConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail