io.netty.channel.socket.oio

Interface OioServerSocketChannelConfig

All Superinterfaces:

ChannelConfig, ServerSocketChannelConfig

All Known Implementing Classes:

DefaultOioServerSocketChannelConfig

public interface OioServerSocketChannelConfig
extends ServerSocketChannelConfig

A ServerSocketChannelConfig for a OioServerSocketChannel.

Available options

In addition to the options provided by ServerSocketChannelConfig, OioServerSocketChannelConfig allows the following options in the option map:

Name	Associated setter method
ChannelOption.SO_TIMEOUT	setSoTimeout(int)

Method Summary

Modifier and Type	Method and Description
int	getSoTimeout() Returns the maximal time a operation on the underlying socket may block.
OioServerSocketChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
OioServerSocketChannelConfig	setAutoClose(boolean autoClose)
OioServerSocketChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
OioServerSocketChannelConfig	setBacklog(int backlog) Sets the backlog value to specify when the channel binds to a local address.
OioServerSocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
OioServerSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Sets the maximum number of messages to read per read loop.
OioServerSocketChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
OioServerSocketChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets the performance preferences as specified in ServerSocket.setPerformancePreferences(int, int, int).
OioServerSocketChannelConfig	setReceiveBufferSize(int receiveBufferSize) Gets the StandardSocketOptions.SO_SNDBUF option.
OioServerSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
OioServerSocketChannelConfig	setReuseAddress(boolean reuseAddress) Sets the StandardSocketOptions.SO_REUSEADDR option.
OioServerSocketChannelConfig	setSoTimeout(int timeout) Sets the maximal time a operation on the underlying socket may block.
OioServerSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
OioServerSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
OioServerSocketChannelConfig	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.ServerSocketChannelConfig

getBacklog, getReceiveBufferSize, isReuseAddress

Methods inherited from interface io.netty.channel.ChannelConfig

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

Method Detail

setSoTimeout

OioServerSocketChannelConfig 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.

setBacklog

OioServerSocketChannelConfig 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

setReuseAddress

OioServerSocketChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: ServerSocketChannelConfig

Sets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface ServerSocketChannelConfig

setReceiveBufferSize

OioServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: ServerSocketChannelConfig

Gets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

setReceiveBufferSize in interface ServerSocketChannelConfig

setPerformancePreferences

OioServerSocketChannelConfig 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

OioServerSocketChannelConfig 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

Parameters:

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

setMaxMessagesPerRead

OioServerSocketChannelConfig 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 ServerSocketChannelConfig

setWriteSpinCount

OioServerSocketChannelConfig 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

setAllocator

OioServerSocketChannelConfig 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

setRecvByteBufAllocator

OioServerSocketChannelConfig 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 ServerSocketChannelConfig

setAutoRead

OioServerSocketChannelConfig 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

setAutoClose

OioServerSocketChannelConfig setAutoClose(boolean autoClose)

Specified by:

setAutoClose in interface ChannelConfig

setWriteBufferHighWaterMark

OioServerSocketChannelConfig 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

OioServerSocketChannelConfig 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

OioServerSocketChannelConfig 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