Class DefaultSocketChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.socket.DefaultSocketChannelConfig

All Implemented Interfaces:

ChannelConfig, DuplexChannelConfig, SocketChannelConfig

Direct Known Subclasses:

DefaultOioSocketChannelConfig

public class DefaultSocketChannelConfig
extends DefaultChannelConfig
implements SocketChannelConfig

The default SocketChannelConfig implementation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Socket	javaSocket

Fields inherited from class DefaultChannelConfig

channel

Constructor Summary

Constructors

Constructor	Description
DefaultSocketChannelConfig(SocketChannel channel, Socket javaSocket)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
<T> T	getOption(ChannelOption<T> option)	Return the value of the given ChannelOption
Map<ChannelOption<?>, Object>	getOptions()	Return all set ChannelOption's.
int	getReceiveBufferSize()	Gets the StandardSocketOptions.SO_RCVBUF option.
int	getSendBufferSize()	Gets the StandardSocketOptions.SO_SNDBUF option.
int	getSoLinger()	Gets the StandardSocketOptions.SO_LINGER option.
int	getTrafficClass()	Gets the StandardSocketOptions.IP_TOS option.
boolean	isAllowHalfClosure()	Returns true if and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
boolean	isKeepAlive()	Gets the StandardSocketOptions.SO_KEEPALIVE option.
boolean	isReuseAddress()	Gets the StandardSocketOptions.SO_REUSEADDR option.
boolean	isTcpNoDelay()	Gets the StandardSocketOptions.TCP_NODELAY option.
SocketChannelConfig	setAllocator(ByteBufAllocator allocator)	Set the ByteBufAllocator which is used for the channel to allocate buffers.
SocketChannelConfig	setAllowHalfClosure(boolean allowHalfClosure)	Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
SocketChannelConfig	setAutoClose(boolean autoClose)	Sets whether the Channel should be closed automatically and immediately on write failure.
SocketChannelConfig	setAutoRead(boolean autoRead)	Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
SocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis)	Sets the connect timeout of the channel in milliseconds.
SocketChannelConfig	setKeepAlive(boolean keepAlive)	Sets the StandardSocketOptions.SO_KEEPALIVE option.
SocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead)	Deprecated.
SocketChannelConfig	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.
SocketChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth)	Sets the performance preferences as specified in Socket.setPerformancePreferences(int, int, int).
SocketChannelConfig	setReceiveBufferSize(int receiveBufferSize)	Sets the StandardSocketOptions.SO_RCVBUF option.
SocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator)	Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
SocketChannelConfig	setReuseAddress(boolean reuseAddress)	Sets the StandardSocketOptions.SO_REUSEADDR option.
SocketChannelConfig	setSendBufferSize(int sendBufferSize)	Sets the StandardSocketOptions.SO_SNDBUF option.
SocketChannelConfig	setSoLinger(int soLinger)	Sets the StandardSocketOptions.SO_LINGER option.
SocketChannelConfig	setTcpNoDelay(boolean tcpNoDelay)	Sets the StandardSocketOptions.TCP_NODELAY option.
SocketChannelConfig	setTrafficClass(int trafficClass)	Sets the StandardSocketOptions.IP_TOS option.
SocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark)	Sets the high water mark of the write buffer.
SocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark)	Sets the low water mark of the write buffer.
SocketChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)	Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
SocketChannelConfig	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 DefaultChannelConfig

autoReadCleared, getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setMaxMessagesPerWrite, setOptions, validate

Methods inherited from class Object

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

Methods inherited from interface ChannelConfig

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

Field Details

javaSocket

protected final Socket javaSocket

Constructor Details

DefaultSocketChannelConfig

public DefaultSocketChannelConfig(SocketChannel channel,
 Socket javaSocket)

Creates a new instance.

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

getReceiveBufferSize

public int getReceiveBufferSize()

Description copied from interface: SocketChannelConfig

Gets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

getReceiveBufferSize in interface SocketChannelConfig

getSendBufferSize

public int getSendBufferSize()

Description copied from interface: SocketChannelConfig

Gets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

getSendBufferSize in interface SocketChannelConfig

getSoLinger

public int getSoLinger()

Description copied from interface: SocketChannelConfig

Gets the StandardSocketOptions.SO_LINGER option.

Specified by:

getSoLinger in interface SocketChannelConfig

getTrafficClass

public int getTrafficClass()

Description copied from interface: SocketChannelConfig

