EpollChannelConfig (Netty 4.0.56.Final API文档

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

所有已实现的接口:

ChannelConfig

直接已知子类:

EpollDatagramChannelConfig, EpollDomainSocketChannelConfig, EpollServerChannelConfig, EpollSocketChannelConfig
```
public class EpollChannelConfig
extends DefaultChannelConfig
```

方法概要

方法
限定符和类型	方法和说明
`protected void`	`autoReadCleared()` Is called once `DefaultChannelConfig.setAutoRead(boolean)` is called with `false` and `DefaultChannelConfig.isAutoRead()` was `true` before.
`EpollMode`	`getEpollMode()` Return the `EpollMode` used.
`<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.
`EpollChannelConfig`	`setAllocator(ByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
`EpollChannelConfig`	`setAutoRead(boolean autoRead)` Sets if `ChannelHandlerContext.read()` will be invoked automatically so that a user application doesn't need to call it at all.
`EpollChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`EpollChannelConfig`	`setEpollMode(EpollMode mode)` Set the `EpollMode` used.
`EpollChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` Sets the maximum number of messages to read per read loop.
`EpollChannelConfig`	`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.
`EpollChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate receive buffers.
`EpollChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` Sets the high water mark of the write buffer.
`EpollChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` Sets the low water mark of the write buffer.
`EpollChannelConfig`	`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, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, 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
  - setConnectTimeoutMillis
```
public EpollChannelConfig 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
```
public EpollChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    从接口复制的说明: ChannelConfig
    
    Sets the maximum number of messages to read per read loop. If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 ChannelConfig
    
    覆盖:
    
    setMaxMessagesPerRead 在类中 DefaultChannelConfig
  - setWriteSpinCount
```
public EpollChannelConfig 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 EpollChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    setAllocator 在接口中 ChannelConfig
    
    覆盖:
    
    setAllocator 在类中 DefaultChannelConfig
  - setRecvByteBufAllocator
```
public EpollChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ChannelConfig
    
    覆盖:
    
    setRecvByteBufAllocator 在类中 DefaultChannelConfig
  - setAutoRead
```
public EpollChannelConfig 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
```
public EpollChannelConfig 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
```
public EpollChannelConfig 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
  - setMessageSizeEstimator
```
public EpollChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口复制的说明: ChannelConfig
    
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ChannelConfig
    
    覆盖:
    
    setMessageSizeEstimator 在类中 DefaultChannelConfig
  - getEpollMode
```
public EpollMode getEpollMode()
```
    Return the EpollMode used. Default is EpollMode.EDGE_TRIGGERED. If you want to use DefaultChannelConfig.isAutoRead() false or DefaultChannelConfig.getMaxMessagesPerRead() and have an accurate behaviour you should use EpollMode.LEVEL_TRIGGERED.
  - setEpollMode
```
public EpollChannelConfig setEpollMode(EpollMode mode)
```
    Set the EpollMode used. Default is EpollMode.EDGE_TRIGGERED. If you want to use DefaultChannelConfig.isAutoRead() false or DefaultChannelConfig.getMaxMessagesPerRead() and have an accurate behaviour you should use EpollMode.LEVEL_TRIGGERED. Be aware this config setting can only be adjusted before the channel was registered.
  - autoReadCleared
```
protected final void autoReadCleared()
```
    从类复制的说明: DefaultChannelConfig
    
    Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.
    
    覆盖:
    
    autoReadCleared 在类中 DefaultChannelConfig

类 EpollChannelConfig

方法概要

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

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

方法详细资料

getOptions

getOption

setOption

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setMessageSizeEstimator

getEpollMode

setEpollMode

autoReadCleared