SocketChannelConfig (Netty API Reference (4.1.22.Final))

All Superinterfaces:

ChannelConfig

All Known Subinterfaces:

OioSocketChannelConfig

所有已知实现类：

DefaultOioSocketChannelConfig ， DefaultSocketChannelConfig ， EpollSocketChannelConfig ， KQueueSocketChannelConfig
```
public interface SocketChannelConfig
extends ChannelConfig
```
A ChannelConfig为SocketChannel 。
可用选项
除了ChannelConfig提供的选项外， SocketChannelConfig还允许在选项图中使用以下选项： Name Associated setter method ChannelOption.SO_KEEPALIVE setKeepAlive(boolean) ChannelOption.SO_REUSEADDR setReuseAddress(boolean) ChannelOption.SO_LINGER setSoLinger(int) ChannelOption.TCP_NODELAY setTcpNoDelay(boolean) ChannelOption.SO_RCVBUF setReceiveBufferSize(int) ChannelOption.SO_SNDBUF setSendBufferSize(int) ChannelOption.IP_TOS setTrafficClass(int) ChannelOption.ALLOW_HALF_CLOSURE setAllowHalfClosure(boolean)

方法摘要

所有方法接口方法抽象方法弃用的方法
Modifier and Type	Method and Description
`int`	`getReceiveBufferSize()` 获取 `StandardSocketOptions.SO_RCVBUF`选项。
`int`	`getSendBufferSize()` 获取 `StandardSocketOptions.SO_SNDBUF`选项。
`int`	`getSoLinger()` 获取 `StandardSocketOptions.SO_LINGER`选项。
`int`	`getTrafficClass()` 获取 `StandardSocketOptions.IP_TOS`选项。
`boolean`	`isAllowHalfClosure()` 返回 `true`当且仅当其远程对等关闭输出以使连接半关闭时，通道不应该关闭。
`boolean`	`isKeepAlive()` 获取 `StandardSocketOptions.SO_KEEPALIVE`选项。
`boolean`	`isReuseAddress()` 获取 `StandardSocketOptions.SO_REUSEADDR`选项。
`boolean`	`isTcpNoDelay()` 获取 `StandardSocketOptions.TCP_NODELAY`选项。
`SocketChannelConfig`	`setAllocator(ByteBufAllocator allocator)` 设置用于通道分配缓冲区的`ByteBufAllocator` 。
`SocketChannelConfig`	`setAllowHalfClosure(boolean allowHalfClosure)` 设置当远程对等关闭输出以使连接半关闭时，通道是否应该关闭。
`SocketChannelConfig`	`setAutoClose(boolean autoClose)`
`SocketChannelConfig`	`setAutoRead(boolean autoRead)` 设置是否自动调用 `ChannelHandlerContext.read()`，以便用户应用程序根本不需要调用它。
`SocketChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` 以毫秒为单位设置通道的连接超时。
`SocketChannelConfig`	`setKeepAlive(boolean keepAlive)` 设置 `StandardSocketOptions.SO_KEEPALIVE`选项。
`SocketChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`SocketChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` 设置用于通道的`MessageSizeEstimator`以检测消息的大小。
`SocketChannelConfig`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` 设置 `Socket.setPerformancePreferences(int, int, int)`指定的性能首选项。
`SocketChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)` 设置 `StandardSocketOptions.SO_RCVBUF`选项。
`SocketChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` 设置用于通道分配接收缓冲区的`RecvByteBufAllocator` 。
`SocketChannelConfig`	`setReuseAddress(boolean reuseAddress)` 设置 `StandardSocketOptions.SO_REUSEADDR`选项。
`SocketChannelConfig`	`setSendBufferSize(int sendBufferSize)` 设置 `StandardSocketOptions.SO_SNDBUF`选项。
`SocketChannelConfig`	`setSoLinger(int soLinger)` 设置 `StandardSocketOptions.SO_LINGER`选项。
`SocketChannelConfig`	`setTcpNoDelay(boolean tcpNoDelay)` 设置 `StandardSocketOptions.TCP_NODELAY`选项。
`SocketChannelConfig`	`setTrafficClass(int trafficClass)` 设置 `StandardSocketOptions.IP_TOS`选项。
`SocketChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` 设置用于设置写入缓冲区的高位和低位水位的`WriteBufferWaterMark` 。
`SocketChannelConfig`	`setWriteSpinCount(int writeSpinCount)` 设置写入操作的最大循环数，直到 `WritableByteChannel.write(ByteBuffer)`返回非零值。

Methods inherited from interface io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOption, setOptions, setWriteBufferHighWaterMark, setWriteBufferLowWaterMark

- 方法详细信息
  - isTcpNoDelay
```
boolean isTcpNoDelay()
```
    获取StandardSocketOptions.TCP_NODELAY选项。请注意，此选项的默认值是true与操作系统默认值（ false ）不同。但是，对于一些有问题的平台，例如Android，在Nagle算法禁用的情况下显示不稳定的行为，默认值仍为false 。
  - setTcpNoDelay
```
SocketChannelConfig setTcpNoDelay(boolean tcpNoDelay)
```
    设置StandardSocketOptions.TCP_NODELAY选项。请注意，这个选项的默认值是true不同于操作系统默认（ false ）。但是，对于一些有问题的平台，如Android，在Nagle算法禁用的情况下显示不稳定的行为，默认值仍然为false 。
  - getSoLinger
```
int getSoLinger()
```
    获取 StandardSocketOptions.SO_LINGER选项。
  - setSoLinger
