io.netty.channel.sctp

Interface SctpChannelConfig

All Superinterfaces:

ChannelConfig

All Known Implementing Classes:

DefaultSctpChannelConfig

public interface SctpChannelConfig
extends ChannelConfig

A ChannelConfig for a SctpChannel.

Available options

In addition to the options provided by ChannelConfig, SctpChannelConfig allows the following options in the option map:

Name	Associated setter method
ChannelOption.SO_RCVBUF	setReceiveBufferSize(int)
ChannelOption.SO_SNDBUF	setSendBufferSize(int)
SctpChannelOption.SCTP_NODELAY	setSctpNoDelay(boolean)}
SctpChannelOption.SCTP_INIT_MAXSTREAMS	#setInitMaxStreams(InitMaxStreams)

Method Summary

Methods

Modifier and Type	Method and Description
com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams	getInitMaxStreams() Gets the SCTP_INIT_MAXSTREAMS option.
int	getReceiveBufferSize() Gets the SO_RCVBUF option.
int	getSendBufferSize() Gets the SO_SNDBUF option.
boolean	isSctpNoDelay() Gets the SCTP_NODELAY option.
SctpChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
SctpChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
SctpChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
SctpChannelConfig	setInitMaxStreams(com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams initMaxStreams) Gets the SCTP_INIT_MAXSTREAMS option.
SctpChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Sets the maximum number of messages to read per read loop.
SctpChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Set the ByteBufAllocator which is used for the channel to detect the size of a message.
SctpChannelConfig	setReceiveBufferSize(int receiveBufferSize) Gets the SO_RCVBUF option.
SctpChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
SctpChannelConfig	setSctpNoDelay(boolean sctpNoDelay) Sets the SCTP_NODELAY option.
SctpChannelConfig	setSendBufferSize(int sendBufferSize) Sets the SO_SNDBUF option.
SctpChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
SctpChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
SctpChannelConfig	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.ChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoRead, setOption, setOptions

Method Detail

isSctpNoDelay

boolean isSctpNoDelay()

Gets the SCTP_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.

setSctpNoDelay

SctpChannelConfig setSctpNoDelay(boolean sctpNoDelay)

Sets the SCTP_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.

getSendBufferSize

int getSendBufferSize()

Gets the SO_SNDBUF option.

setSendBufferSize

SctpChannelConfig setSendBufferSize(int sendBufferSize)

Sets the SO_SNDBUF option.

getReceiveBufferSize

int getReceiveBufferSize()

Gets the SO_RCVBUF option.

setReceiveBufferSize

SctpChannelConfig setReceiveBufferSize(int receiveBufferSize)

Gets the SO_RCVBUF option.

getInitMaxStreams

com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams getInitMaxStreams()

Gets the SCTP_INIT_MAXSTREAMS option.

setInitMaxStreams

SctpChannelConfig setInitMaxStreams(com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams initMaxStreams)

Gets the SCTP_INIT_MAXSTREAMS option.

setConnectTimeoutMillis

SctpChannelConfig 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

SctpChannelConfig 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

setWriteSpinCount

SctpChannelConfig 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

setAllocator

SctpChannelConfig 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

setRecvByteBufAllocator

SctpChannelConfig 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

setAutoRead

SctpChannelConfig 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

setWriteBufferHighWaterMark

SctpChannelConfig 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

setWriteBufferLowWaterMark

SctpChannelConfig 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

setMessageSizeEstimator

SctpChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Description copied from interface: ChannelConfig

Set the ByteBufAllocator which is used for the channel to detect the size of a message.

Specified by:

setMessageSizeEstimator in interface ChannelConfig