io.netty.channel.socket.oio

Class DefaultOioSocketChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.socket.DefaultSocketChannelConfig

io.netty.channel.socket.oio.DefaultOioSocketChannelConfig

All Implemented Interfaces:

ChannelConfig, OioSocketChannelConfig, SocketChannelConfig

public class DefaultOioSocketChannelConfig
extends DefaultSocketChannelConfig
implements OioSocketChannelConfig

Default OioSocketChannelConfig implementation

Field Summary

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

javaSocket

Fields inherited from class io.netty.channel.DefaultChannelConfig

channel

Constructor Summary

Constructors

Constructor and Description
DefaultOioSocketChannelConfig(SocketChannel channel, java.net.Socket 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.
OioSocketChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
OioSocketChannelConfig	setAllowHalfClosure(boolean allowHalfClosure) Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
OioSocketChannelConfig	setAutoClose(boolean autoClose)
OioSocketChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
OioSocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
OioSocketChannelConfig	setKeepAlive(boolean keepAlive) Sets the StandardSocketOptions.SO_KEEPALIVE option.
OioSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Sets the maximum number of messages to read per read loop.
OioSocketChannelConfig	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.
OioSocketChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets the performance preferences as specified in Socket.setPerformancePreferences(int, int, int).
OioSocketChannelConfig	setReceiveBufferSize(int receiveBufferSize) Sets the StandardSocketOptions.SO_RCVBUF option.
OioSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
OioSocketChannelConfig	setReuseAddress(boolean reuseAddress) Sets the StandardSocketOptions.SO_REUSEADDR option.
OioSocketChannelConfig	setSendBufferSize(int sendBufferSize) Sets the StandardSocketOptions.SO_SNDBUF option.
OioSocketChannelConfig	setSoLinger(int soLinger) Sets the StandardSocketOptions.SO_LINGER option.
OioSocketChannelConfig	setSoTimeout(int timeout) Sets the maximal time a operation on the underlying socket may block.
OioSocketChannelConfig	setTcpNoDelay(boolean tcpNoDelay) Sets the StandardSocketOptions.TCP_NODELAY option.
OioSocketChannelConfig	setTrafficClass(int trafficClass) Sets the StandardSocketOptions.IP_TOS option.
OioSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
OioSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
OioSocketChannelConfig	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.DefaultSocketChannelConfig

getReceiveBufferSize, getSendBufferSize, getSoLinger, getTrafficClass, isAllowHalfClosure, isKeepAlive, isReuseAddress, isTcpNoDelay

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.SocketChannelConfig

getReceiveBufferSize, getSendBufferSize, getSoLinger, getTrafficClass, isAllowHalfClosure, isKeepAlive, isReuseAddress, isTcpNoDelay

Methods inherited from interface io.netty.channel.ChannelConfig

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

Constructor Detail

DefaultOioSocketChannelConfig

@Deprecated
public DefaultOioSocketChannelConfig(SocketChannel channel,
                                                 java.net.Socket 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 DefaultSocketChannelConfig

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 DefaultSocketChannelConfig

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 DefaultSocketChannelConfig

Returns:

true if and only if the property has been set

setSoTimeout

public OioSocketChannelConfig setSoTimeout(int timeout)

Description copied from interface: OioSocketChannelConfig

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

Specified by:

setSoTimeout in interface OioSocketChannelConfig

getSoTimeout

public int getSoTimeout()

Description copied from interface: OioSocketChannelConfig

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

Specified by:

getSoTimeout in interface OioSocketChannelConfig

setTcpNoDelay

public OioSocketChannelConfig setTcpNoDelay(boolean tcpNoDelay)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.TCP_NODELAY option. Please note that the default value of this option is true unlike the operating system default (false). However, for some buggy platforms, such as Android, that shows erratic behavior with Nagle's algorithm disabled, the default value remains to be false.

Specified by:

setTcpNoDelay in interface OioSocketChannelConfig

Specified by:

setTcpNoDelay in interface SocketChannelConfig

Overrides:

setTcpNoDelay in class DefaultSocketChannelConfig

setSoLinger

public OioSocketChannelConfig setSoLinger(int soLinger)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_LINGER option.

Specified by:

setSoLinger in interface OioSocketChannelConfig

Specified by:

setSoLinger in interface SocketChannelConfig

Overrides:

setSoLinger in class DefaultSocketChannelConfig

setSendBufferSize

public OioSocketChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

setSendBufferSize in interface OioSocketChannelConfig

Specified by:

setSendBufferSize in interface SocketChannelConfig

Overrides:

setSendBufferSize in class DefaultSocketChannelConfig

setReceiveBufferSize

public OioSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

setReceiveBufferSize in interface OioSocketChannelConfig

Specified by:

setReceiveBufferSize in interface SocketChannelConfig

Overrides:

setReceiveBufferSize in class DefaultSocketChannelConfig

setKeepAlive

public OioSocketChannelConfig setKeepAlive(boolean keepAlive)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_KEEPALIVE option.

Specified by:

setKeepAlive in interface OioSocketChannelConfig

Specified by:

setKeepAlive in interface SocketChannelConfig

Overrides:

setKeepAlive in class DefaultSocketChannelConfig

setTrafficClass

public OioSocketChannelConfig setTrafficClass(int trafficClass)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.IP_TOS option.

Specified by:

setTrafficClass in interface OioSocketChannelConfig

Specified by:

setTrafficClass in interface SocketChannelConfig

Overrides:

setTrafficClass in class DefaultSocketChannelConfig

setReuseAddress

public OioSocketChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface OioSocketChannelConfig

Specified by:

setReuseAddress in interface SocketChannelConfig

Overrides:

setReuseAddress in class DefaultSocketChannelConfig

setPerformancePreferences

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

Description copied from interface: SocketChannelConfig

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

Specified by:

setPerformancePreferences in interface OioSocketChannelConfig

Specified by:

setPerformancePreferences in interface SocketChannelConfig

Overrides:

setPerformancePreferences in class DefaultSocketChannelConfig

setAllowHalfClosure

public OioSocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)

Description copied from interface: SocketChannelConfig

Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If true the connection is not closed when the remote peer shuts down output. Instead, ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object) is invoked with a ChannelInputShutdownEvent object. If false, the connection is closed automatically.

