EpollServerSocketChannelConfig (Netty 4.1.109.Final API文档

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

所有已实现的接口:: ChannelConfig, ServerSocketChannelConfig

public final class EpollServerSocketChannelConfig
extends EpollServerChannelConfig
implements ServerSocketChannelConfig

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

方法概要

All Methods Instance Methods Concrete Methods Deprecated Methods
限定符和类型	方法和说明
`<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`	`getTcpDeferAccept()` Returns a positive value if TCP_DEFER_ACCEPT is enabled.
`boolean`	`isFreeBind()` Returns `true` if IP_FREEBIND is enabled, `false` otherwise.
`boolean`	`isIpTransparent()` Returns `true` if IP_TRANSPARENT is enabled, `false` otherwise.
`boolean`	`isReusePort()` Returns `true` if the SO_REUSEPORT option is set.
`EpollServerSocketChannelConfig`	`setAllocator(ByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
`EpollServerSocketChannelConfig`	`setAutoRead(boolean autoRead)` Sets if `ChannelHandlerContext.read()` will be invoked automatically so that a user application doesn't need to call it at all.
`EpollServerSocketChannelConfig`	`setBacklog(int backlog)` Sets the backlog value to specify when the channel binds to a local address.
`EpollServerSocketChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`EpollServerSocketChannelConfig`	`setFreeBind(boolean freeBind)` If `true` is used IP_FREEBIND is enabled, `false` for disable it.
`EpollServerSocketChannelConfig`	`setIpTransparent(boolean transparent)` If `true` is used IP_TRANSPARENT is enabled, `false` for disable it.
`EpollServerSocketChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`EpollServerSocketChannelConfig`	`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.
`EpollServerSocketChannelConfig`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` Sets the performance preferences as specified in `ServerSocket.setPerformancePreferences(int, int, int)`.
`EpollServerSocketChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)` Gets the `StandardSocketOptions.SO_SNDBUF` option.
`EpollServerSocketChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` Set the `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.
`EpollServerSocketChannelConfig`	`setReuseAddress(boolean reuseAddress)` Sets the `StandardSocketOptions.SO_REUSEADDR` option.
`EpollServerSocketChannelConfig`	`setReusePort(boolean reusePort)` Set the SO_REUSEPORT option on the underlying Channel.
`EpollServerSocketChannelConfig`	`setTcpDeferAccept(int deferAccept)` Set the `TCP_DEFER_ACCEPT` option on the socket.
`EpollServerSocketChannelConfig`	`setTcpMd5Sig(java.util.Map<java.net.InetAddress,byte[]> keys)` Set the `TCP_MD5SIG` option on the socket.
`EpollServerSocketChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` 已过时。
`EpollServerSocketChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` 已过时。
`EpollServerSocketChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` Set the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.
`EpollServerSocketChannelConfig`	`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.EpollServerChannelConfig
getBacklog, getReceiveBufferSize, getTcpFastopen, isReuseAddress, setEpollMode, setTcpFastopen

从类继承的方法 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.socket.ServerSocketChannelConfig
getBacklog, getReceiveBufferSize, isReuseAddress

从接口继承的方法 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 在类中 EpollServerChannelConfig
  - getOption
```
public <T> T getOption(ChannelOption<T> option)
```
    从接口复制的说明: ChannelConfig
    
    Return the value of the given ChannelOption
    
    指定者:
    
    getOption 在接口中 ChannelConfig
    
    覆盖:
    
    getOption 在类中 EpollServerChannelConfig
  - 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 在类中 EpollServerChannelConfig
    
    返回:
    
    true if and only if the property has been set
  - setReuseAddress
```
public EpollServerSocketChannelConfig setReuseAddress(boolean reuseAddress)
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Sets the StandardSocketOptions.SO_REUSEADDR option.
    
    指定者:
    
    setReuseAddress 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setReuseAddress 在类中 EpollServerChannelConfig
  - setReceiveBufferSize
```
public EpollServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Gets the StandardSocketOptions.SO_SNDBUF option.
    
    指定者:
    
    setReceiveBufferSize 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setReceiveBufferSize 在类中 EpollServerChannelConfig
  - setPerformancePreferences
```
public EpollServerSocketChannelConfig setPerformancePreferences(int connectionTime,
                                                                int latency,
                                                                int bandwidth)
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Sets the performance preferences as specified in ServerSocket.setPerformancePreferences(int, int, int).
    
    指定者:
    
    setPerformancePreferences 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setPerformancePreferences 在类中 EpollServerChannelConfig
  - setBacklog
