All Implemented Interfaces:

ChannelConfig, ServerSocketChannelConfig

Direct Known Subclasses:

DefaultOioServerSocketChannelConfig

public class DefaultServerSocketChannelConfig
extends DefaultChannelConfig
implements ServerSocketChannelConfig 

• Field Summary

  Fields

  Modifier and Type	Field and Description
  protected java.net.ServerSocket	javaSocket

  • Fields inherited from class io.netty.channel.DefaultChannelConfig

    channel

• Constructor Summary

  Constructors

  Constructor and Description
  DefaultServerSocketChannelConfig (ServerSocketChannel channel, java.net.ServerSocket javaSocket) Creates a new instance.

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  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.
  boolean	isReuseAddress () Gets the StandardSocketOptions.SO_REUSEADDR option.
  ServerSocketChannelConfig	setAllocator (ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
  ServerSocketChannelConfig	setAutoRead (boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
  ServerSocketChannelConfig	setBacklog (int backlog) Sets the backlog value to specify when the channel binds to a local address.
  ServerSocketChannelConfig	setConnectTimeoutMillis (int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
  ServerSocketChannelConfig	setMaxMessagesPerRead (int maxMessagesPerRead) Sets the maximum number of messages to read per read loop.
  ServerSocketChannelConfig	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.
  ServerSocketChannelConfig	setPerformancePreferences (int connectionTime, int latency, int bandwidth) Sets the performance preferences as specified in ServerSocket.setPerformancePreferences(int, int, int).
  ServerSocketChannelConfig	setReceiveBufferSize (int receiveBufferSize) Gets the StandardSocketOptions.SO_SNDBUF option.
  ServerSocketChannelConfig	setRecvByteBufAllocator (RecvByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
  ServerSocketChannelConfig	setReuseAddress (boolean reuseAddress) Sets the StandardSocketOptions.SO_REUSEADDR option.
  ServerSocketChannelConfig	setWriteBufferHighWaterMark (int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
  ServerSocketChannelConfig	setWriteBufferLowWaterMark (int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
  ServerSocketChannelConfig	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.DefaultChannelConfig

    autoReadCleared, 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

  • Methods inherited from interface io.netty.channel.ChannelConfig

    getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setAutoClose, setOptions

• Field Detail

  • javaSocket

    protected final java.net.ServerSocket javaSocket

• Constructor Detail

  • DefaultServerSocketChannelConfig

    public DefaultServerSocketChannelConfig(ServerSocketChannel channel,
     java.net.ServerSocket javaSocket)

    Creates a new instance.

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

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

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

    Returns:

    true if and only if the property has been set

  • isReuseAddress

    public boolean isReuseAddress()

    Description copied from interface: ServerSocketChannelConfig
    Gets the StandardSocketOptions.SO_REUSEADDR option.

    Specified by:

    isReuseAddress in interface ServerSocketChannelConfig

  • setReuseAddress

    public ServerSocketChannelConfig setReuseAddress(boolean reuseAddress)

    Description copied from interface: ServerSocketChannelConfig
    Sets the StandardSocketOptions.SO_REUSEADDR option.

    Specified by:

    setReuseAddress in interface ServerSocketChannelConfig

  • getReceiveBufferSize

    public int getReceiveBufferSize()

    Description copied from interface: ServerSocketChannelConfig
    Gets the StandardSocketOptions.SO_RCVBUF option.

    Specified by:

    getReceiveBufferSize in interface ServerSocketChannelConfig

  • setReceiveBufferSize

    public ServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

    Description copied from interface: ServerSocketChannelConfig
    Gets the StandardSocketOptions.SO_SNDBUF option.

    Specified by:

    setReceiveBufferSize in interface ServerSocketChannelConfig

  • setPerformancePreferences

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

  • getBacklog

    public int getBacklog()

    Description copied from interface: ServerSocketChannelConfig
    Gets the backlog value to specify when the channel binds to a local address.

    Specified by:

    getBacklog in interface ServerSocketChannelConfig

  • setBacklog

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

  • setConnectTimeoutMillis

    public ServerSocketChannelConfig 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 DefaultChannelConfig

    Parameters:

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

  • setMaxMessagesPerRead

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

    Specified by:

    setMaxMessagesPerRead in interface ServerSocketChannelConfig

    Overrides:

    setMaxMessagesPerRead in class DefaultChannelConfig

  • setWriteSpinCount

    public ServerSocketChannelConfig 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 DefaultChannelConfig

  • setAllocator

    public ServerSocketChannelConfig 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 DefaultChannelConfig

  • setRecvByteBufAllocator

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

    Specified by:

    setRecvByteBufAllocator in interface ServerSocketChannelConfig

    Overrides:

    setRecvByteBufAllocator in class DefaultChannelConfig

  • setAutoRead

    public ServerSocketChannelConfig 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 DefaultChannelConfig

  • setWriteBufferHighWaterMark

    public ServerSocketChannelConfig 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 DefaultChannelConfig

  • setWriteBufferLowWaterMark

    public ServerSocketChannelConfig 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 DefaultChannelConfig

  • setMessageSizeEstimator

    public ServerSocketChannelConfig 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 DefaultChannelConfig