DefaultSctpChannelConfig (Netty 4.0.56.Final API文档

java.lang.Object
- io.netty.channel.DefaultChannelConfig
- - io.netty.channel.sctp.DefaultSctpChannelConfig

所有已实现的接口:

ChannelConfig, SctpChannelConfig
```
public class DefaultSctpChannelConfig
extends DefaultChannelConfig
implements SctpChannelConfig
```
The default SctpChannelConfig implementation for SCTP.

字段概要
- 从类继承的字段 io.netty.channel.DefaultChannelConfig
  channel

构造器概要

构造器
构造器和说明

DefaultSctpChannelConfig(SctpChannel channel, com.sun.nio.sctp.SctpChannel javaChannel)

构造器
构造器和说明
`DefaultSctpChannelConfig(SctpChannel channel, com.sun.nio.sctp.SctpChannel javaChannel)`

方法概要

方法
限定符和类型	方法和说明
`com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams`	`getInitMaxStreams()` Gets the `SCTP_INIT_MAXSTREAMS` option.
`<T> T`	`getOption(ChannelOption<T> option)` Return the value of the given `ChannelOption`
`java.util.Map<ChannelOption<?>,java.lang.Object>`	`getOptions()` Return all set `ChannelOption`'s.
`int`	`getReceiveBufferSize()` Gets the `SO_RCVBUF` option.
`int`	`getSendBufferSize()` Gets the `SO_SNDBUF` option.
`boolean`	`isSctpNoDelay()` Gets the `SCTP_NODELAY` option.
`SctpChannelConfig`	`setAllocator(ByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
`SctpChannelConfig`	`setAutoClose(boolean autoClose)`
`SctpChannelConfig`	`setAutoRead(boolean autoRead)` Sets if `ChannelHandlerContext.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 the `SCTP_INIT_MAXSTREAMS` option.
`SctpChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` Sets the maximum number of messages to read per read loop.
`SctpChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` Set the `MessageSizeEstimator` 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 the `SO_RCVBUF` option.
`SctpChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate receive buffers.
`SctpChannelConfig`	`setSctpNoDelay(boolean sctpNoDelay)` Sets the `SCTP_NODELAY` option.
`SctpChannelConfig`	`setSendBufferSize(int sendBufferSize)` Sets the `SO_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`	`setWriteSpinCount(int writeSpinCount)` Sets the maximum loop count for a write operation until `WritableByteChannel.write(ByteBuffer)` returns a non-zero value.

从类继承的方法 io.netty.channel.DefaultChannelConfig
autoReadCleared, getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions, validate

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions

- 构造器详细资料
  - DefaultSctpChannelConfig
```
public DefaultSctpChannelConfig(SctpChannel channel,
                        com.sun.nio.sctp.SctpChannel javaChannel)
```
- 方法详细资料
  - getOptions
```
public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
```
    从接口复制的说明: ChannelConfig
    
    Return all set ChannelOption's.
    
    指定者:
    
    getOptions 在接口中 ChannelConfig
    
    覆盖:
    
    getOptions 在类中 DefaultChannelConfig
  - getOption
```
public <T> T getOption(ChannelOption<T> option)
```
    从接口复制的说明: ChannelConfig
    
    Return the value of the given ChannelOption
    
    指定者:
    
    getOption 在接口中 ChannelConfig
    
    覆盖:
    
    getOption 在类中 DefaultChannelConfig
  - setOption
```
public <T> boolean setOption(ChannelOption<T> option,
                    T value)
```
    从接口复制的说明: 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;
 }
 
```
    指定者:
    
    setOption 在接口中 ChannelConfig
    
    覆盖:
    
    setOption 在类中 DefaultChannelConfig
    
    返回:
    true if and only if the property has been set
  - isSctpNoDelay
```
public boolean isSctpNoDelay()
```
    从接口复制的说明: SctpChannelConfig
    
    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.
    
    指定者:
    
    isSctpNoDelay 在接口中 SctpChannelConfig
  - setSctpNoDelay
```
public SctpChannelConfig setSctpNoDelay(boolean sctpNoDelay)
```
    从接口复制的说明: SctpChannelConfig
    
    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.
    
    指定者:
    
    setSctpNoDelay 在接口中 SctpChannelConfig
  - getSendBufferSize
```
public int getSendBufferSize()
```
    从接口复制的说明: SctpChannelConfig
    
    Gets the SO_SNDBUF option.
    
    指定者:
    
    getSendBufferSize 在接口中 SctpChannelConfig
  - setSendBufferSize
```
public SctpChannelConfig setSendBufferSize(int sendBufferSize)
```
    从接口复制的说明: SctpChannelConfig
    
    Sets the SO_SNDBUF option.
    
    指定者:
    
    setSendBufferSize 在接口中 SctpChannelConfig
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    从接口复制的说明: SctpChannelConfig
    
    Gets the SO_RCVBUF option.
    
    指定者:
    
    getReceiveBufferSize 在接口中 SctpChannelConfig
  - setReceiveBufferSize
```
public SctpChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    从接口复制的说明: SctpChannelConfig
    
    Gets the SO_RCVBUF option.
    
    指定者:
    
    setReceiveBufferSize 在接口中 SctpChannelConfig
  - getInitMaxStreams
```
public com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams getInitMaxStreams()
```
    从接口复制的说明: SctpChannelConfig
    
    Gets the SCTP_INIT_MAXSTREAMS option.
    
    指定者:
    
    getInitMaxStreams 在接口中 SctpChannelConfig
  - setInitMaxStreams
```
public SctpChannelConfig setInitMaxStreams(com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams initMaxStreams)
```
    从接口复制的说明: SctpChannelConfig
    
    Gets the SCTP_INIT_MAXSTREAMS option.
    
    指定者:
    
    setInitMaxStreams 在接口中 SctpChannelConfig
  - setConnectTimeoutMillis
```
public SctpChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    从接口复制的说明: 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.
    
    指定者:
    
    setConnectTimeoutMillis 在接口中 ChannelConfig
    
    指定者:
    
    setConnectTimeoutMillis 在接口中 SctpChannelConfig
    
    覆盖:
    
    setConnectTimeoutMillis 在类中 DefaultChannelConfig
    
    参数:
    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.
  - setMaxMessagesPerRead
```
public SctpChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    从接口复制的说明: ChannelConfig
    
    Sets the maximum number of messages to read per read loop. If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 ChannelConfig
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 SctpChannelConfig
    
    覆盖:
    
    setMaxMessagesPerRead 在类中 DefaultChannelConfig
  - setWriteSpinCount
```
public SctpChannelConfig setWriteSpinCount(int writeSpinCount)
```
    从接口复制的说明: 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.
    
    指定者:
    
    setWriteSpinCount 在接口中 ChannelConfig
    
    指定者:
    
    setWriteSpinCount 在接口中 SctpChannelConfig
    
    覆盖:
    
    setWriteSpinCount 在类中 DefaultChannelConfig
  - setAllocator
```
public SctpChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    setAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setAllocator 在接口中 SctpChannelConfig
    
    覆盖:
    
    setAllocator 在类中 DefaultChannelConfig
  - setRecvByteBufAllocator
```
public SctpChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 SctpChannelConfig
    
    覆盖:
    
    setRecvByteBufAllocator 在类中 DefaultChannelConfig
  - setAutoRead
```
public SctpChannelConfig setAutoRead(boolean autoRead)
```
    从接口复制的说明: 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.
    
    指定者:
    
    setAutoRead 在接口中 ChannelConfig
    
    指定者:
    
    setAutoRead 在接口中 SctpChannelConfig
    
    覆盖:
    
    setAutoRead 在类中 DefaultChannelConfig
  - setAutoClose
```
public SctpChannelConfig setAutoClose(boolean autoClose)
```
    指定者:
    
    setAutoClose 在接口中 ChannelConfig
    
    指定者:
    
    setAutoClose 在接口中 SctpChannelConfig
    
    覆盖:
    
    setAutoClose 在类中 DefaultChannelConfig
  - setWriteBufferHighWaterMark
```
public SctpChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
```
    从接口复制的说明: 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.
    
    指定者:
    
    setWriteBufferHighWaterMark 在接口中 ChannelConfig
    
    指定者:
    
    setWriteBufferHighWaterMark 在接口中 SctpChannelConfig
    
    覆盖:
    
    setWriteBufferHighWaterMark 在类中 DefaultChannelConfig
  - setWriteBufferLowWaterMark
```
public SctpChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
```
    从接口复制的说明: 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.
    
    指定者:
    
    setWriteBufferLowWaterMark 在接口中 ChannelConfig
    
    指定者:
    
    setWriteBufferLowWaterMark 在接口中 SctpChannelConfig
    
    覆盖:
    
    setWriteBufferLowWaterMark 在类中 DefaultChannelConfig
  - setMessageSizeEstimator
```
public SctpChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口复制的说明: ChannelConfig
    
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ChannelConfig
    
    指定者:
    
    setMessageSizeEstimator 在接口中 SctpChannelConfig
    
    覆盖:
    
    setMessageSizeEstimator 在类中 DefaultChannelConfig

类 DefaultSctpChannelConfig

字段概要

从类继承的字段 io.netty.channel.DefaultChannelConfig

构造器概要

方法概要

从类继承的方法 io.netty.channel.DefaultChannelConfig

从类继承的方法 java.lang.Object

从接口继承的方法 io.netty.channel.ChannelConfig

构造器详细资料

DefaultSctpChannelConfig

方法详细资料

getOptions

getOption

setOption

isSctpNoDelay

setSctpNoDelay

getSendBufferSize

setSendBufferSize

getReceiveBufferSize

setReceiveBufferSize

getInitMaxStreams

setInitMaxStreams

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setAutoClose

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setMessageSizeEstimator