EpollServerChannelConfig (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.DefaultChannelConfig
- - io.netty.channel.epoll.EpollChannelConfig
  - - io.netty.channel.epoll.EpollServerChannelConfig

All Implemented Interfaces:

ChannelConfig ， ServerSocketChannelConfig

已知直接子类：

EpollServerSocketChannelConfig
```
public class EpollServerChannelConfig
extends EpollChannelConfig
implements ServerSocketChannelConfig
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected io.netty.channel.epoll.AbstractEpollChannel`	`channel`

方法摘要

所有方法接口方法具体的方法弃用的方法
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`选项。
`int`	`getTcpFastopen()` 返回快速打开连接的暂挂数量阈值。
`boolean`	`isReuseAddress()` 获取 `StandardSocketOptions.SO_REUSEADDR`选项。
`EpollServerChannelConfig`	`setAllocator(ByteBufAllocator allocator)` 设置用于通道分配缓冲区的`ByteBufAllocator` 。
`EpollServerChannelConfig`	`setAutoRead(boolean autoRead)` 设置是否自动调用 `ChannelHandlerContext.read()`，以便用户应用程序根本不需要调用它。
`EpollServerChannelConfig`	`setBacklog(int backlog)` 设置积压值以指定通道绑定到本地地址的时间。
`EpollServerChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` 以毫秒为单位设置通道的连接超时。
`EpollServerChannelConfig`	`setEpollMode(EpollMode mode)` 设置使用的`EpollMode` 。
`EpollServerChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`EpollServerChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` 设置用于通道的`MessageSizeEstimator`以检测消息的大小。
`<T> boolean`	`setOption(ChannelOption<T> option, T value)` 使用指定的名称和值设置配置属性。
`EpollServerChannelConfig`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` 设置 `ServerSocket.setPerformancePreferences(int, int, int)`指定的性能首选项。
`EpollServerChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)` 获取 `StandardSocketOptions.SO_SNDBUF`选项。
`EpollServerChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` 设置用于通道分配接收缓冲区的`RecvByteBufAllocator` 。
`EpollServerChannelConfig`	`setReuseAddress(boolean reuseAddress)` 设置 `StandardSocketOptions.SO_REUSEADDR`选项。
`EpollServerChannelConfig`	`setTcpFastopen(int pendingFastOpenRequestsThreshold)` 在服务器通道上启用tcpFastOpen。
`EpollServerChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` 已过时。
`EpollServerChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` 已过时。
`EpollServerChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` 设置`WriteBufferWaterMark`用于设置写入缓冲区的高位和低位。
`EpollServerChannelConfig`	`setWriteSpinCount(int writeSpinCount)` 设置写入操作的最大循环计数，直到 `WritableByteChannel.write(ByteBuffer)`返回非零值。

Methods inherited from class io.netty.channel.epoll.EpollChannelConfig
autoReadCleared, getEpollMode

Methods inherited from class io.netty.channel.DefaultChannelConfig
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

- 字段详细信息
  - channel
```
protected final io.netty.channel.epoll.AbstractEpollChannel channel
```
- 方法详细信息
  - getOptions
```
public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
```
    从接口复制的描述： ChannelConfig
    
    返回所有设置ChannelOption的。
    
    Specified by:
    
    getOptions ，界面 ChannelConfig
    
    重写：
    
    getOptions在课堂 EpollChannelConfig
  - getOption
```
public <T> T getOption(ChannelOption<T> option)
```
    从接口复制的描述： ChannelConfig
    
    返回给定ChannelOption的值
    
    Specified by:
    
    getOption在界面 ChannelConfig
    
    重写：
    
    getOption在课堂上 EpollChannelConfig
  - 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在课堂 EpollChannelConfig
    
    结果
    
    true当且仅当该属性已设置
  - isReuseAddress
```
public boolean isReuseAddress()
```
    从接口复制的描述： ServerSocketChannelConfig
    
    获取 StandardSocketOptions.SO_REUSEADDR选项。
    
    Specified by:
    
    isReuseAddress ，界面 ServerSocketChannelConfig
  - setReuseAddress
```
public EpollServerChannelConfig 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 EpollServerChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    从接口复制的描述： ServerSocketChannelConfig
    
    获取 StandardSocketOptions.SO_SNDBUF选项。
    
    Specified by:
    
    setReceiveBufferSize ，界面 ServerSocketChannelConfig
  - getBacklog
