io.netty.channel.socket

Interface SocketChannelConfig

All Superinterfaces:

ChannelConfig, DuplexChannelConfig

All Known Subinterfaces:

OioSocketChannelConfig

All Known Implementing Classes:

DefaultOioSocketChannelConfig, DefaultSocketChannelConfig, EpollSocketChannelConfig, KQueueSocketChannelConfig

public interface SocketChannelConfig
extends DuplexChannelConfig

A ChannelConfig for a SocketChannel.

Available options

In addition to the options provided by DuplexChannelConfig, SocketChannelConfig allows the following options in the option map:

Name	Associated setter method
ChannelOption.SO_KEEPALIVE	setKeepAlive(boolean)
ChannelOption.SO_REUSEADDR	setReuseAddress(boolean)
ChannelOption.SO_LINGER	setSoLinger(int)
ChannelOption.TCP_NODELAY	setTcpNoDelay(boolean)
ChannelOption.SO_RCVBUF	setReceiveBufferSize(int)
ChannelOption.SO_SNDBUF	setSendBufferSize(int)
ChannelOption.IP_TOS	setTrafficClass(int)
ChannelOption.ALLOW_HALF_CLOSURE	setAllowHalfClosure(boolean)

Method Summary

Modifier and Type	Method and Description
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	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.
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	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 interface io.netty.channel.socket.DuplexChannelConfig

isAllowHalfClosure

Methods inherited from interface io.netty.channel.ChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOption, setOptions, setWriteBufferHighWaterMark, setWriteBufferLowWaterMark

Method Detail

isTcpNoDelay

boolean isTcpNoDelay()

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.

setTcpNoDelay

SocketChannelConfig setTcpNoDelay(boolean tcpNoDelay)

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.

getSoLinger

int getSoLinger()

Gets the StandardSocketOptions.SO_LINGER option.

setSoLinger

SocketChannelConfig setSoLinger(int soLinger)

Sets the StandardSocketOptions.SO_LINGER option.

getSendBufferSize

int getSendBufferSize()

Gets the StandardSocketOptions.SO_SNDBUF option.

setSendBufferSize

SocketChannelConfig setSendBufferSize(int sendBufferSize)

Sets the StandardSocketOptions.SO_SNDBUF option.

getReceiveBufferSize

int getReceiveBufferSize()

Gets the StandardSocketOptions.SO_RCVBUF option.

setReceiveBufferSize

SocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

Sets the StandardSocketOptions.SO_RCVBUF option.

isKeepAlive

boolean isKeepAlive()

Gets the StandardSocketOptions.SO_KEEPALIVE option.

setKeepAlive

SocketChannelConfig setKeepAlive(boolean keepAlive)

Sets the StandardSocketOptions.SO_KEEPALIVE option.

getTrafficClass

int getTrafficClass()

Gets the StandardSocketOptions.IP_TOS option.

setTrafficClass

SocketChannelConfig setTrafficClass(int trafficClass)

Sets the StandardSocketOptions.IP_TOS option.

isReuseAddress

boolean isReuseAddress()

Gets the StandardSocketOptions.SO_REUSEADDR option.

setReuseAddress

SocketChannelConfig setReuseAddress(boolean reuseAddress)

Sets the StandardSocketOptions.SO_REUSEADDR option.

setPerformancePreferences

SocketChannelConfig setPerformancePreferences(int connectionTime,
                                              int latency,
                                              int bandwidth)

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

setAllowHalfClosure

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

setConnectTimeoutMillis

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

Parameters:

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

setMaxMessagesPerRead

@Deprecated
SocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface DuplexChannelConfig

setWriteSpinCount

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

setAllocator

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

setRecvByteBufAllocator

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

setAutoRead

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

setAutoClose

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

setMessageSizeEstimator

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

setWriteBufferWaterMark

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