KQueueDomainSocketChannelConfig (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:: ChannelConfig ， DomainSocketChannelConfig

@UnstableApi
public final class KQueueDomainSocketChannelConfig
extends KQueueChannelConfig
implements DomainSocketChannelConfig

方法摘要

所有方法接口方法具体的方法弃用的方法
Modifier and Type	Method and Description
`<T> T`	`getOption(ChannelOption<T> option)` 返回给定的`ChannelOption`的值
`java.util.Map<ChannelOption<?>,java.lang.Object>`	`getOptions()` 返回所有设置`ChannelOption`的。
`DomainSocketReadMode`	`getReadMode()` 返回频道的`DomainSocketReadMode` 。
`KQueueDomainSocketChannelConfig`	`setAllocator(ByteBufAllocator allocator)` 设置用于通道分配缓冲区的`ByteBufAllocator` 。
`KQueueDomainSocketChannelConfig`	`setAutoClose(boolean autoClose)`
`KQueueDomainSocketChannelConfig`	`setAutoRead(boolean autoRead)` 设置是否自动调用 `ChannelHandlerContext.read()`，以便用户应用程序根本不需要调用它。
`KQueueDomainSocketChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` 以毫秒为单位设置通道的连接超时。
`KQueueDomainSocketChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`KQueueDomainSocketChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` 设置用于通道的`MessageSizeEstimator`以检测消息的大小。
`<T> boolean`	`setOption(ChannelOption<T> option, T value)` 使用指定的名称和值设置配置属性。
`KQueueDomainSocketChannelConfig`	`setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)` 如果这是 `true`那么 `RecvByteBufAllocator.Handle#guess()`将被覆盖，以总是尝试读取kqueue所说的可用字节数。
`KQueueDomainSocketChannelConfig`	`setReadMode(DomainSocketReadMode mode)` 更改频道的`DomainSocketReadMode` 。
`KQueueDomainSocketChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` 设置用于通道分配接收缓冲区的`RecvByteBufAllocator` 。
`KQueueDomainSocketChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` 已过时。
`KQueueDomainSocketChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` 已过时。
`KQueueDomainSocketChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` 设置`WriteBufferWaterMark` ，用于设置写缓冲区的高位和低位。
`KQueueDomainSocketChannelConfig`	`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, 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, setOptions

- 方法详细信息
  - 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当且仅当该属性已设置
  - setRcvAllocTransportProvidesGuess
```
public KQueueDomainSocketChannelConfig setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)
```
    从类复制的描述： KQueueChannelConfig
    
    如果这是 true那么 RecvByteBufAllocator.Handle#guess()将被覆盖，以总是尝试读取kqueue所说的可用字节数。
    
    重写：
    
    setRcvAllocTransportProvidesGuess在课堂上 KQueueChannelConfig
  - setMaxMessagesPerRead
```
@Deprecated
public KQueueDomainSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    从类复制的描述： DefaultChannelConfig
    
    Specified by:
    
    setMaxMessagesPerRead在界面 ChannelConfig
    
    Specified by:
    
    setMaxMessagesPerRead在界面 DomainSocketChannelConfig
    
    重写：
    
    setMaxMessagesPerRead在课堂上 KQueueChannelConfig
  - setConnectTimeoutMillis
```
public KQueueDomainSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    从接口复制的描述： ChannelConfig
    
    以毫秒为单位设置通道的连接超时。如果Channel不支持连接操作，则完全不使用此属性，因此将被忽略。
    
    Specified by:
    
    setConnectTimeoutMillis ，界面 ChannelConfig
    
    Specified by:
    
    setConnectTimeoutMillis ，界面 DomainSocketChannelConfig
    
    重写：
    
    setConnectTimeoutMillis在课堂 KQueueChannelConfig
    
    参数
    
    connectTimeoutMillis - 以毫秒为单位的连接超时。 0禁用。
  - setWriteSpinCount
```
public KQueueDomainSocketChannelConfig setWriteSpinCount(int writeSpinCount)
```
    从接口ChannelConfig复制的描述
    
    设置写操作的最大循环计数，直到WritableByteChannel.write(ByteBuffer)返回非零值。它类似于在并发编程中使用自旋锁。它可以提高内存利用率并根据运行JVM的平台来编写吞吐量。默认值是16 。
    
    Specified by:
    
    setWriteSpinCount ，界面 ChannelConfig
    
    Specified by:
    
    setWriteSpinCount在界面 DomainSocketChannelConfig
    
    重写：
    
    setWriteSpinCount在课堂上 KQueueChannelConfig
  - setRecvByteBufAllocator
```
public KQueueDomainSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从界面复制的描述： ChannelConfig
    
    设置用于通道分配接收缓冲区的RecvByteBufAllocator 。
    
    Specified by:
    
    setRecvByteBufAllocator在界面 ChannelConfig
    
    Specified by:
    
    setRecvByteBufAllocator在界面 DomainSocketChannelConfig
    
    重写：
    
    setRecvByteBufAllocator在课堂上 KQueueChannelConfig
  - setAllocator
