io.netty.channel.socket

类 DefaultServerSocketChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.socket.DefaultServerSocketChannelConfig

所有已实现的接口:

ChannelConfig, ServerSocketChannelConfig

直接已知子类:

DefaultOioServerSocketChannelConfig

public class DefaultServerSocketChannelConfig
extends DefaultChannelConfig
implements ServerSocketChannelConfig

The default ServerSocketChannelConfig implementation.

字段概要

字段

限定符和类型	字段和说明
protected java.net.ServerSocket	javaSocket

从类继承的字段 io.netty.channel.DefaultChannelConfig

channel

构造器概要

构造器

构造器和说明
DefaultServerSocketChannelConfig(ServerSocketChannel channel, java.net.ServerSocket javaSocket) Creates a new instance.

方法概要

方法

限定符和类型	方法和说明
int	getBacklog() Gets the backlog value to specify when the channel binds to a local address.
<T> T	getOption(ChannelOption<T> option) Return the value of the given ChannelOption
java.util.Map<ChannelOption<?>,java.lang.Object>	getOptions() Return all set ChannelOption's.
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) Sets the maximum number of messages to read per read loop.
ServerSocketChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Set the MessageSizeEstimator 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.
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 ByteBufAllocator 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	setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

从类继承的方法 io.netty.channel.DefaultChannelConfig

autoReadCleared, getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setOptions, validate

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setOptions

字段详细资料

javaSocket

protected final java.net.ServerSocket javaSocket

构造器详细资料

DefaultServerSocketChannelConfig

public DefaultServerSocketChannelConfig(ServerSocketChannel channel,
                                java.net.ServerSocket javaSocket)

Creates a new instance.

方法详细资料

getOptions

public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()

从接口复制的说明: ChannelConfig

Return all set ChannelOption's.

指定者:

getOptions 在接口中 ChannelConfig

覆盖:

getOptions 在类中 DefaultChannelConfig

getOption

public <T> T getOption(ChannelOption<T> option)

从接口复制的说明: ChannelConfig

Return the value of the given ChannelOption

指定者:

getOption 在接口中 ChannelConfig

覆盖:

getOption 在类中 DefaultChannelConfig

setOption

public <T> boolean setOption(ChannelOption<T> option,
                    T value)

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

指定者:

setOption 在接口中 ChannelConfig

覆盖:

setOption 在类中 DefaultChannelConfig

返回:

true if and only if the property has been set

isReuseAddress

public boolean isReuseAddress()

从接口复制的说明: ServerSocketChannelConfig

Gets the StandardSocketOptions.SO_REUSEADDR option.

指定者:

isReuseAddress 在接口中 ServerSocketChannelConfig

setReuseAddress

public ServerSocketChannelConfig setReuseAddress(boolean reuseAddress)

从接口复制的说明: ServerSocketChannelConfig

Sets the StandardSocketOptions.SO_REUSEADDR option.

指定者:

setReuseAddress 在接口中 ServerSocketChannelConfig

getReceiveBufferSize

public int getReceiveBufferSize()

从接口复制的说明: ServerSocketChannelConfig

Gets the StandardSocketOptions.SO_RCVBUF option.

指定者:

getReceiveBufferSize 在接口中 ServerSocketChannelConfig

setReceiveBufferSize

public ServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

从接口复制的说明: ServerSocketChannelConfig

Gets the StandardSocketOptions.SO_SNDBUF option.

指定者:

setReceiveBufferSize 在接口中 ServerSocketChannelConfig

setPerformancePreferences

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

从接口复制的说明: ServerSocketChannelConfig

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

指定者:

setPerformancePreferences 在接口中 ServerSocketChannelConfig

getBacklog

public int getBacklog()

从接口复制的说明: ServerSocketChannelConfig

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

指定者:

getBacklog 在接口中 ServerSocketChannelConfig

setBacklog

public ServerSocketChannelConfig setBacklog(int backlog)

从接口复制的说明: ServerSocketChannelConfig

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

指定者:

setBacklog 在接口中 ServerSocketChannelConfig

setConnectTimeoutMillis

public 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

指定者:

setConnectTimeoutMillis 在接口中 ServerSocketChannelConfig

覆盖:

setConnectTimeoutMillis 在类中 DefaultChannelConfig

参数:

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

setMaxMessagesPerRead

public ServerSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

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

指定者:

setMaxMessagesPerRead 在接口中 ChannelConfig

指定者:

setMaxMessagesPerRead 在接口中 ServerSocketChannelConfig

覆盖:

setMaxMessagesPerRead 在类中 DefaultChannelConfig

setWriteSpinCount

public 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

指定者:

setWriteSpinCount 在接口中 ServerSocketChannelConfig

覆盖:

setWriteSpinCount 在类中 DefaultChannelConfig

setAllocator

public ServerSocketChannelConfig setAllocator(ByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setAllocator 在接口中 ChannelConfig

指定者:

setAllocator 在接口中 ServerSocketChannelConfig

覆盖:

setAllocator 在类中 DefaultChannelConfig

setRecvByteBufAllocator

public ServerSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setRecvByteBufAllocator 在接口中 ChannelConfig

指定者:

setRecvByteBufAllocator 在接口中 ServerSocketChannelConfig

覆盖:

setRecvByteBufAllocator 在类中 DefaultChannelConfig

setAutoRead

public 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

指定者:

setAutoRead 在接口中 ServerSocketChannelConfig

覆盖:

setAutoRead 在类中 DefaultChannelConfig

setWriteBufferHighWaterMark

public 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

覆盖:

setWriteBufferHighWaterMark 在类中 DefaultChannelConfig

setWriteBufferLowWaterMark

public 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

覆盖:

setWriteBufferLowWaterMark 在类中 DefaultChannelConfig

setMessageSizeEstimator

public ServerSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

从接口复制的说明: ChannelConfig

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

指定者:

setMessageSizeEstimator 在接口中 ChannelConfig

指定者:

setMessageSizeEstimator 在接口中 ServerSocketChannelConfig

覆盖:

setMessageSizeEstimator 在类中 DefaultChannelConfig