DefaultChannelConfig (Netty 4.1.109.Final API文档

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

所有已实现的接口:

ChannelConfig

直接已知子类:

DefaultDatagramChannelConfig, DefaultSctpChannelConfig, DefaultSctpServerChannelConfig, DefaultServerSocketChannelConfig, DefaultSocketChannelConfig, DefaultUdtChannelConfig, EpollChannelConfig, KQueueChannelConfig
```
public class DefaultChannelConfig
extends java.lang.Object
implements ChannelConfig
```
The default ChannelConfig implementation.

字段概要

字段
限定符和类型字段和说明

protected Channel channel

字段
限定符和类型	字段和说明
`protected Channel`	`channel`

构造器概要

构造器
限定符构造器和说明

DefaultChannelConfig(Channel channel)

protected DefaultChannelConfig(Channel channel, RecvByteBufAllocator allocator)

构造器
限定符	构造器和说明
	`DefaultChannelConfig(Channel channel)`
`protected`	`DefaultChannelConfig(Channel channel, RecvByteBufAllocator allocator)`

方法概要

All Methods Instance Methods Concrete Methods Deprecated Methods
限定符和类型	方法和说明
`protected void`	`autoReadCleared()` Is called once `setAutoRead(boolean)` is called with `false` and `isAutoRead()` was `true` before.
`ByteBufAllocator`	`getAllocator()` Returns `ByteBufAllocator` which is used for the channel to allocate buffers.
`int`	`getConnectTimeoutMillis()` Returns the connect timeout of the channel in milliseconds.
`int`	`getMaxMessagesPerRead()` 已过时。
`int`	`getMaxMessagesPerWrite()` Get the maximum number of message to write per eventloop run.
`MessageSizeEstimator`	`getMessageSizeEstimator()` Returns `MessageSizeEstimator` which is used for the channel to detect the size of a message.
`<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.
`protected java.util.Map<ChannelOption<?>,java.lang.Object>`	`getOptions(java.util.Map<ChannelOption<?>,java.lang.Object> result, ChannelOption<?>... options)`
`<T extends RecvByteBufAllocator> T`	`getRecvByteBufAllocator()` Returns `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.
`int`	`getWriteBufferHighWaterMark()` Returns the high water mark of the write buffer.
`int`	`getWriteBufferLowWaterMark()` Returns the low water mark of the write buffer.
`WriteBufferWaterMark`	`getWriteBufferWaterMark()` Returns the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.
`int`	`getWriteSpinCount()` Returns the maximum loop count for a write operation until `WritableByteChannel.write(ByteBuffer)` returns a non-zero value.
`boolean`	`isAutoClose()` Returns `true` if and only if the `Channel` will be closed automatically and immediately on write failure.
`boolean`	`isAutoRead()` Returns `true` if and only if `ChannelHandlerContext.read()` will be invoked automatically so that a user application doesn't need to call it at all.
`ChannelConfig`	`setAllocator(ByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
`ChannelConfig`	`setAutoClose(boolean autoClose)` Sets whether the `Channel` should be closed automatically and immediately on write failure.
`ChannelConfig`	`setAutoRead(boolean autoRead)` Sets if `ChannelHandlerContext.read()` will be invoked automatically so that a user application doesn't need to call it at all.
`ChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`ChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`ChannelConfig`	`setMaxMessagesPerWrite(int maxMessagesPerWrite)` Set the maximum number of message to write per eventloop run.
`ChannelConfig`	`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.
`boolean`	`setOptions(java.util.Map<ChannelOption<?>,?> options)` Sets the configuration properties from the specified `Map`.
`ChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` Set the `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.
`ChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` Sets the high water mark of the write buffer.
`ChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` Sets the low water mark of the write buffer.
`ChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` Set the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.
`ChannelConfig`	`setWriteSpinCount(int writeSpinCount)` Sets the maximum loop count for a write operation until `WritableByteChannel.write(ByteBuffer)` returns a non-zero value.
`protected <T> void`	`validate(ChannelOption<T> option, T value)`

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

- 字段详细资料
  - channel
```
protected final Channel channel
```
- 构造器详细资料
  - DefaultChannelConfig
```
public DefaultChannelConfig(Channel channel)
```
  - DefaultChannelConfig
```
protected DefaultChannelConfig(Channel channel,
                               RecvByteBufAllocator allocator)
```
- 方法详细资料
  - getOptions
```
public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
```
    从接口复制的说明: ChannelConfig
    
    Return all set ChannelOption's.
    
    指定者:
    
    getOptions 在接口中 ChannelConfig
  - getOptions
```
protected java.util.Map<ChannelOption<?>,java.lang.Object> getOptions(java.util.Map<ChannelOption<?>,java.lang.Object> result,
                                                                      ChannelOption<?>... options)
```
  - setOptions
```
public boolean setOptions(java.util.Map<ChannelOption<?>,?> options)
```
    从接口复制的说明: ChannelConfig
    
    Sets the configuration properties from the specified Map.
    
    指定者:
    
    setOptions 在接口中 ChannelConfig
  - getOption
```
public <T> T getOption(ChannelOption<T> option)
```
    从接口复制的说明: ChannelConfig
    
    Return the value of the given ChannelOption
    
    指定者:
    
    getOption 在接口中 ChannelConfig
  - 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
    
    返回:
    
    true if and only if the property has been set
  - validate
```
protected <T> void validate(ChannelOption<T> option,
                            T value)
```
  - getConnectTimeoutMillis
```
public int getConnectTimeoutMillis()
```
    从接口复制的说明: ChannelConfig
    
    Returns 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.
    
    指定者:
    
    getConnectTimeoutMillis 在接口中 ChannelConfig
    
    返回:
    
    the connect timeout in milliseconds. 0 if disabled.
  - setConnectTimeoutMillis
```
public ChannelConfig 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
    
    参数:
    
    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.
  - getMaxMessagesPerRead
```
@Deprecated
public int getMaxMessagesPerRead()
```
    已过时。
    
    指定者:
    
    getMaxMessagesPerRead 在接口中 ChannelConfig
    
    抛出:
    
    java.lang.IllegalStateException - if getRecvByteBufAllocator() does not return an object of type MaxMessagesRecvByteBufAllocator.
  - setMaxMessagesPerRead
```
@Deprecated
public ChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 ChannelConfig
    
    抛出:
    
    java.lang.IllegalStateException - if getRecvByteBufAllocator() does not return an object of type MaxMessagesRecvByteBufAllocator.
  - getMaxMessagesPerWrite
```
public int getMaxMessagesPerWrite()
```
    Get the maximum number of message to write per eventloop run. Once this limit is reached we will continue to process other events before trying to write the remaining messages.
  - setMaxMessagesPerWrite
```
public ChannelConfig setMaxMessagesPerWrite(int maxMessagesPerWrite)
```
    Set the maximum number of message to write per eventloop run. Once this limit is reached we will continue to process other events before trying to write the remaining messages.
  - getWriteSpinCount
```
public int getWriteSpinCount()
```
    从接口复制的说明: ChannelConfig
    
    Returns 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.
    
    指定者:
    
    getWriteSpinCount 在接口中 ChannelConfig
  - setWriteSpinCount
```
public ChannelConfig 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
  - getAllocator
```
public ByteBufAllocator getAllocator()
```
    从接口复制的说明: ChannelConfig
    
    Returns ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    getAllocator 在接口中 ChannelConfig
  - setAllocator
```
public ChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    setAllocator 在接口中 ChannelConfig
  - getRecvByteBufAllocator
```
public <T extends RecvByteBufAllocator> T getRecvByteBufAllocator()
```
    从接口复制的说明: ChannelConfig
    
    Returns RecvByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    getRecvByteBufAllocator 在接口中 ChannelConfig
  - setRecvByteBufAllocator
```
public ChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ChannelConfig
  - isAutoRead
```
public boolean isAutoRead()
```
    从接口复制的说明: ChannelConfig
    
    Returns true if and only 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.
    
    指定者:
    
    isAutoRead 在接口中 ChannelConfig
  - setAutoRead
```
public ChannelConfig 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
  - autoReadCleared
```
protected void autoReadCleared()
```
    Is called once setAutoRead(boolean) is called with false and isAutoRead() was true before.
  - isAutoClose
```
public boolean isAutoClose()
```
    从接口复制的说明: ChannelConfig
    
    Returns true if and only if the Channel will be closed automatically and immediately on write failure. The default is true.
    
    指定者:
    
    isAutoClose 在接口中 ChannelConfig
  - setAutoClose
```
public ChannelConfig setAutoClose(boolean autoClose)
```
    从接口复制的说明: ChannelConfig
    
    Sets whether the Channel should be closed automatically and immediately on write failure. The default is true.
    
    指定者:
    
    setAutoClose 在接口中 ChannelConfig
  - getWriteBufferHighWaterMark
```
public int getWriteBufferHighWaterMark()
```
    从接口复制的说明: ChannelConfig
    
    Returns 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.
    
    指定者:
    
    getWriteBufferHighWaterMark 在接口中 ChannelConfig
  - setWriteBufferHighWaterMark
```
public ChannelConfig 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
  - getWriteBufferLowWaterMark
```
public int getWriteBufferLowWaterMark()
```
    从接口复制的说明: ChannelConfig
    
    Returns 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.
    
    指定者:
    
    getWriteBufferLowWaterMark 在接口中 ChannelConfig
  - setWriteBufferLowWaterMark
```
public ChannelConfig 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
  - setWriteBufferWaterMark
```
public ChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    从接口复制的说明: ChannelConfig
    
    Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
    
    指定者:
    
    setWriteBufferWaterMark 在接口中 ChannelConfig
  - getWriteBufferWaterMark
```
public WriteBufferWaterMark getWriteBufferWaterMark()
```
    从接口复制的说明: ChannelConfig
    
    Returns the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
    
    指定者:
    
    getWriteBufferWaterMark 在接口中 ChannelConfig
  - getMessageSizeEstimator
```
public MessageSizeEstimator getMessageSizeEstimator()
```
    从接口复制的说明: ChannelConfig
    
    Returns MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    指定者:
    
    getMessageSizeEstimator 在接口中 ChannelConfig
  - setMessageSizeEstimator
```
public ChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口复制的说明: ChannelConfig
    
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ChannelConfig

类 DefaultChannelConfig

字段概要

构造器概要

方法概要

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

字段详细资料

channel

构造器详细资料

DefaultChannelConfig

DefaultChannelConfig

方法详细资料

getOptions

getOptions

setOptions

getOption

setOption

validate

getConnectTimeoutMillis

setConnectTimeoutMillis

getMaxMessagesPerRead

setMaxMessagesPerRead

getMaxMessagesPerWrite

setMaxMessagesPerWrite

getWriteSpinCount

setWriteSpinCount

getAllocator

setAllocator

getRecvByteBufAllocator

setRecvByteBufAllocator

isAutoRead

setAutoRead

autoReadCleared

isAutoClose

setAutoClose

getWriteBufferHighWaterMark

setWriteBufferHighWaterMark

getWriteBufferLowWaterMark

setWriteBufferLowWaterMark

setWriteBufferWaterMark

getWriteBufferWaterMark

getMessageSizeEstimator

setMessageSizeEstimator