```
public int getBacklog()
```
    从接口复制的描述： ServerSocketChannelConfig
    
    获取积压值以指定通道绑定到本地地址的时间。
    
    Specified by:
    
    getBacklog在界面 ServerSocketChannelConfig
  - setBacklog
```
public EpollServerChannelConfig setBacklog(int backlog)
```
    从接口复制的描述： ServerSocketChannelConfig
    
    设置积压值以指定通道绑定到本地地址的时间。
    
    Specified by:
    
    setBacklog ，界面 ServerSocketChannelConfig
  - getTcpFastopen
```
public int getTcpFastopen()
```
    返回快速打开连接的暂挂数量阈值。
    
    另请参见：
    
    RFC 7413 Passive Open
  - setTcpFastopen
```
public EpollServerChannelConfig setTcpFastopen(int pendingFastOpenRequestsThreshold)
```
    在服务器通道上启用tcpFastOpen。如果底层操作系统不支持TCP_FASTOPEN设置，则不起作用。在进行套接字监听之前，必须先设置该参数，否则这将不起作用。
    
    参数
    
    pendingFastOpenRequestsThreshold - 在特定时间点为了安全而快速打开的请求数量。 @see RFC 7413 Passive Open
    
    另请参见：
    
    RFC 7413 TCP FastOpen
  - setPerformancePreferences
```
public EpollServerChannelConfig setPerformancePreferences(int connectionTime,
                                                          int latency,
                                                          int bandwidth)
```
    从接口复制的描述： ServerSocketChannelConfig
    
    设置 ServerSocket.setPerformancePreferences(int, int, int)指定的性能首选项。
    
    Specified by:
    
    setPerformancePreferences在界面 ServerSocketChannelConfig
  - setConnectTimeoutMillis
```
public EpollServerChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    从接口复制的描述： ChannelConfig
    
    以毫秒为单位设置通道的连接超时。如果Channel不支持连接操作，则完全不使用此属性，因此将被忽略。
    
    Specified by:
    
    setConnectTimeoutMillis在界面 ChannelConfig
    
    Specified by:
    
    setConnectTimeoutMillis ，界面 ServerSocketChannelConfig
    
    重写：
    
    setConnectTimeoutMillis在课堂 EpollChannelConfig
    
    参数
    
    connectTimeoutMillis - 以毫秒为单位的连接超时。 0禁用。
  - setMaxMessagesPerRead
```
@Deprecated
public EpollServerChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    从类复制的描述： DefaultChannelConfig
    
    Specified by:
    
    setMaxMessagesPerRead ，界面 ChannelConfig
    
    Specified by:
    
    setMaxMessagesPerRead ，界面 ServerSocketChannelConfig
    
    重写：
    
    setMaxMessagesPerRead在课堂上 EpollChannelConfig
  - setWriteSpinCount
```
public EpollServerChannelConfig setWriteSpinCount(int writeSpinCount)
```
    从接口复制的描述： ChannelConfig
    
    设置写入操作的最大循环数，直到WritableByteChannel.write(ByteBuffer)返回非零值。它类似于在并发编程中使用自旋锁。它可以提高内存利用率并根据运行JVM的平台来编写吞吐量。默认值是16 。
    
    Specified by:
    
    setWriteSpinCount在界面 ChannelConfig
    
    Specified by:
    
    setWriteSpinCount在界面 ServerSocketChannelConfig
    
    重写：
    
    setWriteSpinCount在课堂上 EpollChannelConfig
  - setAllocator
```
public EpollServerChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从界面复制的描述： ChannelConfig
    
    设置用于通道分配缓冲区的ByteBufAllocator 。
    
    Specified by:
    
    setAllocator ，界面 ChannelConfig
    
    Specified by:
    
    setAllocator在界面 ServerSocketChannelConfig
    
    重写：
    
    setAllocator在课程 EpollChannelConfig
  - setRecvByteBufAllocator
```
public EpollServerChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口复制的描述： ChannelConfig
    
    设置用于通道分配接收缓冲区的RecvByteBufAllocator 。
    
    Specified by:
    
    setRecvByteBufAllocator ，界面 ChannelConfig
    
    Specified by:
    
    setRecvByteBufAllocator在界面 ServerSocketChannelConfig
    
    重写：
    
    setRecvByteBufAllocator在课程 EpollChannelConfig
  - setAutoRead
