Package 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 defaultSctpChannelConfig
implementation for SCTP.
-
-
Field Summary
-
Fields inherited from class io.netty.channel.DefaultChannelConfig
channel
-
-
Constructor Summary
Constructors Constructor Description DefaultSctpChannelConfig(SctpChannel channel, com.sun.nio.sctp.SctpChannel javaChannel)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams
getInitMaxStreams()
Gets theSCTP_INIT_MAXSTREAMS
option.<T> T
getOption(ChannelOption<T> option)
Return the value of the givenChannelOption
java.util.Map<ChannelOption<?>,java.lang.Object>
getOptions()
Return all setChannelOption
's.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.<T> boolean
setOption(ChannelOption<T> option, T value)
Sets a configuration property with the specified name and value.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 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 java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
Description copied from interface:ChannelConfig
Return all setChannelOption
's.- Specified by:
getOptions
in interfaceChannelConfig
- Overrides:
getOptions
in classDefaultChannelConfig
-
getOption
public <T> T getOption(ChannelOption<T> option)
Description copied from interface:ChannelConfig
Return the value of the givenChannelOption
- Specified by:
getOption
in interfaceChannelConfig
- Overrides:
getOption
in classDefaultChannelConfig
-
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 interfaceChannelConfig
- Overrides:
setOption
in classDefaultChannelConfig
- Returns:
true
if and only if the property has been set
-
isSctpNoDelay
public boolean isSctpNoDelay()
Description copied from interface:SctpChannelConfig
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
.- Specified by:
isSctpNoDelay
in interfaceSctpChannelConfig
-
setSctpNoDelay
public SctpChannelConfig setSctpNoDelay(boolean sctpNoDelay)
Description copied from interface:SctpChannelConfig
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
.- Specified by:
setSctpNoDelay
in interfaceSctpChannelConfig
-
getSendBufferSize
public int getSendBufferSize()
Description copied from interface:SctpChannelConfig
Gets theSO_SNDBUF
option.- Specified by:
getSendBufferSize
in interfaceSctpChannelConfig
-
setSendBufferSize
public SctpChannelConfig setSendBufferSize(int sendBufferSize)
Description copied from interface:SctpChannelConfig
Sets theSO_SNDBUF
option.- Specified by:
setSendBufferSize
in interfaceSctpChannelConfig
-
getReceiveBufferSize
public int getReceiveBufferSize()
Description copied from interface:SctpChannelConfig
Gets theSO_RCVBUF
option.- Specified by:
getReceiveBufferSize
in interfaceSctpChannelConfig
-
setReceiveBufferSize
public SctpChannelConfig setReceiveBufferSize(int receiveBufferSize)
Description copied from interface:SctpChannelConfig
Gets theSO_RCVBUF
option.- Specified by:
setReceiveBufferSize
in interfaceSctpChannelConfig
-
getInitMaxStreams
public com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams getInitMaxStreams()
Description copied from interface:SctpChannelConfig
Gets theSCTP_INIT_MAXSTREAMS
option.- Specified by:
getInitMaxStreams
in interfaceSctpChannelConfig
-
setInitMaxStreams
public SctpChannelConfig setInitMaxStreams(com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams initMaxStreams)
Description copied from interface:SctpChannelConfig
Gets theSCTP_INIT_MAXSTREAMS
option.- Specified by:
setInitMaxStreams
in interfaceSctpChannelConfig
-
setConnectTimeoutMillis
public 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
- Specified by:
setConnectTimeoutMillis
in interfaceSctpChannelConfig
- Overrides:
setConnectTimeoutMillis
in classDefaultChannelConfig
- 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 interfaceChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceSctpChannelConfig
- Overrides:
setMaxMessagesPerRead
in classDefaultChannelConfig
-
setWriteSpinCount
public 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
- Specified by:
setWriteSpinCount
in interfaceSctpChannelConfig
- Overrides:
setWriteSpinCount
in classDefaultChannelConfig
-
setAllocator
public 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
- Specified by:
setAllocator
in interfaceSctpChannelConfig
- Overrides:
setAllocator
in classDefaultChannelConfig
-
setRecvByteBufAllocator
public 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
- Specified by:
setRecvByteBufAllocator
in interfaceSctpChannelConfig
- Overrides:
setRecvByteBufAllocator
in classDefaultChannelConfig
-
setAutoRead
public 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
- Specified by:
setAutoRead
in interfaceSctpChannelConfig
- Overrides:
setAutoRead
in classDefaultChannelConfig
-
setAutoClose
public 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
- Specified by:
setAutoClose
in interfaceSctpChannelConfig
- Overrides:
setAutoClose
in classDefaultChannelConfig
-
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 returnfalse
.- Specified by:
setWriteBufferHighWaterMark
in interfaceChannelConfig
- Specified by:
setWriteBufferHighWaterMark
in interfaceSctpChannelConfig
- Overrides:
setWriteBufferHighWaterMark
in classDefaultChannelConfig
-
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 returntrue
again.- Specified by:
setWriteBufferLowWaterMark
in interfaceChannelConfig
- Specified by:
setWriteBufferLowWaterMark
in interfaceSctpChannelConfig
- Overrides:
setWriteBufferLowWaterMark
in classDefaultChannelConfig
-
setWriteBufferWaterMark
public 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
- Specified by:
setWriteBufferWaterMark
in interfaceSctpChannelConfig
- Overrides:
setWriteBufferWaterMark
in classDefaultChannelConfig
-
setMessageSizeEstimator
public 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
- Specified by:
setMessageSizeEstimator
in interfaceSctpChannelConfig
- Overrides:
setMessageSizeEstimator
in classDefaultChannelConfig
-
-