io.netty.channel.socket.oio

Class DefaultOioServerSocketChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.socket.DefaultServerSocketChannelConfig

io.netty.channel.socket.oio.DefaultOioServerSocketChannelConfig

All Implemented Interfaces:

ChannelConfig, OioServerSocketChannelConfig, ServerSocketChannelConfig

public class DefaultOioServerSocketChannelConfig
extends DefaultServerSocketChannelConfig
implements OioServerSocketChannelConfig

Default OioServerSocketChannelConfig implementation

Field Summary

Fields inherited from class io.netty.channel.socket.DefaultServerSocketChannelConfig

javaSocket

Fields inherited from class io.netty.channel.DefaultChannelConfig

channel

Constructor Summary

Constructors

Constructor and Description
DefaultOioServerSocketChannelConfig(ServerSocketChannel channel, java.net.ServerSocket javaSocket) Deprecated.

Method Summary

Modifier and Type	Method and Description
protected void	autoReadCleared() Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.
<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	getSoTimeout() Returns the maximal time a operation on the underlying socket may block.
OioServerSocketChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
OioServerSocketChannelConfig	setAutoClose(boolean autoClose)
OioServerSocketChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
OioServerSocketChannelConfig	setBacklog(int backlog) Sets the backlog value to specify when the channel binds to a local address.
OioServerSocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
OioServerSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Sets the maximum number of messages to read per read loop.
OioServerSocketChannelConfig	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.
OioServerSocketChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets the performance preferences as specified in ServerSocket.setPerformancePreferences(int, int, int).
OioServerSocketChannelConfig	setReceiveBufferSize(int receiveBufferSize) Gets the StandardSocketOptions.SO_SNDBUF option.
OioServerSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
OioServerSocketChannelConfig	setReuseAddress(boolean reuseAddress) Sets the StandardSocketOptions.SO_REUSEADDR option.
OioServerSocketChannelConfig	setSoTimeout(int timeout) Sets the maximal time a operation on the underlying socket may block.
OioServerSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
OioServerSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
OioServerSocketChannelConfig	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.socket.DefaultServerSocketChannelConfig

getBacklog, getReceiveBufferSize, isReuseAddress

Methods inherited from class io.netty.channel.DefaultChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, 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, getWriteSpinCount, isAutoClose, isAutoRead, setOptions

Constructor Detail

DefaultOioServerSocketChannelConfig

@Deprecated
public DefaultOioServerSocketChannelConfig(ServerSocketChannel channel,
                                                       java.net.ServerSocket javaSocket)

Deprecated.

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 DefaultServerSocketChannelConfig

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 DefaultServerSocketChannelConfig

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 DefaultServerSocketChannelConfig

Returns:

true if and only if the property has been set

setSoTimeout

public OioServerSocketChannelConfig setSoTimeout(int timeout)

Description copied from interface: OioServerSocketChannelConfig

Sets the maximal time a operation on the underlying socket may block.

Specified by:

setSoTimeout in interface OioServerSocketChannelConfig

getSoTimeout

public int getSoTimeout()

Description copied from interface: OioServerSocketChannelConfig

Returns the maximal time a operation on the underlying socket may block.

Specified by:

getSoTimeout in interface OioServerSocketChannelConfig

setBacklog

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

Specified by:

setBacklog in interface ServerSocketChannelConfig

Overrides:

setBacklog in class DefaultServerSocketChannelConfig

setReuseAddress

public OioServerSocketChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: ServerSocketChannelConfig

Sets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface OioServerSocketChannelConfig

Specified by:

setReuseAddress in interface ServerSocketChannelConfig

Overrides:

setReuseAddress in class DefaultServerSocketChannelConfig

setReceiveBufferSize

public OioServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: ServerSocketChannelConfig

Gets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

setReceiveBufferSize in interface OioServerSocketChannelConfig

Specified by:

setReceiveBufferSize in interface ServerSocketChannelConfig

Overrides:

setReceiveBufferSize in class DefaultServerSocketChannelConfig

setPerformancePreferences

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

Specified by:

setPerformancePreferences in interface ServerSocketChannelConfig

Overrides:

setPerformancePreferences in class DefaultServerSocketChannelConfig

setConnectTimeoutMillis

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

Specified by:

setConnectTimeoutMillis in interface ServerSocketChannelConfig

Overrides:

setConnectTimeoutMillis in class DefaultServerSocketChannelConfig

Parameters:

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

setMaxMessagesPerRead

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

Specified by:

setMaxMessagesPerRead in interface ServerSocketChannelConfig

Overrides:

setMaxMessagesPerRead in class DefaultServerSocketChannelConfig

setWriteSpinCount

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

Specified by:

setWriteSpinCount in interface ServerSocketChannelConfig

Overrides:

setWriteSpinCount in class DefaultServerSocketChannelConfig

setAllocator

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

Specified by:

setAllocator in interface ServerSocketChannelConfig

Overrides:

setAllocator in class DefaultServerSocketChannelConfig

setRecvByteBufAllocator

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

Specified by:

setRecvByteBufAllocator in interface ServerSocketChannelConfig

Overrides:

setRecvByteBufAllocator in class DefaultServerSocketChannelConfig

setAutoRead

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

Specified by:

setAutoRead in interface ServerSocketChannelConfig

Overrides:

setAutoRead in class DefaultServerSocketChannelConfig

autoReadCleared

protected void autoReadCleared()

Description copied from class: DefaultChannelConfig

Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.

Overrides:

autoReadCleared in class DefaultChannelConfig

setAutoClose

public OioServerSocketChannelConfig setAutoClose(boolean autoClose)

Specified by:

setAutoClose in interface ChannelConfig

Specified by:

setAutoClose in interface OioServerSocketChannelConfig

Overrides:

setAutoClose in class DefaultChannelConfig

setWriteBufferHighWaterMark

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

Specified by:

setWriteBufferHighWaterMark in interface OioServerSocketChannelConfig

Overrides:

setWriteBufferHighWaterMark in class DefaultServerSocketChannelConfig

setWriteBufferLowWaterMark

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

Specified by:

setWriteBufferLowWaterMark in interface OioServerSocketChannelConfig

Overrides:

setWriteBufferLowWaterMark in class DefaultServerSocketChannelConfig

setMessageSizeEstimator

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

Specified by:

setMessageSizeEstimator in interface ServerSocketChannelConfig

Overrides:

setMessageSizeEstimator in class DefaultServerSocketChannelConfig