```
public KQueueDomainSocketChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口ChannelConfig复制的描述
    
    设置用于通道分配缓冲区的ByteBufAllocator 。
    
    Specified by:
    
    setAllocator在界面 ChannelConfig
    
    Specified by:
    
    setAllocator在界面 DomainSocketChannelConfig
    
    重写：
    
    setAllocator在课堂上 KQueueChannelConfig
  - setAutoClose
```
public KQueueDomainSocketChannelConfig setAutoClose(boolean autoClose)
```
    Specified by:
    
    setAutoClose ，界面 ChannelConfig
    
    Specified by:
    
    setAutoClose ，界面 DomainSocketChannelConfig
    
    重写：
    
    setAutoClose在类 DefaultChannelConfig
  - setMessageSizeEstimator
```
public KQueueDomainSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从界面复制的描述： ChannelConfig
    
    设置用于通道的MessageSizeEstimator以检测消息的大小。
    
    Specified by:
    
    setMessageSizeEstimator在界面 ChannelConfig
    
    Specified by:
    
    setMessageSizeEstimator在界面 DomainSocketChannelConfig
    
    重写：
    
    setMessageSizeEstimator在课堂上 KQueueChannelConfig
  - setWriteBufferLowWaterMark
```
@Deprecated
public KQueueDomainSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
```
    已过时。
    
    从接口复制的描述： ChannelConfig
    
    设置写入缓冲区的低水位标志。一旦写入缓冲区中排队的字节数超过了high water mark ，然后下降到此值以下， Channel.isWritable()将再次开始返回true 。
    
    Specified by:
    
    setWriteBufferLowWaterMark在界面 ChannelConfig
    
    Specified by:
    
    setWriteBufferLowWaterMark ，界面 DomainSocketChannelConfig
    
    重写：
    
    setWriteBufferLowWaterMark在课堂上 KQueueChannelConfig
  - setWriteBufferHighWaterMark
```
@Deprecated
public KQueueDomainSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
```
    已过时。
    
    从接口复制的描述： ChannelConfig
    
    设置写入缓冲区的高位标记。如果写缓冲区中排队的字节数超过此值，则Channel.isWritable()将开始返回false 。
    
    Specified by:
    
    setWriteBufferHighWaterMark在界面 ChannelConfig
    
    Specified by:
    
    setWriteBufferHighWaterMark在界面 DomainSocketChannelConfig
    
    重写：
    
    setWriteBufferHighWaterMark在课堂 KQueueChannelConfig
  - setWriteBufferWaterMark
```
public KQueueDomainSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    从界面复制的描述： ChannelConfig
    
    设置WriteBufferWaterMark ，用于设置写入缓冲区的高位和低位水印。
    
    Specified by:
    
    setWriteBufferWaterMark在界面 ChannelConfig
    
    Specified by:
    
    setWriteBufferWaterMark在界面 DomainSocketChannelConfig
    
    重写：
    
    setWriteBufferWaterMark在课堂上 KQueueChannelConfig
  - setAutoRead
```
public KQueueDomainSocketChannelConfig setAutoRead(boolean autoRead)
```
    从界面复制的描述： ChannelConfig
    
    设置是否自动调用ChannelHandlerContext.read()，以便用户应用程序根本不需要调用它。默认值是true 。
    
    Specified by:
    
    setAutoRead在界面 ChannelConfig
    
    Specified by:
    
    setAutoRead在界面 DomainSocketChannelConfig
    
    重写：
    
    setAutoRead在课堂上 KQueueChannelConfig
  - setReadMode
```
public KQueueDomainSocketChannelConfig setReadMode(DomainSocketReadMode mode)
```
    从接口复制的描述： DomainSocketChannelConfig
    
    更改频道的DomainSocketReadMode 。默认值是DomainSocketReadMode.BYTES ，这意味着字节将从Channel读取并通过管道传递。如果使用DomainSocketReadMode.FILE_DESCRIPTORS，则FileDescriptor将通过ChannelPipeline 。如果需要，可以即时修改此设置。
    
    Specified by:
    
    setReadMode ，界面 DomainSocketChannelConfig
  - getReadMode
```
public DomainSocketReadMode getReadMode()
```
    从界面复制的描述： DomainSocketChannelConfig
    
    返回频道的DomainSocketReadMode 。
    
    Specified by:
    
    getReadMode ，界面 DomainSocketChannelConfig

Class KQueueDomainSocketChannelConfig

方法摘要

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

方法详细信息

getOptions

getOption

setOption

setRcvAllocTransportProvidesGuess

setMaxMessagesPerRead

setConnectTimeoutMillis

setWriteSpinCount

setRecvByteBufAllocator

setAllocator

setAutoClose

setMessageSizeEstimator

setWriteBufferLowWaterMark

setWriteBufferHighWaterMark

setWriteBufferWaterMark

setAutoRead

setReadMode

getReadMode