ChannelConfig (Netty API Reference (4.1.22.Final))

All Known Subinterfaces:

DatagramChannelConfig ， DomainSocketChannelConfig ， OioDatagramChannelConfig ， OioServerSocketChannelConfig ， OioSocketChannelConfig ， RxtxChannelConfig ， SctpChannelConfig ， SctpServerChannelConfig ， ServerSocketChannelConfig ， SocketChannelConfig ， UdtChannelConfig ， UdtServerChannelConfig

所有已知实现类：

DefaultChannelConfig ， DefaultDatagramChannelConfig ， DefaultOioServerSocketChannelConfig ， DefaultOioSocketChannelConfig ， DefaultSctpChannelConfig ， DefaultSctpServerChannelConfig ， DefaultServerSocketChannelConfig ， DefaultSocketChannelConfig ， DefaultUdtChannelConfig ， DefaultUdtServerChannelConfig ， EpollChannelConfig ， EpollDatagramChannelConfig ， EpollDomainSocketChannelConfig ， EpollServerChannelConfig ， EpollServerSocketChannelConfig ， EpollSocketChannelConfig ， KQueueChannelConfig ， KQueueDatagramChannelConfig ， KQueueDomainSocketChannelConfig ， KQueueServerChannelConfig ， KQueueServerSocketChannelConfig ， KQueueSocketChannelConfig
```
public interface ChannelConfig
```
一组Channel的配置属性。
请下载到更具体的配置类型，例如SocketChannelConfig或使用setOptions(Map)来设置传输特定的属性：
```
  Channel ch = ...;
 SocketChannelConfig cfg = (SocketChannelConfig) ch.getConfig();
 cfg.setTcpNoDelay(false); 
```
选项图
选项映射属性是动态只写属性，它允许配置Channel而不下推相关的ChannelConfig 。要更新选项图，请致电setOptions(Map) 。
所有ChannelConfig有以下选择：
Name Associated setter method ChannelOption.CONNECT_TIMEOUT_MILLIS setConnectTimeoutMillis(int) ChannelOption.WRITE_SPIN_COUNT setWriteSpinCount(int) ChannelOption.WRITE_BUFFER_WATER_MARK setWriteBufferWaterMark(WriteBufferWaterMark) ChannelOption.ALLOCATOR setAllocator(ByteBufAllocator) ChannelOption.AUTO_READ setAutoRead(boolean)

更多选项可在ChannelConfig的子类型中使用。例如，您可以配置特定于TCP / IP套接字的参数，如SocketChannelConfig中所述。

方法摘要

