io.netty.channel.socket.oio

Interface OioSocketChannelConfig

All Superinterfaces:

ChannelConfig, SocketChannelConfig

All Known Implementing Classes:

DefaultOioSocketChannelConfig

public interface OioSocketChannelConfig
extends SocketChannelConfig

A ChannelConfig for a OioSocketChannel.

Available options

In addition to the options provided by SocketChannelConfig, OioSocketChannelConfig allows the following options in the option map:

Name	Associated setter method
ChannelOption.SO_TIMEOUT	setSoTimeout(int)

Method Summary

Methods

Modifier and Type	Method and Description
int	getSoTimeout() Returns the maximal time a operation on the underlying socket may block.
OioSocketChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
OioSocketChannelConfig	setAllowHalfClosure(boolean allowHalfClosure) Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
OioSocketChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
OioSocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
OioSocketChannelConfig	setKeepAlive(boolean keepAlive) Sets the StandardSocketOptions.SO_KEEPALIVE option.
OioSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Sets the maximum number of messages to read per read loop.
OioSocketChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Set the ByteBufAllocator which is used for the channel to detect the size of a message.
OioSocketChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets the performance preferences as specified in Socket.setPerformancePreferences(int, int, int).
OioSocketChannelConfig	setReceiveBufferSize(int receiveBufferSize) Sets the StandardSocketOptions.SO_RCVBUF option.
OioSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
OioSocketChannelConfig	setReuseAddress(boolean reuseAddress) Sets the StandardSocketOptions.SO_REUSEADDR option.
OioSocketChannelConfig	setSendBufferSize(int sendBufferSize) Sets the StandardSocketOptions.SO_SNDBUF option.
OioSocketChannelConfig	setSoLinger(int soLinger) Sets the StandardSocketOptions.SO_LINGER option.
OioSocketChannelConfig	setSoTimeout(int timeout) Sets the maximal time a operation on the underlying socket may block.
OioSocketChannelConfig	setTcpNoDelay(boolean tcpNoDelay) Sets the StandardSocketOptions.TCP_NODELAY option.
OioSocketChannelConfig	setTrafficClass(int trafficClass) Sets the StandardSocketOptions.IP_TOS option.
OioSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
OioSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
OioSocketChannelConfig	setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

Methods inherited from interface io.netty.channel.socket.SocketChannelConfig

getReceiveBufferSize, getSendBufferSize, getSoLinger, getTrafficClass, isAllowHalfClosure, isKeepAlive, isReuseAddress, isTcpNoDelay

Methods inherited from interface io.netty.channel.ChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoRead, setOption, setOptions

Method Detail

setSoTimeout

OioSocketChannelConfig setSoTimeout(int timeout)

Sets the maximal time a operation on the underlying socket may block.

getSoTimeout

int getSoTimeout()

Returns the maximal time a operation on the underlying socket may block.

setTcpNoDelay

OioSocketChannelConfig 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

setSoLinger

OioSocketChannelConfig setSoLinger(int soLinger)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_LINGER option.

Specified by:

setSoLinger in interface SocketChannelConfig

setSendBufferSize

OioSocketChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

setSendBufferSize in interface SocketChannelConfig

setReceiveBufferSize

OioSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

setReceiveBufferSize in interface SocketChannelConfig

setKeepAlive

OioSocketChannelConfig setKeepAlive(boolean keepAlive)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_KEEPALIVE option.

Specified by:

setKeepAlive in interface SocketChannelConfig

setTrafficClass

OioSocketChannelConfig setTrafficClass(int trafficClass)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.IP_TOS option.

Specified by:

setTrafficClass in interface SocketChannelConfig

setReuseAddress

OioSocketChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface SocketChannelConfig

setPerformancePreferences

OioSocketChannelConfig 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

setAllowHalfClosure

OioSocketChannelConfig 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

OioSocketChannelConfig 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

Parameters:

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

setMaxMessagesPerRead

OioSocketChannelConfig 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

setWriteSpinCount

OioSocketChannelConfig 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

setAllocator

OioSocketChannelConfig 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

setRecvByteBufAllocator

OioSocketChannelConfig 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

setAutoRead

OioSocketChannelConfig 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

setWriteBufferHighWaterMark

OioSocketChannelConfig 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

setWriteBufferLowWaterMark

OioSocketChannelConfig 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

setMessageSizeEstimator

OioSocketChannelConfig 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