DefaultChannelConfig (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

ChannelConfig

已知直接子类：

DefaultDatagramChannelConfig ， DefaultSctpChannelConfig ， DefaultSctpServerChannelConfig ， DefaultServerSocketChannelConfig ， DefaultSocketChannelConfig ， DefaultUdtChannelConfig ， EpollChannelConfig ， KQueueChannelConfig
```
public class DefaultChannelConfig
extends java.lang.Object
implements ChannelConfig
```
默认的ChannelConfig实现。

Field Summary

Fields
Modifier and Type	Field and Description
`protected Channel`	`channel`

构造方法摘要

构造方法
Modifier	Constructor and Description
	`DefaultChannelConfig(Channel channel)`
`protected`	`DefaultChannelConfig(Channel channel, RecvByteBufAllocator allocator)`

方法摘要

所有方法接口方法具体的方法弃用的方法
Modifier and Type	Method and Description
`protected void`	`autoReadCleared()` 一次调用 `setAutoRead(boolean)`与 `false`和 `isAutoRead()`调用 `true`之前。
`ByteBufAllocator`	`getAllocator()` 返回`ByteBufAllocator` ，用于通道分配缓冲区。
`int`	`getConnectTimeoutMillis()` 以毫秒为单位返回通道的连接超时。
`int`	`getMaxMessagesPerRead()` 已过时。
`MessageSizeEstimator`	`getMessageSizeEstimator()` 返回`MessageSizeEstimator` ，用于通道检测消息的大小。
`<T> T`	`getOption(ChannelOption<T> option)` 返回给定的`ChannelOption`的值
`java.util.Map<ChannelOption<?>,java.lang.Object>`	`getOptions()` 返回所有设置`ChannelOption`的。
`protected java.util.Map<ChannelOption<?>,java.lang.Object>`	`getOptions(java.util.Map<ChannelOption<?>,java.lang.Object> result, ChannelOption<?>... options)`
`<T extends RecvByteBufAllocator> T`	`getRecvByteBufAllocator()` 返回`RecvByteBufAllocator` ，用于通道分配接收缓冲区。
`int`	`getWriteBufferHighWaterMark()` 返回写入缓冲区的高位标记。
`int`	`getWriteBufferLowWaterMark()` 返回写缓冲区的低水位标志。
`WriteBufferWaterMark`	`getWriteBufferWaterMark()` 返回用于设置写入缓冲区的高位和低位水印的`WriteBufferWaterMark` 。
`int`	`getWriteSpinCount()` 返回写入操作的最大循环计数，直到 `WritableByteChannel.write(ByteBuffer)`返回非零值。
`boolean`	`isAutoClose()`
`boolean`	`isAutoRead()` 返回 `true`当且仅当 `ChannelHandlerContext.read()`将被自动调用，以便用户应用程序根本不需要调用它。
`ChannelConfig`	`setAllocator(ByteBufAllocator allocator)` 设置用于通道分配缓冲区的`ByteBufAllocator` 。
`ChannelConfig`	`setAutoClose(boolean autoClose)`
`ChannelConfig`	`setAutoRead(boolean autoRead)` 设置是否自动调用 `ChannelHandlerContext.read()`，以便用户应用程序根本不需要调用它。
`ChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` 以毫秒为单位设置通道的连接超时。
`ChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`ChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` 设置用于通道的`MessageSizeEstimator`以检测消息的大小。
`<T> boolean`	`setOption(ChannelOption<T> option, T value)` 使用指定的名称和值设置配置属性。
`boolean`	`setOptions(java.util.Map<ChannelOption<?>,?> options)` 从指定的 `Map`设置配置属性。
`ChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` 设置用于通道分配接收缓冲区的`RecvByteBufAllocator` 。
`ChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` 设置写入缓冲区的高位标记。
`ChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` 设置写入缓冲区的低水位标志。
`ChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` 设置用于设置写入缓冲区的高位和低位标记的`WriteBufferWaterMark` 。
`ChannelConfig`	`setWriteSpinCount(int writeSpinCount)` 设置写操作的最大循环数，直到 `WritableByteChannel.write(ByteBuffer)`返回非零值。
`protected <T> void`	`validate(ChannelOption<T> option, T value)`

Methods inherited from class 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复制的描述
    
    返回所有设置ChannelOption的。
    
    Specified by:
    
    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复制的描述
    
    从指定的 Map设置配置属性。
    
    Specified by:
    
    setOptions接口 ChannelConfig
  - getOption
```
public <T> T getOption(ChannelOption<T> option)
```
    从接口ChannelConfig复制的描述
    
    返回给定ChannelOption的值
    
    Specified by:
    
    getOption ，界面 ChannelConfig
  - 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
    
    结果
    
    true当且仅当该属性已设置
  - validate
```
protected <T> void validate(ChannelOption<T> option,
                            T value)
```
  - getConnectTimeoutMillis
```
public int getConnectTimeoutMillis()
```
    从接口ChannelConfig复制的描述
    
    以毫秒为单位返回通道的连接超时。如果Channel不支持连接操作，则根本不使用此属性，因此将被忽略。
    
    Specified by:
    
    getConnectTimeoutMillis接口 ChannelConfig
    
    结果
    
    以毫秒为单位的连接超时。 0如果禁用。
  - setConnectTimeoutMillis
```
public ChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    从接口ChannelConfig复制的描述
    
    以毫秒为单位设置通道的连接超时。如果Channel不支持连接操作，则完全不使用此属性，因此将被忽略。
    
    Specified by:
    
    setConnectTimeoutMillis ，界面 ChannelConfig
    
    参数
    
    connectTimeoutMillis - 以毫秒为单位的连接超时。 0禁用。
  - getMaxMessagesPerRead
```
@Deprecated
public int getMaxMessagesPerRead()
```
    已过时。
    
    Specified by:
    
    getMaxMessagesPerRead接口 ChannelConfig
    
    异常
    
    java.lang.IllegalStateException - 如果getRecvByteBufAllocator()不返回MaxMessagesRecvByteBufAllocator类型的对象。
  - setMaxMessagesPerRead
```
@Deprecated
public ChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    Specified by:
    
    setMaxMessagesPerRead接口 ChannelConfig
    
    异常
    
    java.lang.IllegalStateException - 如果getRecvByteBufAllocator()不返回MaxMessagesRecvByteBufAllocator类型的对象。
  - getWriteSpinCount
```
public int getWriteSpinCount()
```
    从接口ChannelConfig复制的描述
    
    返回写入操作的最大循环数，直到WritableByteChannel.write(ByteBuffer)返回非零值。它类似于在并发编程中使用自旋锁。它可以提高内存利用率并根据运行JVM的平台来编写吞吐量。默认值是16 。
    
    Specified by:
    
    getWriteSpinCount接口 ChannelConfig
  - setWriteSpinCount
```
public ChannelConfig setWriteSpinCount(int writeSpinCount)
```
    从接口ChannelConfig复制的描述
    
    设置写入操作的最大循环数，直到WritableByteChannel.write(ByteBuffer)返回非零值。它类似于在并发编程中使用自旋锁。它可以提高内存利用率并根据运行JVM的平台来编写吞吐量。默认值是16 。
    
    Specified by:
    
    setWriteSpinCount接口 ChannelConfig
  - getAllocator
```
public ByteBufAllocator getAllocator()
```
    从接口ChannelConfig复制的描述
    
    返回ByteBufAllocator ，用于通道分配缓冲区。
    
    Specified by:
    
    getAllocator接口 ChannelConfig
  - setAllocator
```
public ChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口ChannelConfig复制的描述
    
    设置用于通道分配缓冲区的ByteBufAllocator 。
    
    Specified by:
    
    setAllocator接口 ChannelConfig
  - getRecvByteBufAllocator
```
public <T extends RecvByteBufAllocator> T getRecvByteBufAllocator()
```
    从接口ChannelConfig复制的描述
    
    返回RecvByteBufAllocator ，用于通道分配接收缓冲区。
    
    Specified by:
    
    getRecvByteBufAllocator接口 ChannelConfig
  - setRecvByteBufAllocator
```
public ChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口ChannelConfig复制的描述
    
    设置用于通道分配接收缓冲区的RecvByteBufAllocator 。
    
    Specified by:
    
    setRecvByteBufAllocator接口 ChannelConfig
  - isAutoRead
```
public boolean isAutoRead()
```
    从接口ChannelConfig复制的描述
    
    返回true当且仅当ChannelHandlerContext.read()将被自动调用，以便用户应用程序根本不需要调用它。默认值是true 。
    
    Specified by:
    
    isAutoRead接口 ChannelConfig
  - setAutoRead
```
public ChannelConfig setAutoRead(boolean autoRead)
```
    从接口ChannelConfig复制的描述
    
    设置是否自动调用ChannelHandlerContext.read()，以便用户应用程序根本不需要调用它。默认值是true 。
    
    Specified by:
    
    setAutoRead接口 ChannelConfig
  - autoReadCleared
```
protected void autoReadCleared()
```
    曾经被称为 setAutoRead(boolean)被称为与 false和 isAutoRead()为 true之前。
  - isAutoClose
```
public boolean isAutoClose()
```
    Specified by:
    
    isAutoClose ，界面 ChannelConfig
  - setAutoClose
```
public ChannelConfig setAutoClose(boolean autoClose)
```
    Specified by:
    
    setAutoClose接口 ChannelConfig
  - getWriteBufferHighWaterMark
```
public int getWriteBufferHighWaterMark()
```
    从接口ChannelConfig复制的描述
    
    返回写入缓冲区的高位标记。如果写缓冲区中排队的字节数超过此值，则Channel.isWritable()将开始返回false 。
    
    Specified by:
    
    getWriteBufferHighWaterMark接口 ChannelConfig
  - setWriteBufferHighWaterMark
```
public ChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
```
    从接口ChannelConfig复制的描述
    
    设置写入缓冲区的高位标记。如果写入缓冲区中排队的字节数超过此值，则Channel.isWritable()将开始返回false 。
    
    Specified by:
    
    setWriteBufferHighWaterMark接口 ChannelConfig
  - getWriteBufferLowWaterMark
```
public int getWriteBufferLowWaterMark()
```
    从接口ChannelConfig复制的描述
    
    返回写缓冲区的低水位标志。一旦写入缓冲区中排队的字节数超过了high water mark ，然后下降到此值以下， Channel.isWritable()将再次开始返回true 。
    
    Specified by:
    
    getWriteBufferLowWaterMark ，界面 ChannelConfig
  - setWriteBufferLowWaterMark
```
public ChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
```
    从接口ChannelConfig复制的描述
    
    设置写入缓冲区的低水位标志。一旦写入缓冲器中排队的字节数超过了high water mark ，然后下降到此值以下， Channel.isWritable()将再次开始返回true 。
    
    Specified by:
    
    setWriteBufferLowWaterMark接口 ChannelConfig
  - setWriteBufferWaterMark
```
public ChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    从接口ChannelConfig复制的描述
    
    设置用于设置写入缓冲区的高位和低位标记的WriteBufferWaterMark 。
    
    Specified by:
    
    setWriteBufferWaterMark接口 ChannelConfig
  - getWriteBufferWaterMark
```
public WriteBufferWaterMark getWriteBufferWaterMark()
```
    从接口ChannelConfig复制的描述
    
    返回用于设置写入缓冲区的高位和低位水印的WriteBufferWaterMark 。
    
    Specified by:
    
    getWriteBufferWaterMark ，界面 ChannelConfig
  - getMessageSizeEstimator
```
public MessageSizeEstimator getMessageSizeEstimator()
```
    从接口ChannelConfig复制的描述
    
    返回MessageSizeEstimator ，用于通道检测消息的大小。
    
    Specified by:
    
    getMessageSizeEstimator接口 ChannelConfig
  - setMessageSizeEstimator
```
public ChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口ChannelConfig复制的描述
    
    设置用于通道的MessageSizeEstimator以检测消息的大小。
    
    Specified by:
    
    setMessageSizeEstimator接口 ChannelConfig

Class DefaultChannelConfig

Field Summary

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

字段详细信息

channel

构造方法详细信息

DefaultChannelConfig

DefaultChannelConfig

方法详细信息

getOptions

getOptions

setOptions

getOption

setOption

validate

getConnectTimeoutMillis

setConnectTimeoutMillis

getMaxMessagesPerRead

setMaxMessagesPerRead

getWriteSpinCount

setWriteSpinCount

getAllocator

setAllocator

getRecvByteBufAllocator

setRecvByteBufAllocator

isAutoRead

setAutoRead

autoReadCleared

isAutoClose

setAutoClose

getWriteBufferHighWaterMark

setWriteBufferHighWaterMark

getWriteBufferLowWaterMark

setWriteBufferLowWaterMark

setWriteBufferWaterMark

getWriteBufferWaterMark

getMessageSizeEstimator

setMessageSizeEstimator