DefaultServerSocketChannelConfig (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.DefaultChannelConfig
- - io.netty.channel.socket.DefaultServerSocketChannelConfig

All Implemented Interfaces:

ChannelConfig ， ServerSocketChannelConfig

已知直接子类：

DefaultOioServerSocketChannelConfig
```
public class DefaultServerSocketChannelConfig
extends DefaultChannelConfig
implements ServerSocketChannelConfig
```
默认的ServerSocketChannelConfig实现。

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.net.ServerSocket`	`javaSocket`

Fields inherited from class io.netty.channel.DefaultChannelConfig
channel

构造方法摘要

构造方法
Constructor and Description
`DefaultServerSocketChannelConfig(ServerSocketChannel channel, java.net.ServerSocket javaSocket)` 创建一个新的实例。

方法摘要

所有方法接口方法具体的方法弃用的方法
Modifier and Type	Method and Description
`int`	`getBacklog()` 获取积压值以指定通道绑定到本地地址的时间。
`<T> T`	`getOption(ChannelOption<T> option)` 返回给定`ChannelOption`的值
`java.util.Map<ChannelOption<?>,java.lang.Object>`	`getOptions()` 返回所有设置`ChannelOption`的。
`int`	`getReceiveBufferSize()` 获取 `StandardSocketOptions.SO_RCVBUF`选项。
`boolean`	`isReuseAddress()` 获取 `StandardSocketOptions.SO_REUSEADDR`选项。
`ServerSocketChannelConfig`	`setAllocator(ByteBufAllocator allocator)` 设置用于通道分配缓冲区的`ByteBufAllocator` 。
`ServerSocketChannelConfig`	`setAutoRead(boolean autoRead)` 设置是否自动调用 `ChannelHandlerContext.read()`，以便用户应用程序根本不需要调用它。
`ServerSocketChannelConfig`	`setBacklog(int backlog)` 设置积压值以指定通道绑定到本地地址的时间。
`ServerSocketChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` 以毫秒为单位设置通道的连接超时。
`ServerSocketChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`ServerSocketChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` 设置用于通道的`MessageSizeEstimator`以检测消息的大小。
`<T> boolean`	`setOption(ChannelOption<T> option, T value)` 使用指定的名称和值设置配置属性。
`ServerSocketChannelConfig`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` 设置 `ServerSocket.setPerformancePreferences(int, int, int)`指定的性能首选项。
`ServerSocketChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)` 获取 `StandardSocketOptions.SO_SNDBUF`选项。
`ServerSocketChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` 设置用于通道分配接收缓冲区的`RecvByteBufAllocator` 。
`ServerSocketChannelConfig`	`setReuseAddress(boolean reuseAddress)` 设置 `StandardSocketOptions.SO_REUSEADDR`选项。
`ServerSocketChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` 设置写入缓冲区的高位标记。
`ServerSocketChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` 设置写入缓冲区的低水位标志。
`ServerSocketChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` 设置`WriteBufferWaterMark` ，用于设置写入缓冲区的高位和低位水印。
`ServerSocketChannelConfig`	`setWriteSpinCount(int writeSpinCount)` 设置写操作的最大循环计数，直到 `WritableByteChannel.write(ByteBuffer)`返回非零值。

Methods inherited from class io.netty.channel.DefaultChannelConfig
autoReadCleared, getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setOptions, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setOptions

- 字段详细信息
  - javaSocket
```
protected final java.net.ServerSocket javaSocket
```
- 构造方法详细信息
  - DefaultServerSocketChannelConfig
```
public DefaultServerSocketChannelConfig(ServerSocketChannel channel,
                                        java.net.ServerSocket javaSocket)
```
    创建一个新的实例。
- 方法详细信息
  - getOptions
```
public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
```
    从接口ChannelConfig复制的描述
    
    返回所有设置ChannelOption的。
    
    Specified by:
    
    getOptions在界面 ChannelConfig
    
    重写：
    
    getOptions在课堂上 DefaultChannelConfig
  - getOption
```
public <T> T getOption(ChannelOption<T> option)
```
    从接口ChannelConfig复制的描述
    
    返回给定的ChannelOption的值
    
    Specified by:
    
    getOption ，界面 ChannelConfig
    
    重写：
    
    getOption在课堂上 DefaultChannelConfig
  - setOption
```
public <T> boolean setOption(ChannelOption<T> option,
                             T value)
