io.netty.channel.socket

Interface ServerSocketChannelConfig

All Superinterfaces:

ChannelConfig

All Known Subinterfaces:

OioServerSocketChannelConfig

All Known Implementing Classes:

DefaultOioServerSocketChannelConfig, DefaultServerSocketChannelConfig, EpollServerChannelConfig, EpollServerSocketChannelConfig, KQueueServerChannelConfig, KQueueServerSocketChannelConfig

public interface ServerSocketChannelConfig
extends ChannelConfig

A ChannelConfig for a ServerSocketChannel.

Available options

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

Name	Associated setter method
"backlog"	setBacklog(int)
"reuseAddress"	setReuseAddress(boolean)
"receiveBufferSize"	setReceiveBufferSize(int)

Method Summary

Modifier and Type	Method and Description
int	getBacklog() Gets the backlog value to specify when the channel binds to a local address.
int	getReceiveBufferSize() Gets the StandardSocketOptions.SO_RCVBUF option.
boolean	isReuseAddress() Gets the StandardSocketOptions.SO_REUSEADDR option.
ServerSocketChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
ServerSocketChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
ServerSocketChannelConfig	setBacklog(int backlog) Sets the backlog value to specify when the channel binds to a local address.
ServerSocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
ServerSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Deprecated.
ServerSocketChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
ServerSocketChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets the performance preferences as specified in ServerSocket.setPerformancePreferences(int, int, int).
ServerSocketChannelConfig	setReceiveBufferSize(int receiveBufferSize) Gets the StandardSocketOptions.SO_SNDBUF option.
ServerSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
ServerSocketChannelConfig	setReuseAddress(boolean reuseAddress) Sets the StandardSocketOptions.SO_REUSEADDR option.
ServerSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
ServerSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
ServerSocketChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
ServerSocketChannelConfig	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.ChannelConfig

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

Method Detail

getBacklog

int getBacklog()

Gets the backlog value to specify when the channel binds to a local address.

setBacklog

ServerSocketChannelConfig setBacklog(int backlog)

Sets the backlog value to specify when the channel binds to a local address.

isReuseAddress

boolean isReuseAddress()

Gets the StandardSocketOptions.SO_REUSEADDR option.

setReuseAddress

ServerSocketChannelConfig setReuseAddress(boolean reuseAddress)

Sets the StandardSocketOptions.SO_REUSEADDR option.

getReceiveBufferSize

int getReceiveBufferSize()

Gets the StandardSocketOptions.SO_RCVBUF option.

setReceiveBufferSize

ServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

Gets the StandardSocketOptions.SO_SNDBUF option.

setPerformancePreferences

ServerSocketChannelConfig setPerformancePreferences(int connectionTime,
                                                    int latency,
                                                    int bandwidth)

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

setConnectTimeoutMillis

ServerSocketChannelConfig 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

Parameters:

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

setMaxMessagesPerRead

@Deprecated
ServerSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

setWriteSpinCount

ServerSocketChannelConfig 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

setAllocator

ServerSocketChannelConfig 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

setRecvByteBufAllocator

ServerSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

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

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

setAutoRead

ServerSocketChannelConfig 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

setMessageSizeEstimator

ServerSocketChannelConfig 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

setWriteBufferHighWaterMark

ServerSocketChannelConfig 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

ServerSocketChannelConfig 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

setWriteBufferWaterMark

ServerSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Description copied from interface: ChannelConfig

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

Specified by:

setWriteBufferWaterMark in interface ChannelConfig