io.netty.channel.socket

接口 ServerSocketChannelConfig

所有超级接口:

ChannelConfig

所有已知子接口:

OioServerSocketChannelConfig

所有已知实现类:

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)

方法概要

限定符和类型	方法和说明
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) 已过时。
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.

从接口继承的方法 io.netty.channel.ChannelConfig

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

方法详细资料

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)

从接口复制的说明: 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.

指定者:

setConnectTimeoutMillis 在接口中 ChannelConfig

参数:

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

setMaxMessagesPerRead

@Deprecated
ServerSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

已过时。

指定者:

setMaxMessagesPerRead 在接口中 ChannelConfig

setWriteSpinCount

ServerSocketChannelConfig setWriteSpinCount(int writeSpinCount)

从接口复制的说明: 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.

指定者:

setWriteSpinCount 在接口中 ChannelConfig

setAllocator

ServerSocketChannelConfig setAllocator(ByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setAllocator 在接口中 ChannelConfig

setRecvByteBufAllocator

ServerSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setRecvByteBufAllocator 在接口中 ChannelConfig

setAutoRead

ServerSocketChannelConfig setAutoRead(boolean autoRead)

从接口复制的说明: 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.

指定者:

setAutoRead 在接口中 ChannelConfig

setMessageSizeEstimator

ServerSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

从接口复制的说明: ChannelConfig

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

指定者:

setMessageSizeEstimator 在接口中 ChannelConfig

setWriteBufferHighWaterMark

ServerSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

从接口复制的说明: 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.

指定者:

setWriteBufferHighWaterMark 在接口中 ChannelConfig

setWriteBufferLowWaterMark

ServerSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

从接口复制的说明: 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.

指定者:

setWriteBufferLowWaterMark 在接口中 ChannelConfig

setWriteBufferWaterMark

ServerSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

从接口复制的说明: ChannelConfig

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

指定者:

setWriteBufferWaterMark 在接口中 ChannelConfig