Specified by:

setAllowHalfClosure in interface OioSocketChannelConfig

Specified by:

setAllowHalfClosure in interface SocketChannelConfig

Overrides:

setAllowHalfClosure in class DefaultSocketChannelConfig

setConnectTimeoutMillis

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

Specified by:

setConnectTimeoutMillis in interface SocketChannelConfig

Overrides:

setConnectTimeoutMillis in class DefaultSocketChannelConfig

Parameters:

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

setMaxMessagesPerRead

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

Specified by:

setMaxMessagesPerRead in interface SocketChannelConfig

Overrides:

setMaxMessagesPerRead in class DefaultSocketChannelConfig

setWriteSpinCount

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

Specified by:

setWriteSpinCount in interface SocketChannelConfig

Overrides:

setWriteSpinCount in class DefaultSocketChannelConfig

setAllocator

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

Specified by:

setAllocator in interface SocketChannelConfig

Overrides:

setAllocator in class DefaultSocketChannelConfig

setRecvByteBufAllocator

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

Specified by:

setRecvByteBufAllocator in interface SocketChannelConfig

Overrides:

setRecvByteBufAllocator in class DefaultSocketChannelConfig

setAutoRead

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

Specified by:

setAutoRead in interface SocketChannelConfig

Overrides:

setAutoRead in class DefaultSocketChannelConfig

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 OioSocketChannelConfig setAutoClose(boolean autoClose)

Specified by:

setAutoClose in interface ChannelConfig

Specified by:

setAutoClose in interface OioSocketChannelConfig

Specified by:

setAutoClose in interface SocketChannelConfig

Overrides:

setAutoClose in class DefaultSocketChannelConfig

setWriteBufferHighWaterMark

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

Overrides:

setWriteBufferHighWaterMark in class DefaultSocketChannelConfig

setWriteBufferLowWaterMark

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

Overrides:

setWriteBufferLowWaterMark in class DefaultSocketChannelConfig

setMessageSizeEstimator

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

Specified by:

setMessageSizeEstimator in interface SocketChannelConfig

Overrides:

setMessageSizeEstimator in class DefaultSocketChannelConfig