所有方法接口方法抽象方法弃用的方法
Modifier and Type	Method and Description
`ByteBufAllocator`	`getAllocator()` 返回`ByteBufAllocator` ，用于通道分配缓冲区。
`int`	`getConnectTimeoutMillis()` 以毫秒为单位返回通道的连接超时。
`int`	`getMaxMessagesPerRead()` 已过时。使用`MaxMessagesRecvByteBufAllocator` 返回每个读取循环要读取的最大消息数。 `channelRead()`事件。如果此值大于1，则事件循环可能会尝试多次读取以获取多条消息。
`MessageSizeEstimator`	`getMessageSizeEstimator()` 返回`MessageSizeEstimator` ，用于通道检测消息的大小。
`<T> T`	`getOption(ChannelOption<T> option)` 返回给定的`ChannelOption`的值
`java.util.Map<ChannelOption<?>,java.lang.Object>`	`getOptions()` 返回所有设置`ChannelOption`的。
`<T extends RecvByteBufAllocator> T`	`getRecvByteBufAllocator()` 返回`RecvByteBufAllocator` ，用于通道分配接收缓冲区。
`int`	`getWriteBufferHighWaterMark()` 返回写入缓冲区的高位标记。
`int`	`getWriteBufferLowWaterMark()` 返回写缓冲区的低水位标志。
`WriteBufferWaterMark`	`getWriteBufferWaterMark()` 返回用于设置写入缓冲区的高位和低位水印的`WriteBufferWaterMark` 。
`int`	`getWriteSpinCount()` 返回写操作的最大循环数，直到 `WritableByteChannel.write(ByteBuffer)`返回非零值。
`boolean`	`isAutoClose()` 已过时。自动关闭将在未来的版本中被删除。当且仅当`Channel`将在写入失败时自动关闭并立即返回`true` 。默认值是`false` 。
`boolean`	`isAutoRead()` 返回 `true`当且仅当 `ChannelHandlerContext.read()`将被自动调用，以便用户应用程序根本不需要调用它。
`ChannelConfig`	`setAllocator(ByteBufAllocator allocator)` 设置用于通道分配缓冲区的`ByteBufAllocator` 。
`ChannelConfig`	`setAutoClose(boolean autoClose)` 已过时。自动关闭将在未来的版本中被删除。设置`Channel`是否应该在写入失败时自动关闭。默认值是`false` 。
`ChannelConfig`	`setAutoRead(boolean autoRead)` 设置是否自动调用 `ChannelHandlerContext.read()`，以便用户应用程序根本不需要调用它。
`ChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` 以毫秒为单位设置通道的连接超时。
`ChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。使用`MaxMessagesRecvByteBufAllocator` 设置每个读取循环要读取的最大消息数。如果此值大于1，则事件循环可能会尝试多次读取以获取多条消息。
`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)`返回非零值。

- 方法详细信息
  - getOptions
```
java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
```
    返回所有设置ChannelOption 's。
  - setOptions
```
boolean setOptions(java.util.Map<ChannelOption<?>,?> options)
```
    从指定的 Map设置配置属性。
  - getOption
```
<T> T getOption(ChannelOption<T> option)
```
    返回给定的ChannelOption的值
  - setOption
```
<T> boolean setOption(ChannelOption<T> option,
                      T value)
```
    使用指定的名称和值设置配置属性。要正确覆盖此方法，您必须调用超类：
```
  public boolean setOption(ChannelOption<T> option, T value) {
     if (super.setOption(option, value)) {
         return true;
     }

     if (option.equals(additionalOption)) {
         ....
         return true;
     }

     return false;
 } 
```
    结果
    
    true当且仅当属性已设置
  - getConnectTimeoutMillis
```
int getConnectTimeoutMillis()
```
    以毫秒为单位返回通道的连接超时。如果Channel不支持连接操作，则完全不使用此属性，因此将被忽略。
    
    结果
    
    以毫秒为单位的连接超时。 0如果禁用。
  - setConnectTimeoutMillis
```
ChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    以毫秒为单位设置通道的连接超时。如果Channel不支持连接操作，则完全不使用此属性，因此将被忽略。
    
    参数
    
    connectTimeoutMillis - 以毫秒为单位的连接超时。 0禁用。
  - getMaxMessagesPerRead
```
@Deprecated
int getMaxMessagesPerRead()
```
    已过时。使用MaxMessagesRecvByteBufAllocator
    返回每个读取循环要读取的最大消息数。 channelRead()事件。如果此值大于1，则事件循环可能会尝试多次读取以获取多条消息。
  - setMaxMessagesPerRead
```
@Deprecated
ChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。使用MaxMessagesRecvByteBufAllocator
    设置每个读取循环要读取的最大消息数。如果此值大于1，则事件循环可能会尝试多次读取以获取多条消息。
  - getWriteSpinCount
```
int getWriteSpinCount()
```
    返回写入操作的最大循环计数，直到WritableByteChannel.write(ByteBuffer)返回非零值。它类似于在并发编程中使用自旋锁。它可以提高内存利用率并根据运行JVM的平台来编写吞吐量。默认值是16 。
  - setWriteSpinCount
```
ChannelConfig setWriteSpinCount(int writeSpinCount)
```
    设置写入操作的最大循环数，直到WritableByteChannel.write(ByteBuffer)返回非零值。它类似于在并发编程中使用自旋锁。它可以提高内存利用率并根据运行JVM的平台来编写吞吐量。默认值是16 。
    
    异常
    
    java.lang.IllegalArgumentException - 如果指定的值是 0或小于 0
  - getAllocator
```
ByteBufAllocator getAllocator()
```
    返回ByteBufAllocator ，用于通道分配缓冲区。
  - setAllocator
```
ChannelConfig setAllocator(ByteBufAllocator allocator)
```
    设置用于通道分配缓冲区的ByteBufAllocator 。
  - getRecvByteBufAllocator
```
<T extends RecvByteBufAllocator> T getRecvByteBufAllocator()
```
    返回RecvByteBufAllocator ，用于通道分配接收缓冲区。
  - setRecvByteBufAllocator
```
ChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    设置用于通道分配接收缓冲区的RecvByteBufAllocator 。
  - isAutoRead