Gets the StandardSocketOptions.IP_TOS option.

Specified by:

getTrafficClass in interface SocketChannelConfig

isKeepAlive

public boolean isKeepAlive()

Description copied from interface: SocketChannelConfig

Gets the StandardSocketOptions.SO_KEEPALIVE option.

Specified by:

isKeepAlive in interface SocketChannelConfig

isReuseAddress

public boolean isReuseAddress()

Description copied from interface: SocketChannelConfig

Gets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

isReuseAddress in interface SocketChannelConfig

isTcpNoDelay

public boolean isTcpNoDelay()

Description copied from interface: SocketChannelConfig

Gets 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:

isTcpNoDelay in interface SocketChannelConfig

setKeepAlive

public SocketChannelConfig setKeepAlive(boolean keepAlive)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_KEEPALIVE option.

Specified by:

setKeepAlive in interface SocketChannelConfig

setPerformancePreferences

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

setReceiveBufferSize

public SocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

setReceiveBufferSize in interface SocketChannelConfig

setReuseAddress

public SocketChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface SocketChannelConfig

setSendBufferSize

public SocketChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

setSendBufferSize in interface SocketChannelConfig

setSoLinger

public SocketChannelConfig setSoLinger(int soLinger)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.SO_LINGER option.

Specified by:

setSoLinger in interface SocketChannelConfig

setTcpNoDelay

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

setTrafficClass

public SocketChannelConfig setTrafficClass(int trafficClass)

Description copied from interface: SocketChannelConfig

Sets the StandardSocketOptions.IP_TOS option.

Specified by:

setTrafficClass in interface SocketChannelConfig

isAllowHalfClosure

public boolean isAllowHalfClosure()

Description copied from interface: DuplexChannelConfig

Returns true if and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If false, the connection is closed automatically when the remote peer shuts down output.

Specified by:

isAllowHalfClosure in interface DuplexChannelConfig

setAllowHalfClosure

public SocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)

Description copied from interface: DuplexChannelConfig

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 DuplexChannelConfig

Specified by:

setAllowHalfClosure in interface SocketChannelConfig

setConnectTimeoutMillis

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

Overrides:

setConnectTimeoutMillis in class DefaultChannelConfig

Parameters:

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

setMaxMessagesPerRead

@Deprecated
public SocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Description copied from class: DefaultChannelConfig

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface DuplexChannelConfig

Specified by:

setMaxMessagesPerRead in interface SocketChannelConfig

Overrides:

setMaxMessagesPerRead in class DefaultChannelConfig

setWriteSpinCount

public SocketChannelConfig 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 DuplexChannelConfig

Specified by:

setWriteSpinCount in interface SocketChannelConfig

Overrides:

setWriteSpinCount in class DefaultChannelConfig

setAllocator

public SocketChannelConfig 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 DuplexChannelConfig

Specified by:

setAllocator in interface SocketChannelConfig

Overrides:

setAllocator in class DefaultChannelConfig

setRecvByteBufAllocator

public SocketChannelConfig 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 DuplexChannelConfig

Specified by:

setRecvByteBufAllocator in interface SocketChannelConfig

Overrides:

setRecvByteBufAllocator in class DefaultChannelConfig

setAutoRead

public SocketChannelConfig 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 DuplexChannelConfig

Specified by:

setAutoRead in interface SocketChannelConfig

Overrides:

setAutoRead in class DefaultChannelConfig

setAutoClose

public SocketChannelConfig setAutoClose(boolean autoClose)

Description copied from interface: ChannelConfig

Sets whether the Channel should be closed automatically and immediately on write failure. The default is true.

Specified by:

setAutoClose in interface ChannelConfig

Specified by:

setAutoClose in interface DuplexChannelConfig

Specified by:

setAutoClose in interface SocketChannelConfig

Overrides:

setAutoClose in class DefaultChannelConfig

setWriteBufferHighWaterMark

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

setWriteBufferWaterMark

public SocketChannelConfig 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 DuplexChannelConfig

Specified by:

setWriteBufferWaterMark in interface SocketChannelConfig

Overrides:

setWriteBufferWaterMark in class DefaultChannelConfig

setMessageSizeEstimator

public SocketChannelConfig 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 DuplexChannelConfig

Specified by:

setMessageSizeEstimator in interface SocketChannelConfig

Overrides:

setMessageSizeEstimator in class DefaultChannelConfig