EpollServerSocketChannelConfig (Netty/Transport/Native/Epoll 4.1.33.Final API)

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

All Implemented Interfaces:: io.netty.channel.ChannelConfig, io.netty.channel.socket.ServerSocketChannelConfig

public final class EpollServerSocketChannelConfig
extends EpollServerChannelConfig
implements io.netty.channel.socket.ServerSocketChannelConfig

Field Summary
- Fields inherited from class io.netty.channel.DefaultChannelConfig
  channel

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T> T`	`getOption(io.netty.channel.ChannelOption<T> option)`
`Map<io.netty.channel.ChannelOption<?>,Object>`	`getOptions()`
`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(io.netty.buffer.ByteBufAllocator allocator)`
`EpollServerSocketChannelConfig`	`setAutoRead(boolean autoRead)`
`EpollServerSocketChannelConfig`	`setBacklog(int backlog)`
`EpollServerSocketChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)`
`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)` Deprecated.
`EpollServerSocketChannelConfig`	`setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)`
`<T> boolean`	`setOption(io.netty.channel.ChannelOption<T> option, T value)`
`EpollServerSocketChannelConfig`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)`
`EpollServerSocketChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)`
`EpollServerSocketChannelConfig`	`setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)`
`EpollServerSocketChannelConfig`	`setReuseAddress(boolean reuseAddress)`
`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(Map<InetAddress,byte[]> keys)` Set the `TCP_MD5SIG` option on the socket.
`EpollServerSocketChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` Deprecated.
`EpollServerSocketChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` Deprecated.
`EpollServerSocketChannelConfig`	`setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)`
`EpollServerSocketChannelConfig`	`setWriteSpinCount(int writeSpinCount)`

Methods inherited from class io.netty.channel.epoll.EpollServerChannelConfig
getBacklog, getReceiveBufferSize, getTcpFastopen, isReuseAddress, setEpollMode, setTcpFastopen

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, setAutoClose, 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.socket.ServerSocketChannelConfig
getBacklog, getReceiveBufferSize, isReuseAddress

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

- Method Detail
  - getOptions
```
public Map<io.netty.channel.ChannelOption<?>,Object> getOptions()
```
    Specified by:
    
    getOptions in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    getOptions in class EpollServerChannelConfig
  - getOption
```
public <T> T getOption(io.netty.channel.ChannelOption<T> option)
```
    Specified by:
    
    getOption in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    getOption in class EpollServerChannelConfig
  - setOption
```
public <T> boolean setOption(io.netty.channel.ChannelOption<T> option,
                             T value)
```
    Specified by:
    
    setOption in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    setOption in class EpollServerChannelConfig
  - setReuseAddress
```
public EpollServerSocketChannelConfig setReuseAddress(boolean reuseAddress)
```
    Specified by:
    
    setReuseAddress in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setReuseAddress in class EpollServerChannelConfig
  - setReceiveBufferSize
```
public EpollServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    Specified by:
    
    setReceiveBufferSize in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setReceiveBufferSize in class EpollServerChannelConfig
  - setPerformancePreferences
```
public EpollServerSocketChannelConfig setPerformancePreferences(int connectionTime,
                                                                int latency,
                                                                int bandwidth)
```
    Specified by:
    
    setPerformancePreferences in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setPerformancePreferences in class EpollServerChannelConfig
  - setBacklog
```
public EpollServerSocketChannelConfig setBacklog(int backlog)
```
    Specified by:
    
    setBacklog in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setBacklog in class EpollServerChannelConfig
  - setConnectTimeoutMillis
```
public EpollServerSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    Specified by:
    
    setConnectTimeoutMillis in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setConnectTimeoutMillis in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setConnectTimeoutMillis in class EpollServerChannelConfig
  - setMaxMessagesPerRead
```
@Deprecated
public EpollServerSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    Deprecated.
    
    Specified by:
    
    setMaxMessagesPerRead in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setMaxMessagesPerRead in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setMaxMessagesPerRead in class EpollServerChannelConfig
  - setWriteSpinCount
```
public EpollServerSocketChannelConfig setWriteSpinCount(int writeSpinCount)
```
    Specified by:
    
    setWriteSpinCount in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setWriteSpinCount in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setWriteSpinCount in class EpollServerChannelConfig
  - setAllocator
```
public EpollServerSocketChannelConfig setAllocator(io.netty.buffer.ByteBufAllocator allocator)
```
    Specified by:
    
    setAllocator in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setAllocator in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setAllocator in class EpollServerChannelConfig
  - setRecvByteBufAllocator
```
public EpollServerSocketChannelConfig setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)
```
    Specified by:
    
    setRecvByteBufAllocator in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setRecvByteBufAllocator in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setRecvByteBufAllocator in class EpollServerChannelConfig
  - setAutoRead
```
public EpollServerSocketChannelConfig setAutoRead(boolean autoRead)
```
    Specified by:
    
    setAutoRead in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setAutoRead in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setAutoRead in class EpollServerChannelConfig
  - setWriteBufferHighWaterMark
```
@Deprecated
public EpollServerSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
```
    Deprecated.
    
    Specified by:
    
    setWriteBufferHighWaterMark in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setWriteBufferHighWaterMark in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setWriteBufferHighWaterMark in class EpollServerChannelConfig
  - setWriteBufferLowWaterMark
```
@Deprecated
public EpollServerSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
```
    Deprecated.
    
    Specified by:
    
    setWriteBufferLowWaterMark in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setWriteBufferLowWaterMark in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setWriteBufferLowWaterMark in class EpollServerChannelConfig
  - setWriteBufferWaterMark
```
public EpollServerSocketChannelConfig setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)
```
    Specified by:
    
    setWriteBufferWaterMark in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setWriteBufferWaterMark in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setWriteBufferWaterMark in class EpollServerChannelConfig
  - setMessageSizeEstimator
```
public EpollServerSocketChannelConfig setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)
```
    Specified by:
    
    setMessageSizeEstimator in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setMessageSizeEstimator in interface io.netty.channel.socket.ServerSocketChannelConfig
    
    Overrides:
    
    setMessageSizeEstimator in class EpollServerChannelConfig
  - setTcpMd5Sig
```
public EpollServerSocketChannelConfig setTcpMd5Sig(Map<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.

Class EpollServerSocketChannelConfig

Field Summary

Fields inherited from class io.netty.channel.DefaultChannelConfig

Method Summary

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

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.socket.ServerSocketChannelConfig

Methods inherited from interface io.netty.channel.ChannelConfig

Method Detail

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