```
SocketChannelConfig setSoLinger(int soLinger)
```
    设置 StandardSocketOptions.SO_LINGER选项。
  - getSendBufferSize
```
int getSendBufferSize()
```
    获取 StandardSocketOptions.SO_SNDBUF选项。
  - setSendBufferSize
```
SocketChannelConfig setSendBufferSize(int sendBufferSize)
```
    设置 StandardSocketOptions.SO_SNDBUF选项。
  - getReceiveBufferSize
```
int getReceiveBufferSize()
```
    获取 StandardSocketOptions.SO_RCVBUF选项。
  - setReceiveBufferSize
```
SocketChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    设置 StandardSocketOptions.SO_RCVBUF选项。
  - isKeepAlive
```
boolean isKeepAlive()
```
    获取 StandardSocketOptions.SO_KEEPALIVE选项。
  - setKeepAlive
```
SocketChannelConfig setKeepAlive(boolean keepAlive)
```
    设置 StandardSocketOptions.SO_KEEPALIVE选项。
  - getTrafficClass
```
int getTrafficClass()
```
    获取 StandardSocketOptions.IP_TOS选项。
  - setTrafficClass
```
SocketChannelConfig setTrafficClass(int trafficClass)
```
    设置 StandardSocketOptions.IP_TOS选项。
  - isReuseAddress
```
boolean isReuseAddress()
```
    获取 StandardSocketOptions.SO_REUSEADDR选项。
  - setReuseAddress
```
SocketChannelConfig setReuseAddress(boolean reuseAddress)
```
    设置 StandardSocketOptions.SO_REUSEADDR选项。
  - setPerformancePreferences
```
SocketChannelConfig setPerformancePreferences(int connectionTime,
                                              int latency,
                                              int bandwidth)
```
    按照 Socket.setPerformancePreferences(int, int, int)规定设置性能首选项。
  - isAllowHalfClosure
```
boolean isAllowHalfClosure()
```
    返回true当且仅当其远程对等关闭输出以使连接半关闭时，通道不应关闭。如果是false ，则当远程对等关闭输出时，连接会自动关闭。
  - setAllowHalfClosure
```
SocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)
```
    设置当远程对等关闭输出以使连接半关闭时，通道是否应该关闭。如果true远程对等关闭输出，则连接未关闭。相反， ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object)调用一个ChannelInputShutdownEvent对象。如果false ，连接自动关闭。
  - setConnectTimeoutMillis
```
SocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    从界面复制的描述： ChannelConfig
    
    以毫秒为单位设置通道的连接超时。如果Channel不支持连接操作，则完全不使用此属性，因此将被忽略。
    
    Specified by:
    
    setConnectTimeoutMillis ，界面 ChannelConfig
    
    参数
    
    connectTimeoutMillis - 以毫秒为单位的连接超时。 0禁用。
  - setMaxMessagesPerRead
```
@Deprecated
SocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    Specified by:
    
    setMaxMessagesPerRead在界面 ChannelConfig
  - setWriteSpinCount
```
SocketChannelConfig setWriteSpinCount(int writeSpinCount)
```
    从界面复制的描述： ChannelConfig
    
    设置写操作的最大循环数，直到WritableByteChannel.write(ByteBuffer)返回非零值。它类似于在并发编程中使用自旋锁。它可以提高内存利用率并根据运行JVM的平台来编写吞吐量。默认值是16 。
    
    Specified by:
    
    setWriteSpinCount在界面 ChannelConfig
  - setAllocator
```
SocketChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从界面复制的描述： ChannelConfig
    
    设置用于通道分配缓冲区的ByteBufAllocator 。
    
    Specified by:
    
    setAllocator在界面 ChannelConfig
  - setRecvByteBufAllocator
```
SocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从界面复制的描述： ChannelConfig
    
    设置用于通道分配接收缓冲区的RecvByteBufAllocator 。
    
    Specified by:
    
    setRecvByteBufAllocator在界面 ChannelConfig
  - setAutoRead
```
SocketChannelConfig setAutoRead(boolean autoRead)
```
    从接口复制的描述： ChannelConfig
    
    设置是否自动调用ChannelHandlerContext.read()，以便用户应用程序根本不需要调用它。默认值是true 。
    
    Specified by:
    
    setAutoRead在界面 ChannelConfig
  - setAutoClose
```
SocketChannelConfig setAutoClose(boolean autoClose)
```
    Specified by:
    
    setAutoClose在界面 ChannelConfig
  - setMessageSizeEstimator
```
SocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从界面复制的描述： ChannelConfig
    
    设置用于通道的MessageSizeEstimator以检测消息的大小。
    
    Specified by:
    
    setMessageSizeEstimator ，界面 ChannelConfig
  - setWriteBufferWaterMark
```
SocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    从界面复制的描述： ChannelConfig
    
    设置WriteBufferWaterMark用于设置写入缓冲区的高位和低位水印。
    
    Specified by:
    
    setWriteBufferWaterMark在界面 ChannelConfig

Interface SocketChannelConfig

可用选项

方法摘要

Methods inherited from interface io.netty.channel.ChannelConfig

方法详细信息

isTcpNoDelay

setTcpNoDelay

getSoLinger

setSoLinger

getSendBufferSize

setSendBufferSize

getReceiveBufferSize

setReceiveBufferSize

isKeepAlive

setKeepAlive

getTrafficClass

setTrafficClass

isReuseAddress

setReuseAddress

setPerformancePreferences

isAllowHalfClosure

setAllowHalfClosure

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setAutoClose

setMessageSizeEstimator

setWriteBufferWaterMark