```
public EpollServerSocketChannelConfig setBacklog(int backlog)
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Sets the backlog value to specify when the channel binds to a local address.
    
    指定者:
    
    setBacklog 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setBacklog 在类中 EpollServerChannelConfig
  - setConnectTimeoutMillis
```
public EpollServerSocketChannelConfig 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 在类中 EpollServerChannelConfig
    
    参数:
    
    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.
  - setMaxMessagesPerRead
```
@Deprecated
public EpollServerSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    从类复制的说明: DefaultChannelConfig
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 ChannelConfig
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setMaxMessagesPerRead 在类中 EpollServerChannelConfig
  - setWriteSpinCount
```
public EpollServerSocketChannelConfig 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 在类中 EpollServerChannelConfig
  - setAllocator
```
public EpollServerSocketChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    setAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setAllocator 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setAllocator 在类中 EpollServerChannelConfig
  - setRecvByteBufAllocator
```
public EpollServerSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setRecvByteBufAllocator 在类中 EpollServerChannelConfig
  - setAutoRead
```
public EpollServerSocketChannelConfig 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 在类中 EpollServerChannelConfig
  - setWriteBufferHighWaterMark
```
@Deprecated
public EpollServerSocketChannelConfig 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 在类中 EpollServerChannelConfig
  - setWriteBufferLowWaterMark
```
@Deprecated
public EpollServerSocketChannelConfig 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 在类中 EpollServerChannelConfig
  - setWriteBufferWaterMark
```
public EpollServerSocketChannelConfig 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 在类中 EpollServerChannelConfig
  - setMessageSizeEstimator
```
public EpollServerSocketChannelConfig 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 在类中 EpollServerChannelConfig
  - setTcpMd5Sig
```
public EpollServerSocketChannelConfig setTcpMd5Sig(java.util.Map<java.net.InetAddress,byte[]> keys)
```
    Set the TCP_MD5SIG option on the socket. See linux/tcp.h for more details. Keys can only be set on, not read to prevent a potential leak, as they are confidential. Allowing them being read would mean anyone with access to the channel could get them.
  - isReusePort
```
public boolean isReusePort()
```
    Returns true if the SO_REUSEPORT option is set.
  - setReusePort
```
public EpollServerSocketChannelConfig setReusePort(boolean reusePort)
```
    Set the SO_REUSEPORT option on the underlying Channel. This will allow to bind multiple EpollSocketChannels to the same port and so accept connections with multiple threads. Be aware this method needs be called before AbstractChannel.bind(java.net.SocketAddress) to have any affect.
  - isFreeBind
```
public boolean isFreeBind()
```
    Returns true if IP_FREEBIND is enabled, false otherwise.
  - setFreeBind
```
public EpollServerSocketChannelConfig setFreeBind(boolean freeBind)
```
    If true is used IP_FREEBIND is enabled, false for disable it. Default is disabled.
  - isIpTransparent
```
public boolean isIpTransparent()
```
    Returns true if IP_TRANSPARENT is enabled, false otherwise.
  - setIpTransparent
```
public EpollServerSocketChannelConfig setIpTransparent(boolean transparent)
```
    If true is used IP_TRANSPARENT is enabled, false for disable it. Default is disabled.
  - setTcpDeferAccept
```
public EpollServerSocketChannelConfig setTcpDeferAccept(int deferAccept)
```
    Set the TCP_DEFER_ACCEPT option on the socket. See man 7 tcp for more details.
  - getTcpDeferAccept
```
public int getTcpDeferAccept()
```
    Returns a positive value if TCP_DEFER_ACCEPT is enabled.

类 EpollServerSocketChannelConfig

字段概要

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

方法概要

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

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

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

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

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

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

方法详细资料

getOptions

getOption

setOption

setReuseAddress

setReceiveBufferSize

setPerformancePreferences

setBacklog

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setWriteBufferWaterMark

setMessageSizeEstimator

setTcpMd5Sig

isReusePort

setReusePort

isFreeBind

setFreeBind

isIpTransparent

setIpTransparent

setTcpDeferAccept

getTcpDeferAccept