KQueueServerChannelConfig (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.DefaultChannelConfig
- - io.netty.channel.kqueue.KQueueChannelConfig
  - - io.netty.channel.kqueue.KQueueServerChannelConfig

All Implemented Interfaces:: ChannelConfig ， ServerSocketChannelConfig

已知直接子类：: KQueueServerSocketChannelConfig

@UnstableApi
public class KQueueServerChannelConfig
extends KQueueChannelConfig
implements ServerSocketChannelConfig

Field Summary

Fields
Modifier and Type	Field and Description
`protected io.netty.channel.kqueue.AbstractKQueueChannel`	`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`选项。
`boolean`	`isReuseAddress()` 获取 `StandardSocketOptions.SO_REUSEADDR`选项。
`KQueueServerChannelConfig`	`setAllocator(ByteBufAllocator allocator)` 设置用于通道分配缓冲区的`ByteBufAllocator` 。
`KQueueServerChannelConfig`	`setAutoRead(boolean autoRead)` 设置是否自动调用 `ChannelHandlerContext.read()`，以便用户应用程序根本不需要调用它。
`KQueueServerChannelConfig`	`setBacklog(int backlog)` 设置积压值以指定通道绑定到本地地址的时间。
`KQueueServerChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` 以毫秒为单位设置通道的连接超时。
`KQueueServerChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`KQueueServerChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` 设置用于通道的`MessageSizeEstimator`以检测消息的大小。
`<T> boolean`	`setOption(ChannelOption<T> option, T value)` 使用指定的名称和值设置配置属性。
`KQueueServerChannelConfig`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` 设置 `ServerSocket.setPerformancePreferences(int, int, int)`指定的性能首选项。
`KQueueServerChannelConfig`	`setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)` 如果这是 `true`那么 `RecvByteBufAllocator.Handle#guess()`将被覆盖，以总是尝试读取kqueue所说的可用字节数。
`KQueueServerChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)` 获取 `StandardSocketOptions.SO_SNDBUF`选项。
`KQueueServerChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` 设置用于通道分配接收缓冲区的`RecvByteBufAllocator` 。
`KQueueServerChannelConfig`	`setReuseAddress(boolean reuseAddress)` 设置 `StandardSocketOptions.SO_REUSEADDR`选项。
`KQueueServerChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` 已过时。
`KQueueServerChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` 已过时。
`KQueueServerChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` 设置用于设置写入缓冲区的高位和低位水印的`WriteBufferWaterMark` 。
`KQueueServerChannelConfig`	`setWriteSpinCount(int writeSpinCount)` 设置写操作的最大循环计数，直到 `WritableByteChannel.write(ByteBuffer)`返回非零值。

Methods inherited from class io.netty.channel.kqueue.KQueueChannelConfig
autoReadCleared, getRcvAllocTransportProvidesGuess

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

Class KQueueServerChannelConfig

Field Summary

方法摘要

Methods inherited from class io.netty.channel.kqueue.KQueueChannelConfig

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

setRcvAllocTransportProvidesGuess

setPerformancePreferences

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setWriteBufferWaterMark

setMessageSizeEstimator