Interface SctpChannelConfig

Method Summary

Method Details

• 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)

  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 SctpChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

  Deprecated.

  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 RecvByteBufAllocator 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

• setAutoClose

  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

• 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

• setWriteBufferWaterMark

  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

• setMessageSizeEstimator

  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