Class EpollServerSocketChannelConfig

Field Summary

Method Summary

Method Details

• getOptions

  public Map<ChannelOption<?>, Object> getOptions()

  Description copied from interface: ChannelConfig

  Return all set ChannelOption's.

  Specified by:

  getOptions in interface ChannelConfig

  Overrides:

  getOptions in class EpollServerChannelConfig

• 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 EpollServerChannelConfig

• 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 EpollServerChannelConfig

  Returns:

  true if and only if the property has been set

• setReuseAddress

  public EpollServerSocketChannelConfig setReuseAddress(boolean reuseAddress)

  Description copied from interface: ServerSocketChannelConfig

  Sets the StandardSocketOptions.SO_REUSEADDR option.

  Specified by:

  setReuseAddress in interface ServerSocketChannelConfig

  Overrides:

  setReuseAddress in class EpollServerChannelConfig

• setReceiveBufferSize

  public EpollServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

  Description copied from interface: ServerSocketChannelConfig

  Gets the StandardSocketOptions.SO_SNDBUF option.

  Specified by:

  setReceiveBufferSize in interface ServerSocketChannelConfig

  Overrides:

  setReceiveBufferSize in class EpollServerChannelConfig

• setPerformancePreferences

  public EpollServerSocketChannelConfig setPerformancePreferences(int connectionTime, int latency, int bandwidth)

  Description copied from interface: ServerSocketChannelConfig

  Sets the performance preferences as specified in ServerSocket.setPerformancePreferences(int, int, int).

  Specified by:

  setPerformancePreferences in interface ServerSocketChannelConfig

  Overrides:

  setPerformancePreferences in class EpollServerChannelConfig

• setBacklog

  public EpollServerSocketChannelConfig setBacklog(int backlog)

  Description copied from interface: ServerSocketChannelConfig

  Sets the backlog value to specify when the channel binds to a local address.

  Specified by:

  setBacklog in interface ServerSocketChannelConfig

  Overrides:

  setBacklog in class EpollServerChannelConfig

• setConnectTimeoutMillis

  public EpollServerSocketChannelConfig 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

  Specified by:

  setConnectTimeoutMillis in interface ServerSocketChannelConfig

  Overrides:

  setConnectTimeoutMillis in class EpollServerChannelConfig

  Parameters:

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

• setMaxMessagesPerRead

  @Deprecated public EpollServerSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

  Deprecated.

  Description copied from class: DefaultChannelConfig

  Specified by:

  setMaxMessagesPerRead in interface ChannelConfig

  Specified by:

  setMaxMessagesPerRead in interface ServerSocketChannelConfig

  Overrides:

  setMaxMessagesPerRead in class EpollServerChannelConfig

• setWriteSpinCount

  public EpollServerSocketChannelConfig 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

  Specified by:

  setWriteSpinCount in interface ServerSocketChannelConfig

  Overrides:

  setWriteSpinCount in class EpollServerChannelConfig

• setAllocator

  public EpollServerSocketChannelConfig 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

  Specified by:

  setAllocator in interface ServerSocketChannelConfig

  Overrides:

  setAllocator in class EpollServerChannelConfig

• setRecvByteBufAllocator

  public EpollServerSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

  Description copied from interface: ChannelConfig

  Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.

  Specified by:

  setRecvByteBufAllocator in interface ChannelConfig

  Specified by:

  setRecvByteBufAllocator in interface ServerSocketChannelConfig

  Overrides:

  setRecvByteBufAllocator in class EpollServerChannelConfig

• setAutoRead

  public EpollServerSocketChannelConfig 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

  Specified by:

  setAutoRead in interface ServerSocketChannelConfig

  Overrides:

  setAutoRead in class EpollServerChannelConfig

• setWriteBufferHighWaterMark

  @Deprecated public EpollServerSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

  Deprecated.

  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

  Specified by:

  setWriteBufferHighWaterMark in interface ServerSocketChannelConfig

  Overrides:

  setWriteBufferHighWaterMark in class EpollServerChannelConfig

• setWriteBufferLowWaterMark

  @Deprecated public EpollServerSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

  Deprecated.

  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

  Specified by:

  setWriteBufferLowWaterMark in interface ServerSocketChannelConfig

  Overrides:

  setWriteBufferLowWaterMark in class EpollServerChannelConfig

• setWriteBufferWaterMark

  public EpollServerSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

  Description copied from interface: ChannelConfig

  Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.

  Specified by:

  setWriteBufferWaterMark in interface ChannelConfig

  Specified by:

  setWriteBufferWaterMark in interface ServerSocketChannelConfig

  Overrides:

  setWriteBufferWaterMark in class EpollServerChannelConfig

• setMessageSizeEstimator

  public EpollServerSocketChannelConfig 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

  Specified by:

  setMessageSizeEstimator in interface 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 Channel.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.