SctpChannelConfig (Netty 4.0.56.Final API文档

所有超级接口:: ChannelConfig

所有已知实现类:: DefaultSctpChannelConfig

public interface SctpChannelConfig
extends ChannelConfig

A ChannelConfig for a SctpChannel.

Available options

In addition to the options provided by ChannelConfig, SctpChannelConfig allows the following options in the option map:

Name	Associated setter method
`SctpChannelOption.SCTP_NODELAY`	`setSctpNoDelay(boolean)`}
`ChannelOption.SO_RCVBUF`	`setReceiveBufferSize(int)`
`ChannelOption.SO_SNDBUF`	`setSendBufferSize(int)`
`SctpChannelOption.SCTP_INIT_MAXSTREAMS`	`#setInitMaxStreams(InitMaxStreams)`

方法概要

方法
限定符和类型	方法和说明
`com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams`	`getInitMaxStreams()` Gets the `SCTP_INIT_MAXSTREAMS` option.
`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.
`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.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOption, setOptions

- 方法详细资料
  - isSctpNoDelay
```
boolean isSctpNoDelay()
```
    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.
  - setSctpNoDelay
```
SctpChannelConfig setSctpNoDelay(boolean sctpNoDelay)
```
    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.
  - getSendBufferSize
```
int getSendBufferSize()
```
    Gets the SO_SNDBUF option.
  - setSendBufferSize
```
SctpChannelConfig setSendBufferSize(int sendBufferSize)
```
    Sets the SO_SNDBUF option.
  - getReceiveBufferSize
```
int getReceiveBufferSize()
```
    Gets the SO_RCVBUF option.
  - setReceiveBufferSize
```
SctpChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    Gets the SO_RCVBUF option.
  - getInitMaxStreams
```
com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams getInitMaxStreams()
```
    Gets the SCTP_INIT_MAXSTREAMS option.
  - setInitMaxStreams
```
SctpChannelConfig setInitMaxStreams(com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams initMaxStreams)
```
    Gets the SCTP_INIT_MAXSTREAMS option.
  - setConnectTimeoutMillis
```
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
    
    参数:
    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.
  - setMaxMessagesPerRead
```
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
  - setWriteSpinCount
```
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
  - setAllocator
```
SctpChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    setAllocator 在接口中 ChannelConfig
  - setRecvByteBufAllocator
```
SctpChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ChannelConfig
  - setAutoRead
```
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
  - setAutoClose
```
SctpChannelConfig setAutoClose(boolean autoClose)
```
    指定者:
    
    setAutoClose 在接口中 ChannelConfig
  - setWriteBufferHighWaterMark
```
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
  - setWriteBufferLowWaterMark
```
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
  - setMessageSizeEstimator
```
SctpChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口复制的说明: ChannelConfig
    
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ChannelConfig

接口 SctpChannelConfig

Available options

方法概要

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

方法详细资料

isSctpNoDelay

setSctpNoDelay

getSendBufferSize

setSendBufferSize

getReceiveBufferSize

setReceiveBufferSize

getInitMaxStreams

setInitMaxStreams

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setAutoClose

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setMessageSizeEstimator