KQueueChannelConfig (Netty 4.1.109.Final API文档

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

所有已实现的接口:

ChannelConfig

直接已知子类:

KQueueDatagramChannelConfig, KQueueDomainDatagramChannelConfig, KQueueDomainSocketChannelConfig, KQueueServerChannelConfig, KQueueSocketChannelConfig
```
@UnstableApi
public class KQueueChannelConfig
extends DefaultChannelConfig
```

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

方法概要

All Methods Instance Methods Concrete Methods Deprecated Methods
限定符和类型	方法和说明
`protected void`	`autoReadCleared()` Is called once `DefaultChannelConfig.setAutoRead(boolean)` is called with `false` and `DefaultChannelConfig.isAutoRead()` was `true` before.
`<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.
`boolean`	`getRcvAllocTransportProvidesGuess()` If this is `true` then the `RecvByteBufAllocator.Handle#guess()` will be overridden to always attempt to read as many bytes as kqueue says are available.
`KQueueChannelConfig`	`setAllocator(ByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
`KQueueChannelConfig`	`setAutoRead(boolean autoRead)` Sets if `ChannelHandlerContext.read()` will be invoked automatically so that a user application doesn't need to call it at all.
`KQueueChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`KQueueChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`KQueueChannelConfig`	`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.
`KQueueChannelConfig`	`setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)` If this is `true` then the `RecvByteBufAllocator.Handle#guess()` will be overridden to always attempt to read as many bytes as kqueue says are available.
`KQueueChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` Set the `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.
`KQueueChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` 已过时。
`KQueueChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` 已过时。
`KQueueChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` Set the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.
`KQueueChannelConfig`	`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
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setMaxMessagesPerWrite, setOptions, validate

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - 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
  - setRcvAllocTransportProvidesGuess
```
public KQueueChannelConfig setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)
```
    If this is true then the RecvByteBufAllocator.Handle#guess() will be overridden to always attempt to read as many bytes as kqueue says are available.
  - getRcvAllocTransportProvidesGuess
```
public boolean getRcvAllocTransportProvidesGuess()
```
    If this is true then the RecvByteBufAllocator.Handle#guess() will be overridden to always attempt to read as many bytes as kqueue says are available.
  - setConnectTimeoutMillis
```
public KQueueChannelConfig 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 在类中 DefaultChannelConfig
    
    参数:
    
    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.
  - setMaxMessagesPerRead
```
@Deprecated
public KQueueChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    从类复制的说明: DefaultChannelConfig
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 ChannelConfig
    
    覆盖:
    
    setMaxMessagesPerRead 在类中 DefaultChannelConfig
  - setWriteSpinCount
```
public KQueueChannelConfig 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 在类中 DefaultChannelConfig
  - setAllocator
```
public KQueueChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    setAllocator 在接口中 ChannelConfig
    
    覆盖:
    
    setAllocator 在类中 DefaultChannelConfig
  - setRecvByteBufAllocator
```
public KQueueChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ChannelConfig
    
    覆盖:
    
    setRecvByteBufAllocator 在类中 DefaultChannelConfig
  - setAutoRead
```
public KQueueChannelConfig 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 在类中 DefaultChannelConfig
  - setWriteBufferHighWaterMark
```
@Deprecated
public KQueueChannelConfig 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
```
@Deprecated
public KQueueChannelConfig 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
  - setWriteBufferWaterMark
```
public KQueueChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    从接口复制的说明: ChannelConfig
    
    Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
    
    指定者:
    
    setWriteBufferWaterMark 在接口中 ChannelConfig
    
    覆盖:
    
    setWriteBufferWaterMark 在类中 DefaultChannelConfig
  - setMessageSizeEstimator
```
public KQueueChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口复制的说明: ChannelConfig
    
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ChannelConfig
    
    覆盖:
    
    setMessageSizeEstimator 在类中 DefaultChannelConfig
  - autoReadCleared
```
protected final void autoReadCleared()
```
    从类复制的说明: DefaultChannelConfig
    
    Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.
    
    覆盖:
    
    autoReadCleared 在类中 DefaultChannelConfig

类 KQueueChannelConfig

字段概要

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

方法概要

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

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

方法详细资料

getOptions

getOption

setOption

setRcvAllocTransportProvidesGuess

getRcvAllocTransportProvidesGuess

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setWriteBufferWaterMark

setMessageSizeEstimator

autoReadCleared