EpollServerChannelConfig (Netty 4.1.109.Final API文档

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

所有已实现的接口:

ChannelConfig, ServerSocketChannelConfig

直接已知子类:

EpollServerSocketChannelConfig
```
public class EpollServerChannelConfig
extends EpollChannelConfig
implements ServerSocketChannelConfig
```

字段概要
- 从类继承的字段 io.netty.channel.DefaultChannelConfig
  channel

方法概要

All Methods Instance Methods Concrete Methods Deprecated Methods
限定符和类型	方法和说明
`int`	`getBacklog()` Gets the backlog value to specify when the channel binds to a local address.
`<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.
`int`	`getReceiveBufferSize()` Gets the `StandardSocketOptions.SO_RCVBUF` option.
`int`	`getTcpFastopen()` Returns threshold value of number of pending for fast open connect.
`boolean`	`isReuseAddress()` Gets the `StandardSocketOptions.SO_REUSEADDR` option.
`EpollServerChannelConfig`	`setAllocator(ByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
`EpollServerChannelConfig`	`setAutoRead(boolean autoRead)` Sets if `ChannelHandlerContext.read()` will be invoked automatically so that a user application doesn't need to call it at all.
`EpollServerChannelConfig`	`setBacklog(int backlog)` Sets the backlog value to specify when the channel binds to a local address.
`EpollServerChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`EpollServerChannelConfig`	`setEpollMode(EpollMode mode)` Set the `EpollMode` used.
`EpollServerChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`EpollServerChannelConfig`	`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.
`EpollServerChannelConfig`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` Sets the performance preferences as specified in `ServerSocket.setPerformancePreferences(int, int, int)`.
`EpollServerChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)` Gets the `StandardSocketOptions.SO_SNDBUF` option.
`EpollServerChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` Set the `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.
`EpollServerChannelConfig`	`setReuseAddress(boolean reuseAddress)` Sets the `StandardSocketOptions.SO_REUSEADDR` option.
`EpollServerChannelConfig`	`setTcpFastopen(int pendingFastOpenRequestsThreshold)` Enables tcpFastOpen on the server channel.
`EpollServerChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` 已过时。
`EpollServerChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` 已过时。
`EpollServerChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` Set the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.
`EpollServerChannelConfig`	`setWriteSpinCount(int writeSpinCount)` Sets the maximum loop count for a write operation until `WritableByteChannel.write(ByteBuffer)` returns a non-zero value.

从类继承的方法 io.netty.channel.epoll.EpollChannelConfig
autoReadCleared, getEpollMode, getMaxBytesPerGatheringWrite, setMaxBytesPerGatheringWrite, socket

从类继承的方法 io.netty.channel.DefaultChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setMaxMessagesPerWrite, setOptions, validate

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

从接口继承的方法 io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setOptions

- 方法详细资料
  - getOptions
```
public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
```
    从接口复制的说明: ChannelConfig
    
    Return all set ChannelOption's.
    
    指定者:
    
    getOptions 在接口中 ChannelConfig
    
    覆盖:
    
    getOptions 在类中 EpollChannelConfig
  - getOption
```
public <T> T getOption(ChannelOption<T> option)
```
    从接口复制的说明: ChannelConfig
    
    Return the value of the given ChannelOption
    
    指定者:
    
    getOption 在接口中 ChannelConfig
    
    覆盖:
    
    getOption 在类中 EpollChannelConfig
  - 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 在类中 EpollChannelConfig
    
    返回:
    
    true if and only if the property has been set
  - isReuseAddress
```
public boolean isReuseAddress()
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Gets the StandardSocketOptions.SO_REUSEADDR option.
    
    指定者:
    
    isReuseAddress 在接口中 ServerSocketChannelConfig
  - setReuseAddress
```
public EpollServerChannelConfig setReuseAddress(boolean reuseAddress)
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Sets the StandardSocketOptions.SO_REUSEADDR option.
    
    指定者:
    
    setReuseAddress 在接口中 ServerSocketChannelConfig
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Gets the StandardSocketOptions.SO_RCVBUF option.
    
    指定者:
    
    getReceiveBufferSize 在接口中 ServerSocketChannelConfig
  - setReceiveBufferSize
```
public EpollServerChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Gets the StandardSocketOptions.SO_SNDBUF option.
    
    指定者:
    
    setReceiveBufferSize 在接口中 ServerSocketChannelConfig
  - getBacklog
```
public int getBacklog()
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Gets the backlog value to specify when the channel binds to a local address.
    
    指定者:
    
    getBacklog 在接口中 ServerSocketChannelConfig
  - setBacklog
```
public EpollServerChannelConfig setBacklog(int backlog)
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Sets the backlog value to specify when the channel binds to a local address.
    
    指定者:
    
    setBacklog 在接口中 ServerSocketChannelConfig
  - getTcpFastopen
```
public int getTcpFastopen()
```
    Returns threshold value of number of pending for fast open connect.
    
    另请参阅:
    
    RFC 7413 Passive Open
  - setTcpFastopen
```
public EpollServerChannelConfig setTcpFastopen(int pendingFastOpenRequestsThreshold)
```
    Enables tcpFastOpen on the server channel. If the underlying os doesn't support TCP_FASTOPEN setting this has no effect. This has to be set before doing listen on the socket otherwise this takes no effect.
    
    参数:
    
    pendingFastOpenRequestsThreshold - number of requests to be pending for fastopen at a given point in time for security.
    
    另请参阅:
    
    RFC 7413 Passive Open
  - setPerformancePreferences
```
public EpollServerChannelConfig setPerformancePreferences(int connectionTime,
                                                          int latency,
                                                          int bandwidth)
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Sets the performance preferences as specified in ServerSocket.setPerformancePreferences(int, int, int).
    
    指定者:
    
    setPerformancePreferences 在接口中 ServerSocketChannelConfig
  - setConnectTimeoutMillis
```
public EpollServerChannelConfig 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 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setConnectTimeoutMillis 在类中 EpollChannelConfig
    
    参数:
    
    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.
  - setMaxMessagesPerRead
```
@Deprecated
public EpollServerChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    从类复制的说明: DefaultChannelConfig
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 ChannelConfig
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setMaxMessagesPerRead 在类中 EpollChannelConfig
  - setWriteSpinCount
```
public EpollServerChannelConfig 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 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setWriteSpinCount 在类中 EpollChannelConfig
  - setAllocator
```
public EpollServerChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    setAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setAllocator 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setAllocator 在类中 EpollChannelConfig
  - setRecvByteBufAllocator
```
public EpollServerChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setRecvByteBufAllocator 在类中 EpollChannelConfig
  - setAutoRead
```
public EpollServerChannelConfig 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 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setAutoRead 在类中 EpollChannelConfig
  - setWriteBufferHighWaterMark
```
@Deprecated
public EpollServerChannelConfig 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 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setWriteBufferHighWaterMark 在类中 EpollChannelConfig
  - setWriteBufferLowWaterMark
```
@Deprecated
public EpollServerChannelConfig 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 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setWriteBufferLowWaterMark 在类中 EpollChannelConfig
  - setWriteBufferWaterMark
```
public EpollServerChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    从接口复制的说明: ChannelConfig
    
    Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
    
    指定者:
    
    setWriteBufferWaterMark 在接口中 ChannelConfig
    
    指定者:
    
    setWriteBufferWaterMark 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setWriteBufferWaterMark 在类中 EpollChannelConfig
  - setMessageSizeEstimator
```
public EpollServerChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口复制的说明: ChannelConfig
    
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ChannelConfig
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setMessageSizeEstimator 在类中 EpollChannelConfig
  - setEpollMode
```
public EpollServerChannelConfig setEpollMode(EpollMode mode)
```
    从类复制的说明: EpollChannelConfig
    
    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.
    
    覆盖:
    
    setEpollMode 在类中 EpollChannelConfig

类 EpollServerChannelConfig

字段概要

从类继承的字段 io.netty.channel.DefaultChannelConfig

方法概要

从类继承的方法 io.netty.channel.epoll.EpollChannelConfig

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

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

从接口继承的方法 io.netty.channel.ChannelConfig

方法详细资料

getOptions

getOption

setOption

isReuseAddress

setReuseAddress

getReceiveBufferSize

setReceiveBufferSize

getBacklog

setBacklog

getTcpFastopen

setTcpFastopen

setPerformancePreferences

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setWriteBufferWaterMark

setMessageSizeEstimator

setEpollMode