Interface SctpServerChannelConfig

All Superinterfaces:

ChannelConfig

All Known Implementing Classes:

DefaultSctpServerChannelConfig

public interface SctpServerChannelConfig
extends ChannelConfig

A ChannelConfig for a SctpServerChannelConfig.

Available options

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

Name	Associated setter method
ChannelOption.SO_BACKLOG	setBacklog(int)
ChannelOption.SO_RCVBUF	setReceiveBufferSize(int)
ChannelOption.SO_SNDBUF	setSendBufferSize(int)
SctpChannelOption.SCTP_INIT_MAXSTREAMS	setInitMaxStreams(InitMaxStreams)

Method Summary

Modifier and Type	Method	Description
int	getBacklog()	Gets the backlog value to specify when the channel binds to a local address.
SctpStandardSocketOptions.InitMaxStreams	getInitMaxStreams()	Gets the SCTP_INIT_MAXSTREAMS option.
int	getReceiveBufferSize()	Gets the SO_RCVBUF option.
int	getSendBufferSize()	Gets the SO_SNDBUF option.
SctpServerChannelConfig	setAllocator(ByteBufAllocator allocator)	Set the ByteBufAllocator which is used for the channel to allocate buffers.
SctpServerChannelConfig	setAutoClose(boolean autoClose)	Sets whether the Channel should be closed automatically and immediately on write failure.
SctpServerChannelConfig	setAutoRead(boolean autoRead)	Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
SctpServerChannelConfig	setBacklog(int backlog)	Sets the backlog value to specify when the channel binds to a local address.
SctpServerChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis)	Sets the connect timeout of the channel in milliseconds.
SctpServerChannelConfig	setInitMaxStreams(SctpStandardSocketOptions.InitMaxStreams initMaxStreams)	Gets the SCTP_INIT_MAXSTREAMS option.
SctpServerChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead)	Deprecated.
SctpServerChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator)	Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
SctpServerChannelConfig	setReceiveBufferSize(int receiveBufferSize)	Gets the SO_RCVBUF option.
SctpServerChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator)	Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
SctpServerChannelConfig	setSendBufferSize(int sendBufferSize)	Sets the SO_SNDBUF option.
SctpServerChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark)	Sets the high water mark of the write buffer.
SctpServerChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark)	Sets the low water mark of the write buffer.
SctpServerChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)	Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
SctpServerChannelConfig	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 ChannelConfig

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

Method Details

getBacklog

int getBacklog()

Gets the backlog value to specify when the channel binds to a local address.

setBacklog

SctpServerChannelConfig setBacklog(int backlog)

Sets the backlog value to specify when the channel binds to a local address.

getSendBufferSize

int getSendBufferSize()

Gets the SO_SNDBUF option.

setSendBufferSize

SctpServerChannelConfig setSendBufferSize(int sendBufferSize)

Sets the SO_SNDBUF option.

getReceiveBufferSize

int getReceiveBufferSize()

Gets the SO_RCVBUF option.

setReceiveBufferSize

SctpServerChannelConfig setReceiveBufferSize(int receiveBufferSize)

Gets the SO_RCVBUF option.

getInitMaxStreams

SctpStandardSocketOptions.InitMaxStreams getInitMaxStreams()

Gets the SCTP_INIT_MAXSTREAMS option.

setInitMaxStreams

SctpServerChannelConfig setInitMaxStreams(SctpStandardSocketOptions.InitMaxStreams initMaxStreams)

Gets the SCTP_INIT_MAXSTREAMS option.

setMaxMessagesPerRead

@Deprecated
SctpServerChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

setWriteSpinCount

SctpServerChannelConfig 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

setConnectTimeoutMillis

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

setAllocator

SctpServerChannelConfig 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

SctpServerChannelConfig 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

setAutoRead

SctpServerChannelConfig 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

setAutoClose

SctpServerChannelConfig 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

setWriteBufferHighWaterMark

SctpServerChannelConfig 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

SctpServerChannelConfig 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

setWriteBufferWaterMark

SctpServerChannelConfig 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

setMessageSizeEstimator

SctpServerChannelConfig 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