```
public EpollServerChannelConfig setAutoRead(boolean autoRead)
```
    从接口复制的描述： ChannelConfig
    
    设置是否自动调用ChannelHandlerContext.read()，以便用户应用程序根本不需要调用它。默认值是true 。
    
    Specified by:
    
    setAutoRead ，界面 ChannelConfig
    
    Specified by:
    
    setAutoRead在界面 ServerSocketChannelConfig
    
    重写：
    
    setAutoRead在课程 EpollChannelConfig
  - setWriteBufferHighWaterMark
```
@Deprecated
public EpollServerChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
```
    已过时。
    
    从界面复制而来的描述： ChannelConfig
    
    设置写入缓冲区的高位标记。如果写入缓冲区中排队的字节数超过此值，则Channel.isWritable()将开始返回false 。
    
    Specified by:
    
    setWriteBufferHighWaterMark在界面 ChannelConfig
    
    Specified by:
    
    setWriteBufferHighWaterMark在界面 ServerSocketChannelConfig
    
    重写：
    
    setWriteBufferHighWaterMark在课堂 EpollChannelConfig
  - setWriteBufferLowWaterMark
```
@Deprecated
public EpollServerChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
```
    已过时。
    
    从界面复制的描述： ChannelConfig
    
    设置写入缓冲区的低水位标志。一旦写入缓冲器中排队的字节数超过了high water mark ，然后下降到此值以下， Channel.isWritable()将再次开始返回true 。
    
    Specified by:
    
    setWriteBufferLowWaterMark ，界面 ChannelConfig
    
    Specified by:
    
    setWriteBufferLowWaterMark ，界面 ServerSocketChannelConfig
    
    重写：
    
    setWriteBufferLowWaterMark在课堂上 EpollChannelConfig
  - setWriteBufferWaterMark
```
public EpollServerChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    从接口复制的描述： ChannelConfig
    
    设置WriteBufferWaterMark用于设置写入缓冲区的高位和低位水印。
    
    Specified by:
    
    setWriteBufferWaterMark在界面 ChannelConfig
    
    Specified by:
    
    setWriteBufferWaterMark在界面 ServerSocketChannelConfig
    
    重写：
    
    setWriteBufferWaterMark在课堂上 EpollChannelConfig
  - setMessageSizeEstimator
```
public EpollServerChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口复制的描述： ChannelConfig
    
    设置用于通道的MessageSizeEstimator以检测消息的大小。
    
    Specified by:
    
    setMessageSizeEstimator ，界面 ChannelConfig
    
    Specified by:
    
    setMessageSizeEstimator在界面 ServerSocketChannelConfig
    
    重写：
    
    setMessageSizeEstimator在课堂上 EpollChannelConfig
  - setEpollMode
```
public EpollServerChannelConfig setEpollMode(EpollMode mode)
```
    从类复制的描述： EpollChannelConfig
    
    设置使用的EpollMode 。默认值是EpollMode.EDGE_TRIGGERED 。如果您想要使用DefaultChannelConfig.isAutoRead() false或DefaultChannelConfig.getMaxMessagesPerRead()，并且具有准确的行为，则应使用EpollMode.LEVEL_TRIGGERED 。 请注意，只有在频道注册之前，才能调整此配置设置。
    
    重写：
    
    setEpollMode in class EpollChannelConfig

Class EpollServerChannelConfig

Field Summary

方法摘要

Methods inherited from class io.netty.channel.epoll.EpollChannelConfig

Methods inherited from class io.netty.channel.DefaultChannelConfig

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelConfig

字段详细信息

channel

方法详细信息

getOptions

getOption

setOption

isReuseAddress

setReuseAddress

getReceiveBufferSize

setReceiveBufferSize

getBacklog

setBacklog

getTcpFastopen

setTcpFastopen

setPerformancePreferences

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setWriteBufferWaterMark

setMessageSizeEstimator

setEpollMode