EpollDomainSocketChannelConfig (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:: ChannelConfig ， DomainSocketChannelConfig

public final class EpollDomainSocketChannelConfig
extends EpollChannelConfig
implements DomainSocketChannelConfig

方法摘要

所有方法接口方法具体的方法弃用的方法
Modifier and Type	Method and Description
`<T> T`	`getOption(ChannelOption<T> option)` 返回给定的`ChannelOption`的值
`java.util.Map<ChannelOption<?>,java.lang.Object>`	`getOptions()` 返回所有设置`ChannelOption`的。
`DomainSocketReadMode`	`getReadMode()` 返回频道的`DomainSocketReadMode` 。
`EpollDomainSocketChannelConfig`	`setAllocator(ByteBufAllocator allocator)` 设置用于通道分配缓冲区的`ByteBufAllocator` 。
`EpollDomainSocketChannelConfig`	`setAutoClose(boolean autoClose)`
`EpollDomainSocketChannelConfig`	`setAutoRead(boolean autoRead)` 设置是否自动调用 `ChannelHandlerContext.read()`，以便用户应用程序根本不需要调用它。
`EpollDomainSocketChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` 以毫秒为单位设置通道的连接超时。
`EpollDomainSocketChannelConfig`	`setEpollMode(EpollMode mode)` 设置使用的`EpollMode` 。
`EpollDomainSocketChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`EpollDomainSocketChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` 设置用于通道的`MessageSizeEstimator`以检测消息的大小。
`<T> boolean`	`setOption(ChannelOption<T> option, T value)` 使用指定的名称和值设置配置属性。
`EpollDomainSocketChannelConfig`	`setReadMode(DomainSocketReadMode mode)` 更改频道的`DomainSocketReadMode` 。
`EpollDomainSocketChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` 设置用于通道分配接收缓冲区的`RecvByteBufAllocator` 。
`EpollDomainSocketChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` 已过时。
`EpollDomainSocketChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` 已过时。
`EpollDomainSocketChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` 设置`WriteBufferWaterMark`用于设置写入缓冲区的高位和低位水印。
`EpollDomainSocketChannelConfig`	`setWriteSpinCount(int writeSpinCount)` 设置写入操作的最大循环计数，直到 `WritableByteChannel.write(ByteBuffer)`返回非零值。

Methods inherited from class io.netty.channel.epoll.EpollChannelConfig
autoReadCleared, getEpollMode

Methods inherited from class io.netty.channel.DefaultChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions

- 方法详细信息
  - getOptions
```
public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
```
    从界面复制的描述： ChannelConfig
    
    返回所有设置ChannelOption的。
    
    Specified by:
    
    getOptions在界面 ChannelConfig
    
    重写：
    
    getOptions在课堂 EpollChannelConfig
  - getOption
```
public <T> T getOption(ChannelOption<T> option)
```
    从接口复制的描述： ChannelConfig
    
    返回给定ChannelOption的值
    
    Specified by:
    
    getOption在界面 ChannelConfig
    
    重写：
    
    getOption在课堂 EpollChannelConfig
  - 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
    
    重写：
    
    setOption在课堂 EpollChannelConfig
    
    结果
    
    true当且仅当该属性已设置
  - setMaxMessagesPerRead
```
@Deprecated
public EpollDomainSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    从类复制的描述： DefaultChannelConfig
    
    Specified by:
    
    setMaxMessagesPerRead接口 ChannelConfig
    
    Specified by:
    
    setMaxMessagesPerRead接口 DomainSocketChannelConfig
    
    重写：
    
    setMaxMessagesPerRead在课堂 EpollChannelConfig
  - setConnectTimeoutMillis
```
public EpollDomainSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    从界面复制的描述： ChannelConfig
    
    以毫秒为单位设置通道的连接超时。如果Channel不支持连接操作，则完全不使用此属性，因此将被忽略。
    
    Specified by:
    
    setConnectTimeoutMillis在界面 ChannelConfig
    
    Specified by:
    
    setConnectTimeoutMillis接口 DomainSocketChannelConfig
    
    重写：
    
    setConnectTimeoutMillis在课堂 EpollChannelConfig
    
    参数
    
    connectTimeoutMillis - 以毫秒为单位的连接超时。 0禁用。
  - setWriteSpinCount
```
public EpollDomainSocketChannelConfig setWriteSpinCount(int writeSpinCount)
```
    从接口复制的描述： ChannelConfig
    
    设置写入操作的最大循环计数，直到WritableByteChannel.write(ByteBuffer)返回非零值。它类似于在并发编程中使用自旋锁。它可以提高内存利用率并根据运行JVM的平台来编写吞吐量。默认值是16 。
    
    Specified by:
    
    setWriteSpinCount在界面 ChannelConfig
    
    Specified by:
    
    setWriteSpinCount接口 DomainSocketChannelConfig
    
    重写：
    
    setWriteSpinCount在课堂 EpollChannelConfig
  - setRecvByteBufAllocator
```
public EpollDomainSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从界面复制的描述： ChannelConfig
    
    设置用于通道的RecvByteBufAllocator以分配接收缓冲区。
    
    Specified by:
    
    setRecvByteBufAllocator在界面 ChannelConfig
    
    Specified by:
    
    setRecvByteBufAllocator接口 DomainSocketChannelConfig
    
    重写：
    
    setRecvByteBufAllocator在课堂上 EpollChannelConfig
  - setAllocator
```
public EpollDomainSocketChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口复制的描述： ChannelConfig
    
    设置用于通道分配缓冲区的ByteBufAllocator 。
    
    Specified by:
    
    setAllocator在界面 ChannelConfig
    
    Specified by:
    
    setAllocator接口 DomainSocketChannelConfig
    
    重写：
    
    setAllocator在课堂 EpollChannelConfig
  - setAutoClose
```
public EpollDomainSocketChannelConfig setAutoClose(boolean autoClose)
```
    Specified by:
    
    setAutoClose接口 ChannelConfig
    
    Specified by:
    
    setAutoClose接口 DomainSocketChannelConfig
    
    重写：
    
    setAutoClose在课堂上 DefaultChannelConfig
  - setMessageSizeEstimator
```
public EpollDomainSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从界面复制的描述： ChannelConfig
    
    设置用于通道的MessageSizeEstimator以检测消息的大小。
    
    Specified by:
    
    setMessageSizeEstimator接口 ChannelConfig
    
    Specified by:
    
    setMessageSizeEstimator在界面 DomainSocketChannelConfig
    
    重写：
    
    setMessageSizeEstimator在课堂 EpollChannelConfig
  - setWriteBufferLowWaterMark
```
@Deprecated
public EpollDomainSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
```
    已过时。
    
    从界面： ChannelConfig复制的描述
    
    设置写入缓冲区的低水位标志。一旦写入缓冲区中排队的字节数超过了high water mark ，然后下降到此值以下， Channel.isWritable()将再次开始返回true 。
    
    Specified by:
    
    setWriteBufferLowWaterMark在界面 ChannelConfig
    
    Specified by:
    
    setWriteBufferLowWaterMark在界面 DomainSocketChannelConfig
    
    重写：
    
    setWriteBufferLowWaterMark在课堂 EpollChannelConfig
  - setWriteBufferHighWaterMark
```
@Deprecated
public EpollDomainSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
```
    已过时。
    
    从界面复制的描述： ChannelConfig
    
    设置写入缓冲区的高位标记。如果写入缓冲区中排队的字节数超过此值，则Channel.isWritable()将开始返回false 。
    
    Specified by:
    
    setWriteBufferHighWaterMark接口 ChannelConfig
    
    Specified by:
    
    setWriteBufferHighWaterMark接口 DomainSocketChannelConfig
    
    重写：
    
    setWriteBufferHighWaterMark在课堂 EpollChannelConfig
  - setWriteBufferWaterMark
```
public EpollDomainSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    从界面复制的描述： ChannelConfig
    
    设置用于设置写入缓冲区的高位和低位标志的WriteBufferWaterMark 。
    
    Specified by:
    
    setWriteBufferWaterMark接口 ChannelConfig
    
    Specified by:
    
    setWriteBufferWaterMark在界面 DomainSocketChannelConfig
    
    重写：
    
    setWriteBufferWaterMark在课堂 EpollChannelConfig
  - setAutoRead
```
public EpollDomainSocketChannelConfig setAutoRead(boolean autoRead)
```
    从接口复制的描述： ChannelConfig
    
    设置是否自动调用ChannelHandlerContext.read()，以便用户应用程序根本不需要调用它。默认值是true 。
    
    Specified by:
    
    setAutoRead接口 ChannelConfig
    
    Specified by:
    
    setAutoRead在界面 DomainSocketChannelConfig
    
    重写：
    
    setAutoRead在课堂 EpollChannelConfig
  - setEpollMode
```
public EpollDomainSocketChannelConfig setEpollMode(EpollMode mode)
```
    从类复制的描述： EpollChannelConfig
    
    设置使用的EpollMode 。默认为EpollMode.EDGE_TRIGGERED 。如果您想要使用DefaultChannelConfig.isAutoRead() false或DefaultChannelConfig.getMaxMessagesPerRead()并且具有准确的行为，则应使用EpollMode.LEVEL_TRIGGERED 。 请注意，只有在频道注册之前，才能调整此配置设置。
    
    重写：
    
    setEpollMode在课堂 EpollChannelConfig
  - setReadMode
```
public EpollDomainSocketChannelConfig setReadMode(DomainSocketReadMode mode)
```
    从界面复制的描述： DomainSocketChannelConfig
    
    更改频道的DomainSocketReadMode 。默认值为DomainSocketReadMode.BYTES ，这意味着字节将从Channel读取并通过管道传递。如果使用DomainSocketReadMode.FILE_DESCRIPTORS，则FileDescriptor将通过ChannelPipeline 。如果需要，可以即时修改此设置。
    
    Specified by:
    
    setReadMode接口 DomainSocketChannelConfig
  - getReadMode
```
public DomainSocketReadMode getReadMode()
```
    从接口复制的描述： DomainSocketChannelConfig
    
    返回频道的DomainSocketReadMode 。
    
    Specified by:
    
    getReadMode在界面 DomainSocketChannelConfig

Class EpollDomainSocketChannelConfig

方法摘要

Methods inherited from class io.netty.channel.epoll.EpollChannelConfig

Methods inherited from class io.netty.channel.DefaultChannelConfig

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelConfig

方法详细信息

getOptions

getOption

setOption

setMaxMessagesPerRead

setConnectTimeoutMillis

setWriteSpinCount

setRecvByteBufAllocator

setAllocator

setAutoClose

setMessageSizeEstimator

setWriteBufferLowWaterMark

setWriteBufferHighWaterMark

setWriteBufferWaterMark

setAutoRead

setEpollMode

setReadMode

getReadMode