io.netty.channel.epoll

Class EpollSocketChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.epoll.EpollChannelConfig

io.netty.channel.epoll.EpollSocketChannelConfig

All Implemented Interfaces:

ChannelConfig, SocketChannelConfig

public final class EpollSocketChannelConfig
extends EpollChannelConfig
implements SocketChannelConfig

Method Summary

Methods

Modifier and Type	Method and Description
<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	getSendBufferSize() Gets the StandardSocketOptions.SO_SNDBUF option.
int	getSoLinger() Gets the StandardSocketOptions.SO_LINGER option.
int	getTcpKeepCnt() Get the TCP_KEEPCNT option on the socket.
int	getTcpKeepIdle() Get the TCP_KEEPIDLE option on the socket.
int	getTcpKeepIntvl() Get the TCP_KEEPINTVL option on the socket.
int	getTrafficClass() Gets the StandardSocketOptions.IP_TOS option.
boolean	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.
boolean	isKeepAlive() Gets the StandardSocketOptions.SO_KEEPALIVE option.
boolean	isReuseAddress() Gets the StandardSocketOptions.SO_REUSEADDR option.
boolean	isTcpCork() Get the TCP_CORK option on the socket.
boolean	isTcpNoDelay() Gets the StandardSocketOptions.TCP_NODELAY option.
EpollSocketChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
EpollSocketChannelConfig	setAllowHalfClosure(boolean allowHalfClosure) Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
EpollSocketChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
EpollSocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
EpollSocketChannelConfig	setEpollMode(EpollMode mode) Set the EpollMode used.
EpollSocketChannelConfig	setKeepAlive(boolean keepAlive) Sets the StandardSocketOptions.SO_KEEPALIVE option.
EpollSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Sets the maximum number of messages to read per read loop.
EpollSocketChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Set the ByteBufAllocator 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.
EpollSocketChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets the performance preferences as specified in Socket.setPerformancePreferences(int, int, int).
EpollSocketChannelConfig	setReceiveBufferSize(int receiveBufferSize) Sets the StandardSocketOptions.SO_RCVBUF option.
EpollSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
EpollSocketChannelConfig	setReuseAddress(boolean reuseAddress) Sets the StandardSocketOptions.SO_REUSEADDR option.
EpollSocketChannelConfig	setSendBufferSize(int sendBufferSize) Sets the StandardSocketOptions.SO_SNDBUF option.
EpollSocketChannelConfig	setSoLinger(int soLinger) Sets the StandardSocketOptions.SO_LINGER option.
EpollSocketChannelConfig	setTcpCork(boolean tcpCork) Set the TCP_CORK option on the socket.
EpollSocketChannelConfig	setTcpKeepCntl(int probes) Set the TCP_KEEPCNT option on the socket.
EpollSocketChannelConfig	setTcpKeepIdle(int seconds) Set the TCP_KEEPIDLE option on the socket.
EpollSocketChannelConfig	setTcpKeepIntvl(int seconds) Set the TCP_KEEPINTVL option on the socket.
EpollSocketChannelConfig	setTcpNoDelay(boolean tcpNoDelay) Sets the StandardSocketOptions.TCP_NODELAY option.
EpollSocketChannelConfig	setTrafficClass(int trafficClass) Sets the StandardSocketOptions.IP_TOS option.
EpollSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
EpollSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
EpollSocketChannelConfig	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, getWriteSpinCount, 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, getWriteSpinCount, isAutoRead, setOptions

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

getReceiveBufferSize

public int getReceiveBufferSize()

Description copied from interface: SocketChannelConfig

Gets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

getReceiveBufferSize in interface SocketChannelConfig

getSendBufferSize

public int getSendBufferSize()

Description copied from interface: SocketChannelConfig

Gets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

getSendBufferSize in interface SocketChannelConfig

getSoLinger

public int getSoLinger()

Description copied from interface: SocketChannelConfig

Gets the StandardSocketOptions.SO_LINGER option.

Specified by:

getSoLinger in interface SocketChannelConfig

getTrafficClass

public int getTrafficClass()

Description copied from interface: SocketChannelConfig

Gets the StandardSocketOptions.IP_TOS option.

Specified by:

getTrafficClass in interface SocketChannelConfig

isKeepAlive

public boolean isKeepAlive()

Description copied from interface: SocketChannelConfig

Gets the StandardSocketOptions.SO_KEEPALIVE option.

Specified by:

isKeepAlive in interface SocketChannelConfig

