Package io.netty.channel.sctp
Class DefaultSctpServerChannelConfig
java.lang.Object
io.netty.channel.DefaultChannelConfig
io.netty.channel.sctp.DefaultSctpServerChannelConfig
- All Implemented Interfaces:
ChannelConfig
,SctpServerChannelConfig
- Direct Known Subclasses:
NioSctpServerChannel.NioSctpServerChannelConfig
,OioSctpServerChannel.OioSctpServerChannelConfig
public class DefaultSctpServerChannelConfig
extends DefaultChannelConfig
implements SctpServerChannelConfig
The default
SctpServerChannelConfig
implementation for SCTP.-
Field Summary
FieldsFields inherited from class io.netty.channel.DefaultChannelConfig
channel
-
Constructor Summary
ConstructorsConstructorDescriptionDefaultSctpServerChannelConfig
(SctpServerChannel channel, SctpServerChannel javaChannel) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionint
Gets the backlog value to specify when the channel binds to a local address.Gets theSCTP_INIT_MAXSTREAMS
option.<T> T
getOption
(ChannelOption<T> option) Return the value of the givenChannelOption
Map
<ChannelOption<?>, Object> Return all setChannelOption
's.int
Gets theSO_RCVBUF
option.int
Gets theSO_SNDBUF
option.setAllocator
(ByteBufAllocator allocator) Set theByteBufAllocator
which is used for the channel to allocate buffers.setAutoClose
(boolean autoClose) Sets whether theChannel
should 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_MAXSTREAMS
option.setMaxMessagesPerRead
(int maxMessagesPerRead) Deprecated.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.setReceiveBufferSize
(int receiveBufferSize) Gets theSO_RCVBUF
option.setRecvByteBufAllocator
(RecvByteBufAllocator allocator) Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.setSendBufferSize
(int sendBufferSize) Sets theSO_SNDBUF
option.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 theWriteBufferWaterMark
which 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 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
-
Field Details
-
javaChannel
-
backlog
private volatile int backlog
-
-
Constructor Details
-
DefaultSctpServerChannelConfig
Creates a new instance.
-
-
Method Details
-
getOptions
Description copied from interface:ChannelConfig
Return all setChannelOption
's.- Specified by:
getOptions
in interfaceChannelConfig
- Overrides:
getOptions
in classDefaultChannelConfig
-
getOption
Description copied from interface:ChannelConfig
Return the value of the givenChannelOption
- Specified by:
getOption
in interfaceChannelConfig
- Overrides:
getOption
in classDefaultChannelConfig
-
setOption
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
-
getSendBufferSize
public int getSendBufferSize()Description copied from interface:SctpServerChannelConfig
Gets theSO_SNDBUF
option.- Specified by:
getSendBufferSize
in interfaceSctpServerChannelConfig
-
setSendBufferSize
Description copied from interface:SctpServerChannelConfig
Sets theSO_SNDBUF
option.- Specified by:
setSendBufferSize
in interfaceSctpServerChannelConfig
-
getReceiveBufferSize
public int getReceiveBufferSize()Description copied from interface:SctpServerChannelConfig
Gets theSO_RCVBUF
option.- Specified by:
getReceiveBufferSize
in interfaceSctpServerChannelConfig
-
setReceiveBufferSize
Description copied from interface:SctpServerChannelConfig
Gets theSO_RCVBUF
option.- Specified by:
setReceiveBufferSize
in interfaceSctpServerChannelConfig
-
getInitMaxStreams
Description copied from interface:SctpServerChannelConfig
Gets theSCTP_INIT_MAXSTREAMS
option.- Specified by:
getInitMaxStreams
in interfaceSctpServerChannelConfig
-
setInitMaxStreams
public SctpServerChannelConfig setInitMaxStreams(SctpStandardSocketOptions.InitMaxStreams initMaxStreams) Description copied from interface:SctpServerChannelConfig
Gets theSCTP_INIT_MAXSTREAMS
option.- Specified by:
setInitMaxStreams
in interfaceSctpServerChannelConfig
-
getBacklog
public int getBacklog()Description copied from interface:SctpServerChannelConfig
Gets the backlog value to specify when the channel binds to a local address.- Specified by:
getBacklog
in interfaceSctpServerChannelConfig
-
setBacklog
Description copied from interface:SctpServerChannelConfig
Sets the backlog value to specify when the channel binds to a local address.- Specified by:
setBacklog
in interfaceSctpServerChannelConfig
-
setMaxMessagesPerRead
Deprecated.Description copied from class:DefaultChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceSctpServerChannelConfig
- Overrides:
setMaxMessagesPerRead
in classDefaultChannelConfig
-
setWriteSpinCount
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 interfaceSctpServerChannelConfig
- Overrides:
setWriteSpinCount
in classDefaultChannelConfig
-
setConnectTimeoutMillis
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 interfaceSctpServerChannelConfig
- Overrides:
setConnectTimeoutMillis
in classDefaultChannelConfig
- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
setAllocator
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 interfaceSctpServerChannelConfig
- Overrides:
setAllocator
in classDefaultChannelConfig
-
setRecvByteBufAllocator
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 interfaceSctpServerChannelConfig
- Overrides:
setRecvByteBufAllocator
in classDefaultChannelConfig
-
setAutoRead
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 interfaceSctpServerChannelConfig
- Overrides:
setAutoRead
in classDefaultChannelConfig
-
setAutoClose
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 interfaceSctpServerChannelConfig
- Overrides:
setAutoClose
in classDefaultChannelConfig
-
setWriteBufferLowWaterMark
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 interfaceSctpServerChannelConfig
- Overrides:
setWriteBufferLowWaterMark
in classDefaultChannelConfig
-
setWriteBufferHighWaterMark
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 interfaceSctpServerChannelConfig
- Overrides:
setWriteBufferHighWaterMark
in classDefaultChannelConfig
-
setWriteBufferWaterMark
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 interfaceSctpServerChannelConfig
- Overrides:
setWriteBufferWaterMark
in classDefaultChannelConfig
-
setMessageSizeEstimator
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 interfaceSctpServerChannelConfig
- Overrides:
setMessageSizeEstimator
in classDefaultChannelConfig
-