```
boolean isAutoRead()
```
    当且仅当自动调用ChannelHandlerContext.read()时才返回true ，以便用户应用程序根本不需要调用它。默认值是true 。
  - setAutoRead
```
ChannelConfig setAutoRead(boolean autoRead)
```
    设置是否自动调用ChannelHandlerContext.read()，以便用户应用程序根本不需要调用它。默认值是true 。
  - isAutoClose
```
@Deprecated
boolean isAutoClose()
```
    已过时。自动关闭将在未来的版本中被删除。当且仅当Channel将在写入失败时自动关闭并立即返回true 。默认值是false 。
  - setAutoClose
```
@Deprecated
ChannelConfig setAutoClose(boolean autoClose)
```
    已过时。自动关闭将在未来的版本中被删除。设置Channel是否应该在写入失败时自动关闭。默认值是false 。
  - getWriteBufferHighWaterMark
```
int getWriteBufferHighWaterMark()
```
    返回写入缓冲区的高位标记。如果写入缓冲区中排队的字节数超过此值，则Channel.isWritable()将开始返回false 。
  - setWriteBufferHighWaterMark
```
ChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
```
    设置写入缓冲区的高位标记。如果写入缓冲区中排队的字节数超过此值，则Channel.isWritable()将开始返回false 。
  - getWriteBufferLowWaterMark
```
int getWriteBufferLowWaterMark()
```
    返回写缓冲区的低水位标志。一旦写入缓冲器中排队的字节数超过了high water mark ，然后下降到此值以下， Channel.isWritable()将再次开始返回true 。
  - setWriteBufferLowWaterMark
```
ChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
```
    设置写入缓冲区的低水位标志。一旦写入缓冲器中排队的字节数超过了high water mark ，然后下降到此值以下， Channel.isWritable()将再次开始返回true 。
  - getMessageSizeEstimator
```
MessageSizeEstimator getMessageSizeEstimator()
```
    返回MessageSizeEstimator ，用于通道检测消息的大小。
  - setMessageSizeEstimator
```
ChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    设置用于通道的MessageSizeEstimator以检测消息的大小。
  - getWriteBufferWaterMark
```
WriteBufferWaterMark getWriteBufferWaterMark()
```
    返回用于设置写入缓冲区的高位和低位水印的WriteBufferWaterMark 。
  - setWriteBufferWaterMark
```
ChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    设置WriteBufferWaterMark ，用于设置写入缓冲区的高位和低位水印。

Interface ChannelConfig

选项图

方法摘要

方法详细信息

getOptions

setOptions

getOption

setOption

getConnectTimeoutMillis

setConnectTimeoutMillis

getMaxMessagesPerRead

setMaxMessagesPerRead

getWriteSpinCount

setWriteSpinCount

getAllocator

setAllocator

getRecvByteBufAllocator

setRecvByteBufAllocator

isAutoRead

setAutoRead

isAutoClose

setAutoClose

getWriteBufferHighWaterMark

setWriteBufferHighWaterMark

getWriteBufferLowWaterMark

setWriteBufferLowWaterMark

getMessageSizeEstimator

setMessageSizeEstimator

getWriteBufferWaterMark

setWriteBufferWaterMark