```
    从接口ChannelConfig复制的描述
    使用指定的名称和值设置配置属性。要正确覆盖此方法，您必须调用超类：
```
  public boolean setOption(ChannelOption<T> option, T value) {
     if (super.setOption(option, value)) {
         return true;
     }

     if (option.equals(additionalOption)) {
         ....
         return true;
     }

     return false;
 } 
```
    Specified by:
    
    setOption在界面 ChannelConfig
    
    重写：
    
    setOption在课堂上 DefaultChannelConfig
    
    结果
    
    true当且仅当该属性已设置
  - isReuseAddress
```
public boolean isReuseAddress()
```
    从接口ServerSocketChannelConfig复制的描述
    
    获取 StandardSocketOptions.SO_REUSEADDR选项。
    
    Specified by:
    
    isReuseAddress接口 ServerSocketChannelConfig
  - setReuseAddress
```
public ServerSocketChannelConfig setReuseAddress(boolean reuseAddress)
```
    从接口ServerSocketChannelConfig复制的描述
    
    设置 StandardSocketOptions.SO_REUSEADDR选项。
    
    Specified by:
    
    setReuseAddress在界面 ServerSocketChannelConfig
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    从接口ServerSocketChannelConfig复制的描述
    
    获取 StandardSocketOptions.SO_RCVBUF选项。
    
    Specified by:
    
    getReceiveBufferSize在界面 ServerSocketChannelConfig
  - setReceiveBufferSize
```
public ServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    从接口ServerSocketChannelConfig复制的描述
    
    获取 StandardSocketOptions.SO_SNDBUF选项。
    
    Specified by:
    
    setReceiveBufferSize在界面 ServerSocketChannelConfig
  - setPerformancePreferences
```
public ServerSocketChannelConfig setPerformancePreferences(int connectionTime,
                                                           int latency,
                                                           int bandwidth)
```
    从界面复制的描述： ServerSocketChannelConfig
    
    设置 ServerSocket.setPerformancePreferences(int, int, int)指定的性能首选项。
    
    Specified by:
    
    setPerformancePreferences在界面 ServerSocketChannelConfig
  - getBacklog
```
public int getBacklog()
```
    从接口复制的描述： ServerSocketChannelConfig
    
    获取积压值以指定通道绑定到本地地址的时间。
    
    Specified by:
    
    getBacklog ，界面 ServerSocketChannelConfig
  - setBacklog
```
public ServerSocketChannelConfig setBacklog(int backlog)
```
    从接口ServerSocketChannelConfig复制的描述
    
    设置积压值以指定通道绑定到本地地址的时间。
    
    Specified by:
    
    setBacklog ，界面 ServerSocketChannelConfig
  - setConnectTimeoutMillis
```
public ServerSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    从接口复制的描述： ChannelConfig
    
    以毫秒为单位设置通道的连接超时。如果Channel不支持连接操作，则完全不使用此属性，因此将被忽略。
    
    Specified by:
    
    setConnectTimeoutMillis在界面 ChannelConfig
    
    Specified by:
    
    setConnectTimeoutMillis在界面 ServerSocketChannelConfig
    
    重写：
    
    setConnectTimeoutMillis在课堂上 DefaultChannelConfig
    
    参数
    
    connectTimeoutMillis - 以毫秒为单位的连接超时。 0禁用。
  - setMaxMessagesPerRead
```
@Deprecated
public ServerSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    从类复制的描述： DefaultChannelConfig
    
    Specified by:
    
    setMaxMessagesPerRead ，界面 ChannelConfig
    
    Specified by:
    
    setMaxMessagesPerRead在界面 ServerSocketChannelConfig
    
    重写：
    
    setMaxMessagesPerRead在课堂 DefaultChannelConfig
  - setWriteSpinCount
```
public ServerSocketChannelConfig setWriteSpinCount(int writeSpinCount)
```
    从界面复制的描述： ChannelConfig
    
    设置写操作的最大循环计数，直到WritableByteChannel.write(ByteBuffer)返回非零值。它类似于在并发编程中使用自旋锁。它可以提高内存利用率并根据运行JVM的平台来编写吞吐量。默认值是16 。
    
    Specified by:
    
    setWriteSpinCount在界面 ChannelConfig
    
    Specified by:
    
    setWriteSpinCount在界面 ServerSocketChannelConfig
    
    重写：
    
    setWriteSpinCount在课堂上 DefaultChannelConfig
  - setAllocator
