All Implemented Interfaces:

ChannelConfig

Direct Known Subclasses:

EpollServerSocketChannelConfig

public class EpollServerChannelConfig
extends EpollChannelConfig 

• Field Summary

  Fields

  Modifier and Type	Field and Description
  protected io.netty.channel.epoll.AbstractEpollChannel	channel

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  int	getBacklog ()
  <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 ()
  int	getTcpFastopen () Returns threshold value of number of pending for fast open connect.
  boolean	isReuseAddress ()
  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)
  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) Sets the maximum number of messages to read per read loop.
  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	setReceiveBufferSize (int receiveBufferSize)
  EpollServerChannelConfig	setRecvByteBufAllocator (RecvByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
  EpollServerChannelConfig	setReuseAddress (boolean reuseAddress)
  EpollServerChannelConfig	setTcpFastopen (int pendingFastOpenRequestsThreshold) Enables tcpFastOpen on the server channel.
  EpollServerChannelConfig	setWriteBufferHighWaterMark (int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
  EpollServerChannelConfig	setWriteBufferLowWaterMark (int writeBufferLowWaterMark) Sets the 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.

  • 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, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setOptions, validate

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Field Detail

  • channel

    protected final io.netty.channel.epoll.AbstractEpollChannel channel

• Method Detail

  • getOptions

    public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()

    Description copied from interface: ChannelConfig
    Return all set ChannelOption's.

    Specified by:

    getOptions in interface ChannelConfig

    Overrides:

    getOptions in class EpollChannelConfig

  • getOption

    public <T> T getOption(ChannelOption<T> option)

    Description copied from interface: ChannelConfig
    Return the value of the given ChannelOption

    Specified by:

    getOption in interface ChannelConfig

    Overrides:

    getOption in class EpollChannelConfig

  • setOption

    public <T> boolean setOption(ChannelOption<T> option,
     T value)

    Description copied from interface: 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;
     }
     

    Specified by:

    setOption in interface ChannelConfig

    Overrides:

    setOption in class EpollChannelConfig

    Returns:

    true if and only if the property has been set

  • isReuseAddress

    public boolean isReuseAddress()

  • setReuseAddress

    public EpollServerChannelConfig setReuseAddress(boolean reuseAddress)

  • getReceiveBufferSize

    public int getReceiveBufferSize()

  • setReceiveBufferSize

    public EpollServerChannelConfig setReceiveBufferSize(int receiveBufferSize)

  • getBacklog

    public int getBacklog()

  • setBacklog

    public EpollServerChannelConfig setBacklog(int backlog)

  • getTcpFastopen

    public int getTcpFastopen()

    Returns threshold value of number of pending for fast open connect.

    See Also:

    RFC 7413 Passive Open

  • setTcpFastopen

    public EpollServerChannelConfig setTcpFastopen(int pendingFastOpenRequestsThreshold)

    Enables tcpFastOpen on the server channel. If the underlying os doesnt support TCP_FASTOPEN setting this has no effect. This has to be set before doing listen on the socket otherwise this takes no effect.

    Parameters:

    pendingFastOpenRequestsThreshold - number of requests to be pending for fastopen at a given point in time for security. @see RFC 7413 Passive Open

    See Also:

    RFC 7413 TCP FastOpen

  • setConnectTimeoutMillis

    public EpollServerChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

    Description copied from interface: 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.

    Specified by:

    setConnectTimeoutMillis in interface ChannelConfig

    Overrides:

    setConnectTimeoutMillis in class EpollChannelConfig

    Parameters:

    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.

  • setMaxMessagesPerRead

    public EpollServerChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

    Description copied from interface: ChannelConfig
    Sets the maximum number of messages to read per read loop. If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.

    Specified by:

    setMaxMessagesPerRead in interface ChannelConfig

    Overrides:

    setMaxMessagesPerRead in class EpollChannelConfig

  • setWriteSpinCount

    public EpollServerChannelConfig setWriteSpinCount(int writeSpinCount)

    Description copied from interface: 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.

    Specified by:

    setWriteSpinCount in interface ChannelConfig

    Overrides:

    setWriteSpinCount in class EpollChannelConfig

  • setAllocator

    public EpollServerChannelConfig setAllocator(ByteBufAllocator allocator)

    Description copied from interface: ChannelConfig
    Set the ByteBufAllocator which is used for the channel to allocate buffers.

    Specified by:

    setAllocator in interface ChannelConfig

    Overrides:

    setAllocator in class EpollChannelConfig

  • setRecvByteBufAllocator

    public EpollServerChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

    Description copied from interface: ChannelConfig
    Set the ByteBufAllocator which is used for the channel to allocate receive buffers.

    Specified by:

    setRecvByteBufAllocator in interface ChannelConfig

    Overrides:

    setRecvByteBufAllocator in class EpollChannelConfig

  • setAutoRead

    public EpollServerChannelConfig setAutoRead(boolean autoRead)

    Description copied from interface: 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.

    Specified by:

    setAutoRead in interface ChannelConfig

    Overrides:

    setAutoRead in class EpollChannelConfig

  • setWriteBufferHighWaterMark

    public EpollServerChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

    Description copied from interface: 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.

    Specified by:

    setWriteBufferHighWaterMark in interface ChannelConfig

    Overrides:

    setWriteBufferHighWaterMark in class EpollChannelConfig

  • setWriteBufferLowWaterMark

    public EpollServerChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

    Description copied from interface: 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.

    Specified by:

    setWriteBufferLowWaterMark in interface ChannelConfig

    Overrides:

    setWriteBufferLowWaterMark in class EpollChannelConfig

  • setMessageSizeEstimator

    public EpollServerChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

    Description copied from interface: ChannelConfig
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.

    Specified by:

    setMessageSizeEstimator in interface ChannelConfig

    Overrides:

    setMessageSizeEstimator in class EpollChannelConfig

  • setEpollMode

    public EpollServerChannelConfig setEpollMode(EpollMode mode)

    Description copied from class: 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.

    Overrides:

    setEpollMode in class EpollChannelConfig