io.netty.channel.sctp

Class DefaultSctpChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.sctp.DefaultSctpChannelConfig

All Implemented Interfaces:

ChannelConfig, SctpChannelConfig

public class DefaultSctpChannelConfig
extends DefaultChannelConfig
implements SctpChannelConfig

The default SctpChannelConfig implementation for SCTP.

Field Summary

Fields inherited from class io.netty.channel.DefaultChannelConfig

channel

Constructor Summary

Constructors

Constructor and Description
DefaultSctpChannelConfig(SctpChannel channel, com.sun.nio.sctp.SctpChannel javaChannel)

Method Summary

Modifier and Type	Method and Description
com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams	getInitMaxStreams() Gets the SCTP_INIT_MAXSTREAMS option.
<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 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	setAutoClose(boolean autoClose) Sets whether the Channel should be closed automatically and immediately on write failure.
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) Deprecated.
SctpChannelConfig	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.
SctpChannelConfig	setReceiveBufferSize(int receiveBufferSize) Gets the SO_RCVBUF option.
SctpChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the RecvByteBufAllocator 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	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Set the WriteBufferWaterMark which is used for setting the high and 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 class io.netty.channel.DefaultChannelConfig

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelConfig

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

Constructor Detail

DefaultSctpChannelConfig

public DefaultSctpChannelConfig(SctpChannel channel,
                                com.sun.nio.sctp.SctpChannel javaChannel)

Method Detail

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

isSctpNoDelay

public boolean isSctpNoDelay()

Description copied from interface: SctpChannelConfig

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.

Specified by:

isSctpNoDelay in interface SctpChannelConfig

setSctpNoDelay

public SctpChannelConfig setSctpNoDelay(boolean sctpNoDelay)

Description copied from interface: SctpChannelConfig

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.

Specified by:

setSctpNoDelay in interface SctpChannelConfig

getSendBufferSize

public int getSendBufferSize()

Description copied from interface: SctpChannelConfig

Gets the SO_SNDBUF option.

Specified by:

getSendBufferSize in interface SctpChannelConfig

setSendBufferSize

public SctpChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: SctpChannelConfig

Sets the SO_SNDBUF option.

Specified by:

setSendBufferSize in interface SctpChannelConfig

getReceiveBufferSize

public int getReceiveBufferSize()

Description copied from interface: SctpChannelConfig

Gets the SO_RCVBUF option.

Specified by:

getReceiveBufferSize in interface SctpChannelConfig

setReceiveBufferSize

public SctpChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: SctpChannelConfig

Gets the SO_RCVBUF option.

Specified by:

setReceiveBufferSize in interface SctpChannelConfig

getInitMaxStreams

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

Description copied from interface: SctpChannelConfig

Gets the SCTP_INIT_MAXSTREAMS option.

Specified by:

getInitMaxStreams in interface SctpChannelConfig

setInitMaxStreams

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

Description copied from interface: SctpChannelConfig

Gets the SCTP_INIT_MAXSTREAMS option.

Specified by:

setInitMaxStreams in interface SctpChannelConfig

setConnectTimeoutMillis

public 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

Specified by:

setConnectTimeoutMillis in interface SctpChannelConfig

Overrides:

setConnectTimeoutMillis in class DefaultChannelConfig

Parameters:

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

setMaxMessagesPerRead

@Deprecated
public SctpChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Description copied from class: DefaultChannelConfig

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface SctpChannelConfig

Overrides:

setMaxMessagesPerRead in class DefaultChannelConfig

setWriteSpinCount

public 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

Specified by:

setWriteSpinCount in interface SctpChannelConfig

Overrides:

setWriteSpinCount in class DefaultChannelConfig

setAllocator

public 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

Specified by:

setAllocator in interface SctpChannelConfig

Overrides:

setAllocator in class DefaultChannelConfig

setRecvByteBufAllocator

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

Overrides:

setRecvByteBufAllocator in class DefaultChannelConfig

setAutoRead

public 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

Specified by:

setAutoRead in interface SctpChannelConfig

Overrides:

setAutoRead in class DefaultChannelConfig

setAutoClose

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

Overrides:

setAutoClose in class DefaultChannelConfig

setWriteBufferHighWaterMark

public 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

Specified by:

setWriteBufferHighWaterMark in interface SctpChannelConfig

Overrides:

setWriteBufferHighWaterMark in class DefaultChannelConfig

setWriteBufferLowWaterMark

public 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

Specified by:

setWriteBufferLowWaterMark in interface SctpChannelConfig

Overrides:

setWriteBufferLowWaterMark in class DefaultChannelConfig

setWriteBufferWaterMark

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

Overrides:

setWriteBufferWaterMark in class DefaultChannelConfig

setMessageSizeEstimator

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

Overrides:

setMessageSizeEstimator in class DefaultChannelConfig