```
public ServerSocketChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口ChannelConfig复制的描述
    
    设置用于通道分配缓冲区的ByteBufAllocator 。
    
    Specified by:
    
    setAllocator在界面 ChannelConfig
    
    Specified by:
    
    setAllocator在界面 ServerSocketChannelConfig
    
    重写：
    
    setAllocator在课堂上 DefaultChannelConfig
  - setRecvByteBufAllocator
```
public ServerSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口ChannelConfig复制的描述
    
    设置用于通道分配接收缓冲区的RecvByteBufAllocator 。
    
    Specified by:
    
    setRecvByteBufAllocator在界面 ChannelConfig
    
    Specified by:
    
    setRecvByteBufAllocator在界面 ServerSocketChannelConfig
    
    重写：
    
    setRecvByteBufAllocator在课堂上 DefaultChannelConfig
  - setAutoRead
```
public ServerSocketChannelConfig setAutoRead(boolean autoRead)
```
    从界面复制的描述： ChannelConfig
    
    设置是否将自动调用ChannelHandlerContext.read()，以便用户应用程序根本不需要调用它。默认值是true 。
    
    Specified by:
    
    setAutoRead在界面 ChannelConfig
    
    Specified by:
    
    setAutoRead ，界面 ServerSocketChannelConfig
    
    重写：
    
    setAutoRead在课堂上 DefaultChannelConfig
  - setWriteBufferHighWaterMark
```
public ServerSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
```
    从接口复制的描述： ChannelConfig
    
    设置写入缓冲区的高位标记。如果写入缓冲区中排队的字节数超过此值，则Channel.isWritable()将开始返回false 。
    
    Specified by:
    
    setWriteBufferHighWaterMark在界面 ChannelConfig
    
    Specified by:
    
    setWriteBufferHighWaterMark在界面 ServerSocketChannelConfig
    
    重写：
    
    setWriteBufferHighWaterMark在课堂上 DefaultChannelConfig
  - setWriteBufferLowWaterMark
```
public ServerSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
```
    从界面复制的描述： ChannelConfig
    
    设置写入缓冲区的低水位标志。一旦写入缓冲区中排队的字节数超过了high water mark ，然后下降到此值以下， Channel.isWritable()将再次开始返回true 。
    
    Specified by:
    
    setWriteBufferLowWaterMark在界面 ChannelConfig
    
    Specified by:
    
    setWriteBufferLowWaterMark在界面 ServerSocketChannelConfig
    
    重写：
    
    setWriteBufferLowWaterMark在课堂上 DefaultChannelConfig
  - setWriteBufferWaterMark
```
public ServerSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    从接口复制的描述： ChannelConfig
    
    设置WriteBufferWaterMark ，用于设置写入缓冲区的高位和低位水印。
    
    Specified by:
    
    setWriteBufferWaterMark ，界面 ChannelConfig
    
    Specified by:
    
    setWriteBufferWaterMark在界面 ServerSocketChannelConfig
    
    重写：
    
    setWriteBufferWaterMark在课堂上 DefaultChannelConfig
  - setMessageSizeEstimator
```
public ServerSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口复制的描述： ChannelConfig
    
    设置用于通道的MessageSizeEstimator以检测消息的大小。
    
    Specified by:
    
    setMessageSizeEstimator在界面 ChannelConfig
    
    Specified by:
    
    setMessageSizeEstimator在界面 ServerSocketChannelConfig
    
    重写：
    
    setMessageSizeEstimator在课堂上 DefaultChannelConfig

Class DefaultServerSocketChannelConfig

Field Summary

Fields inherited from class io.netty.channel.DefaultChannelConfig

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.DefaultChannelConfig

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelConfig

字段详细信息

javaSocket

构造方法详细信息

DefaultServerSocketChannelConfig

方法详细信息

getOptions

getOption

setOption

isReuseAddress

setReuseAddress

getReceiveBufferSize

setReceiveBufferSize

setPerformancePreferences

getBacklog

setBacklog

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setWriteBufferWaterMark

setMessageSizeEstimator