io.netty.channel.sctp

Interface SctpChannelConfig

All Superinterfaces:

io.netty.channel.ChannelConfig

All Known Implementing Classes:

DefaultSctpChannelConfig

public interface SctpChannelConfig
extends io.netty.channel.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

Modifier and Type	Method and Description
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(io.netty.buffer.ByteBufAllocator allocator)
SctpChannelConfig	setAutoClose(boolean autoClose)
SctpChannelConfig	setAutoRead(boolean autoRead)
SctpChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis)
SctpChannelConfig	setInitMaxStreams(SctpStandardSocketOptions.InitMaxStreams initMaxStreams) Gets the SCTP_INIT_MAXSTREAMS option.
SctpChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Deprecated.
SctpChannelConfig	setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)
SctpChannelConfig	setReceiveBufferSize(int receiveBufferSize) Gets the SO_RCVBUF option.
SctpChannelConfig	setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)
SctpChannelConfig	setSctpNoDelay(boolean sctpNoDelay) Sets the SCTP_NODELAY option.
SctpChannelConfig	setSendBufferSize(int sendBufferSize) Sets the SO_SNDBUF option.
SctpChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
SctpChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
SctpChannelConfig	setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)
SctpChannelConfig	setWriteSpinCount(int writeSpinCount)

Methods inherited from interface io.netty.channel.ChannelConfig

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

SctpStandardSocketOptions.InitMaxStreams getInitMaxStreams()

Gets the SCTP_INIT_MAXSTREAMS option.

setInitMaxStreams

SctpChannelConfig setInitMaxStreams(SctpStandardSocketOptions.InitMaxStreams initMaxStreams)

Gets the SCTP_INIT_MAXSTREAMS option.

setConnectTimeoutMillis

SctpChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Specified by:

setConnectTimeoutMillis in interface io.netty.channel.ChannelConfig

setMaxMessagesPerRead

@Deprecated
SctpChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Specified by:

setMaxMessagesPerRead in interface io.netty.channel.ChannelConfig

setWriteSpinCount

SctpChannelConfig setWriteSpinCount(int writeSpinCount)

Specified by:

setWriteSpinCount in interface io.netty.channel.ChannelConfig

setAllocator

SctpChannelConfig setAllocator(io.netty.buffer.ByteBufAllocator allocator)

Specified by:

setAllocator in interface io.netty.channel.ChannelConfig

setRecvByteBufAllocator

SctpChannelConfig setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)

Specified by:

setRecvByteBufAllocator in interface io.netty.channel.ChannelConfig

setAutoRead

SctpChannelConfig setAutoRead(boolean autoRead)

Specified by:

setAutoRead in interface io.netty.channel.ChannelConfig

setAutoClose

SctpChannelConfig setAutoClose(boolean autoClose)

Specified by:

setAutoClose in interface io.netty.channel.ChannelConfig

setWriteBufferHighWaterMark

SctpChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Specified by:

setWriteBufferHighWaterMark in interface io.netty.channel.ChannelConfig

setWriteBufferLowWaterMark

SctpChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Specified by:

setWriteBufferLowWaterMark in interface io.netty.channel.ChannelConfig

setWriteBufferWaterMark

SctpChannelConfig setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)

Specified by:

setWriteBufferWaterMark in interface io.netty.channel.ChannelConfig

setMessageSizeEstimator

SctpChannelConfig setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)

Specified by:

setMessageSizeEstimator in interface io.netty.channel.ChannelConfig