isReuseAddress

public boolean isReuseAddress()

Description copied from interface: SocketChannelConfig

Gets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

isReuseAddress in interface SocketChannelConfig

isTcpNoDelay

public boolean isTcpNoDelay()

Description copied from interface: SocketChannelConfig

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.

Specified by:

isTcpNoDelay in interface SocketChannelConfig

isTcpCork

public boolean isTcpCork()

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

getTcpKeepIdle

public int getTcpKeepIdle()

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

getTcpKeepIntvl

public int getTcpKeepIntvl()

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

getTcpKeepCnt

public int getTcpKeepCnt()

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

setKeepAlive

public EpollSocketChannelConfig setKeepAlive(boolean keepAlive)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_KEEPALIVE option.

Specified by:

setKeepAlive in interface SocketChannelConfig

setPerformancePreferences

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

Description copied from interface: SocketChannelConfig

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

Specified by:

setPerformancePreferences in interface SocketChannelConfig

setReceiveBufferSize

public EpollSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

setReceiveBufferSize in interface SocketChannelConfig

setReuseAddress

public EpollSocketChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface SocketChannelConfig

setSendBufferSize

public EpollSocketChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

setSendBufferSize in interface SocketChannelConfig

setSoLinger

public EpollSocketChannelConfig setSoLinger(int soLinger)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_LINGER option.

Specified by:

setSoLinger in interface SocketChannelConfig

setTcpNoDelay

public EpollSocketChannelConfig setTcpNoDelay(boolean tcpNoDelay)

Description copied from interface: SocketChannelConfig

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.

Specified by:

setTcpNoDelay in interface SocketChannelConfig

setTcpCork

public EpollSocketChannelConfig setTcpCork(boolean tcpCork)

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

setTrafficClass

public EpollSocketChannelConfig setTrafficClass(int trafficClass)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.IP_TOS option.

Specified by:

setTrafficClass in interface SocketChannelConfig

setTcpKeepIdle

public EpollSocketChannelConfig setTcpKeepIdle(int seconds)

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

setTcpKeepIntvl

public EpollSocketChannelConfig setTcpKeepIntvl(int seconds)

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

setTcpKeepCntl

public EpollSocketChannelConfig setTcpKeepCntl(int probes)

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

isAllowHalfClosure

public boolean isAllowHalfClosure()

Description copied from interface: SocketChannelConfig

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.

Specified by:

isAllowHalfClosure in interface SocketChannelConfig

setAllowHalfClosure

public EpollSocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)

Description copied from interface: SocketChannelConfig

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, ChannelHandler.userEventTriggered(ChannelHandlerContext, Object) is invoked with a ChannelInputShutdownEvent object. If false, the connection is closed automatically.

Specified by:

setAllowHalfClosure in interface SocketChannelConfig

setConnectTimeoutMillis

public EpollSocketChannelConfig 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 SocketChannelConfig

Overrides:

setConnectTimeoutMillis in class EpollChannelConfig

Parameters:

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

setMaxMessagesPerRead

public EpollSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Description copied from interface: ChannelConfig

Sets the maximum number of messages to read per read loop. If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface SocketChannelConfig

Overrides:

setMaxMessagesPerRead in class EpollChannelConfig

setWriteSpinCount

public EpollSocketChannelConfig 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 SocketChannelConfig

Overrides:

setWriteSpinCount in class EpollChannelConfig

setAllocator

public EpollSocketChannelConfig 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 SocketChannelConfig

Overrides:

setAllocator in class EpollChannelConfig

setRecvByteBufAllocator

public EpollSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

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

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

Specified by:

setRecvByteBufAllocator in interface SocketChannelConfig

Overrides:

setRecvByteBufAllocator in class EpollChannelConfig

setAutoRead

public EpollSocketChannelConfig 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 SocketChannelConfig

Overrides:

setAutoRead in class EpollChannelConfig

setWriteBufferHighWaterMark

public EpollSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

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

Overrides:

setWriteBufferHighWaterMark in class EpollChannelConfig

setWriteBufferLowWaterMark

public EpollSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

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

Overrides:

setWriteBufferLowWaterMark in class EpollChannelConfig

setMessageSizeEstimator

public EpollSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Description copied from interface: ChannelConfig

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

Specified by:

setMessageSizeEstimator in interface ChannelConfig

Specified by:

setMessageSizeEstimator in interface SocketChannelConfig

Overrides:

setMessageSizeEstimator in class EpollChannelConfig

setEpollMode

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