Interface SctpServerChannelConfig
- All Superinterfaces:
ChannelConfig
- All Known Implementing Classes:
DefaultSctpServerChannelConfig
A
ChannelConfig for a SctpServerChannelConfig.
Available options
In addition to the options provided byChannelConfig,
SctpServerChannelConfig allows the following options in the
option map:
-
Method Summary
Modifier and TypeMethodDescriptionintGets the backlog value to specify when the channel binds to a local address.Gets theSCTP_INIT_MAXSTREAMSoption.intGets theSO_RCVBUFoption.intGets theSO_SNDBUFoption.setAllocator(ByteBufAllocator allocator) Set theByteBufAllocatorwhich is used for the channel to allocate buffers.setAutoClose(boolean autoClose) Sets whether theChannelshould be closed automatically and immediately on write failure.setAutoRead(boolean autoRead) Sets ifChannelHandlerContext.read()will be invoked automatically so that a user application doesn't need to call it at all.setBacklog(int backlog) Sets the backlog value to specify when the channel binds to a local address.setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.setInitMaxStreams(SctpStandardSocketOptions.InitMaxStreams initMaxStreams) Gets theSCTP_INIT_MAXSTREAMSoption.setMaxMessagesPerRead(int maxMessagesPerRead) Deprecated.setMessageSizeEstimator(MessageSizeEstimator estimator) Set theMessageSizeEstimatorwhich is used for the channel to detect the size of a message.setReceiveBufferSize(int receiveBufferSize) Gets theSO_RCVBUFoption.setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set theRecvByteBufAllocatorwhich is used for the channel to allocate receive buffers.setSendBufferSize(int sendBufferSize) Sets theSO_SNDBUFoption.setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Set theWriteBufferWaterMarkwhich is used for setting the high and low water mark of the write buffer.setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation untilWritableByteChannel.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
Sets the backlog value to specify when the channel binds to a local address. -
getSendBufferSize
int getSendBufferSize()Gets theSO_SNDBUFoption. -
setSendBufferSize
Sets theSO_SNDBUFoption. -
getReceiveBufferSize
int getReceiveBufferSize()Gets theSO_RCVBUFoption. -
setReceiveBufferSize
Gets theSO_RCVBUFoption. -
getInitMaxStreams
SctpStandardSocketOptions.InitMaxStreams getInitMaxStreams()Gets theSCTP_INIT_MAXSTREAMSoption. -
setInitMaxStreams
Gets theSCTP_INIT_MAXSTREAMSoption. -
setMaxMessagesPerRead
Deprecated.- Specified by:
setMaxMessagesPerReadin interfaceChannelConfig
-
setWriteSpinCount
Description copied from interface:ChannelConfigSets 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:
setWriteSpinCountin interfaceChannelConfig
-
setConnectTimeoutMillis
Description copied from interface:ChannelConfigSets the connect timeout of the channel in milliseconds. If theChanneldoes not support connect operation, this property is not used at all, and therefore will be ignored.- Specified by:
setConnectTimeoutMillisin interfaceChannelConfig- Parameters:
connectTimeoutMillis- the connect timeout in milliseconds.0to disable.
-
setAllocator
Description copied from interface:ChannelConfigSet theByteBufAllocatorwhich is used for the channel to allocate buffers.- Specified by:
setAllocatorin interfaceChannelConfig
-
setRecvByteBufAllocator
Description copied from interface:ChannelConfigSet theRecvByteBufAllocatorwhich is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocatorin interfaceChannelConfig
-
setAutoRead
Description copied from interface:ChannelConfigSets 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:
setAutoReadin interfaceChannelConfig
-
setAutoClose
Description copied from interface:ChannelConfigSets whether theChannelshould be closed automatically and immediately on write failure. The default istrue.- Specified by:
setAutoClosein interfaceChannelConfig
-
setWriteBufferHighWaterMark
Description copied from interface:ChannelConfigSets 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:
setWriteBufferHighWaterMarkin interfaceChannelConfig
-
setWriteBufferLowWaterMark
Description copied from interface:ChannelConfigSets 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 returntrueagain.- Specified by:
setWriteBufferLowWaterMarkin interfaceChannelConfig
-
setWriteBufferWaterMark
Description copied from interface:ChannelConfigSet theWriteBufferWaterMarkwhich is used for setting the high and low water mark of the write buffer.- Specified by:
setWriteBufferWaterMarkin interfaceChannelConfig
-
setMessageSizeEstimator
Description copied from interface:ChannelConfigSet theMessageSizeEstimatorwhich is used for the channel to detect the size of a message.- Specified by:
setMessageSizeEstimatorin interfaceChannelConfig
-