Package io.netty.channel.sctp
Interface SctpChannelConfig
-
- All Superinterfaces:
ChannelConfig
- All Known Implementing Classes:
DefaultSctpChannelConfig
public interface SctpChannelConfig extends ChannelConfig
AChannelConfig
for aSctpChannel
.Available options
In addition to the options provided byChannelConfig
,SctpChannelConfig
allows the following options in the option map:
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams
getInitMaxStreams()
Gets theSCTP_INIT_MAXSTREAMS
option.int
getReceiveBufferSize()
Gets theSO_RCVBUF
option.int
getSendBufferSize()
Gets theSO_SNDBUF
option.boolean
isSctpNoDelay()
Gets theSCTP_NODELAY
option.SctpChannelConfig
setAllocator(ByteBufAllocator allocator)
Set theByteBufAllocator
which is used for the channel to allocate buffers.SctpChannelConfig
setAutoClose(boolean autoClose)
Sets whether theChannel
should be closed automatically and immediately on write failure.SctpChannelConfig
setAutoRead(boolean autoRead)
Sets ifChannelHandlerContext.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 theSCTP_INIT_MAXSTREAMS
option.SctpChannelConfig
setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.SctpChannelConfig
setMessageSizeEstimator(MessageSizeEstimator estimator)
Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.SctpChannelConfig
setReceiveBufferSize(int receiveBufferSize)
Gets theSO_RCVBUF
option.SctpChannelConfig
setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.SctpChannelConfig
setSctpNoDelay(boolean sctpNoDelay)
Sets theSCTP_NODELAY
option.SctpChannelConfig
setSendBufferSize(int sendBufferSize)
Sets theSO_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 theWriteBufferWaterMark
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 untilWritableByteChannel.write(ByteBuffer)
returns a non-zero value.-
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 theSCTP_NODELAY
option. Please note that the default value of this option istrue
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 befalse
.
-
setSctpNoDelay
SctpChannelConfig setSctpNoDelay(boolean sctpNoDelay)
Sets theSCTP_NODELAY
option. Please note that the default value of this option istrue
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 befalse
.
-
getSendBufferSize
int getSendBufferSize()
Gets theSO_SNDBUF
option.
-
setSendBufferSize
SctpChannelConfig setSendBufferSize(int sendBufferSize)
Sets theSO_SNDBUF
option.
-
getReceiveBufferSize
int getReceiveBufferSize()
Gets theSO_RCVBUF
option.
-
setReceiveBufferSize
SctpChannelConfig setReceiveBufferSize(int receiveBufferSize)
Gets theSO_RCVBUF
option.
-
getInitMaxStreams
com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams getInitMaxStreams()
Gets theSCTP_INIT_MAXSTREAMS
option.
-
setInitMaxStreams
SctpChannelConfig setInitMaxStreams(com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams initMaxStreams)
Gets theSCTP_INIT_MAXSTREAMS
option.
-
setConnectTimeoutMillis
SctpChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
Description copied from interface:ChannelConfig
Sets the connect timeout of the channel in milliseconds. If theChannel
does not support connect operation, this property is not used at all, and therefore will be ignored.- Specified by:
setConnectTimeoutMillis
in interfaceChannelConfig
- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
setMaxMessagesPerRead
@Deprecated SctpChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
-
setWriteSpinCount
SctpChannelConfig setWriteSpinCount(int writeSpinCount)
Description copied from interface:ChannelConfig
Sets the maximum loop count for a write operation untilWritableByteChannel.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 is16
.- Specified by:
setWriteSpinCount
in interfaceChannelConfig
-
setAllocator
SctpChannelConfig setAllocator(ByteBufAllocator allocator)
Description copied from interface:ChannelConfig
Set theByteBufAllocator
which is used for the channel to allocate buffers.- Specified by:
setAllocator
in interfaceChannelConfig
-
setRecvByteBufAllocator
SctpChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Description copied from interface:ChannelConfig
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocator
in interfaceChannelConfig
-
setAutoRead
SctpChannelConfig setAutoRead(boolean autoRead)
Description copied from interface:ChannelConfig
Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all. The default value istrue
.- Specified by:
setAutoRead
in interfaceChannelConfig
-
setAutoClose
SctpChannelConfig setAutoClose(boolean autoClose)
Description copied from interface:ChannelConfig
Sets whether theChannel
should be closed automatically and immediately on write failure. The default istrue
.- Specified by:
setAutoClose
in interfaceChannelConfig
-
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 returnfalse
.- Specified by:
setWriteBufferHighWaterMark
in interfaceChannelConfig
-
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 returntrue
again.- Specified by:
setWriteBufferLowWaterMark
in interfaceChannelConfig
-
setWriteBufferWaterMark
SctpChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Description copied from interface:ChannelConfig
Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.- Specified by:
setWriteBufferWaterMark
in interfaceChannelConfig
-
setMessageSizeEstimator
SctpChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
Description copied from interface:ChannelConfig
Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.- Specified by:
setMessageSizeEstimator
in interfaceChannelConfig
-
-