SocketChannelConfig (Netty 4.1.109.Final API文档

所有超级接口:: ChannelConfig, DuplexChannelConfig

所有已知子接口:: OioSocketChannelConfig

所有已知实现类:: DefaultOioSocketChannelConfig, DefaultSocketChannelConfig, EpollSocketChannelConfig, KQueueSocketChannelConfig

public interface SocketChannelConfig
extends DuplexChannelConfig

A ChannelConfig for a SocketChannel.

Available options

In addition to the options provided by DuplexChannelConfig, SocketChannelConfig allows the following options in the option map:

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)`

方法概要

All Methods Instance Methods Abstract Methods Deprecated Methods
限定符和类型	方法和说明
`int`	`getReceiveBufferSize()` Gets the `StandardSocketOptions.SO_RCVBUF` option.
`int`	`getSendBufferSize()` Gets the `StandardSocketOptions.SO_SNDBUF` option.
`int`	`getSoLinger()` Gets the `StandardSocketOptions.SO_LINGER` option.
`int`	`getTrafficClass()` Gets the `StandardSocketOptions.IP_TOS` option.
`boolean`	`isKeepAlive()` Gets the `StandardSocketOptions.SO_KEEPALIVE` option.
`boolean`	`isReuseAddress()` Gets the `StandardSocketOptions.SO_REUSEADDR` option.
`boolean`	`isTcpNoDelay()` Gets the `StandardSocketOptions.TCP_NODELAY` option.
`SocketChannelConfig`	`setAllocator(ByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
`SocketChannelConfig`	`setAllowHalfClosure(boolean allowHalfClosure)` Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
`SocketChannelConfig`	`setAutoClose(boolean autoClose)` Sets whether the `Channel` should be closed automatically and immediately on write failure.
`SocketChannelConfig`	`setAutoRead(boolean autoRead)` Sets if `ChannelHandlerContext.read()` will be invoked automatically so that a user application doesn't need to call it at all.
`SocketChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`SocketChannelConfig`	`setKeepAlive(boolean keepAlive)` Sets the `StandardSocketOptions.SO_KEEPALIVE` option.
`SocketChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`SocketChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` Set the `MessageSizeEstimator` which is used for the channel to detect the size of a message.
`SocketChannelConfig`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` Sets the performance preferences as specified in `Socket.setPerformancePreferences(int, int, int)`.
`SocketChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)` Sets the `StandardSocketOptions.SO_RCVBUF` option.
`SocketChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` Set the `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.
`SocketChannelConfig`	`setReuseAddress(boolean reuseAddress)` Sets the `StandardSocketOptions.SO_REUSEADDR` option.
`SocketChannelConfig`	`setSendBufferSize(int sendBufferSize)` Sets the `StandardSocketOptions.SO_SNDBUF` option.
`SocketChannelConfig`	`setSoLinger(int soLinger)` Sets the `StandardSocketOptions.SO_LINGER` option.
`SocketChannelConfig`	`setTcpNoDelay(boolean tcpNoDelay)` Sets the `StandardSocketOptions.TCP_NODELAY` option.
`SocketChannelConfig`	`setTrafficClass(int trafficClass)` Sets the `StandardSocketOptions.IP_TOS` option.
`SocketChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` Set the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.
`SocketChannelConfig`	`setWriteSpinCount(int writeSpinCount)` Sets the maximum loop count for a write operation until `WritableByteChannel.write(ByteBuffer)` returns a non-zero value.

从接口继承的方法 io.netty.channel.socket.DuplexChannelConfig
isAllowHalfClosure

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

- 方法详细资料
  - isTcpNoDelay
```
boolean isTcpNoDelay()
```
    Gets the StandardSocketOptions.TCP_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.
  - setTcpNoDelay
```
SocketChannelConfig setTcpNoDelay(boolean tcpNoDelay)
```
    Sets the StandardSocketOptions.TCP_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.
  - getSoLinger
```
int getSoLinger()
```
    Gets the StandardSocketOptions.SO_LINGER option.
  - setSoLinger
```
SocketChannelConfig setSoLinger(int soLinger)
```
    Sets the StandardSocketOptions.SO_LINGER option.
  - getSendBufferSize
```
int getSendBufferSize()
```
    Gets the StandardSocketOptions.SO_SNDBUF option.
  - setSendBufferSize
```
SocketChannelConfig setSendBufferSize(int sendBufferSize)
```
    Sets the StandardSocketOptions.SO_SNDBUF option.
  - getReceiveBufferSize
```
int getReceiveBufferSize()
```
    Gets the StandardSocketOptions.SO_RCVBUF option.
  - setReceiveBufferSize
```
SocketChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    Sets the StandardSocketOptions.SO_RCVBUF option.
  - isKeepAlive
```
boolean isKeepAlive()
```
    Gets the StandardSocketOptions.SO_KEEPALIVE option.
  - setKeepAlive
```
SocketChannelConfig setKeepAlive(boolean keepAlive)
```
    Sets the StandardSocketOptions.SO_KEEPALIVE option.
  - getTrafficClass
```
int getTrafficClass()
```
    Gets the StandardSocketOptions.IP_TOS option.
  - setTrafficClass
```
SocketChannelConfig setTrafficClass(int trafficClass)
```
    Sets the StandardSocketOptions.IP_TOS option.
  - isReuseAddress
```
boolean isReuseAddress()
```
    Gets the StandardSocketOptions.SO_REUSEADDR option.
  - setReuseAddress
```
SocketChannelConfig setReuseAddress(boolean reuseAddress)
```
    Sets the StandardSocketOptions.SO_REUSEADDR option.
  - setPerformancePreferences
```
SocketChannelConfig setPerformancePreferences(int connectionTime,
                                              int latency,
                                              int bandwidth)
```
    Sets the performance preferences as specified in Socket.setPerformancePreferences(int, int, int).
  - setAllowHalfClosure
```
SocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)
```
    从接口复制的说明: DuplexChannelConfig
    
    Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If true the connection is not closed when the remote peer shuts down output. Instead, ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object) is invoked with a ChannelInputShutdownEvent object. If false, the connection is closed automatically.
    
    指定者:
    
    setAllowHalfClosure 在接口中 DuplexChannelConfig
  - setConnectTimeoutMillis
```
SocketChannelConfig 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
```
@Deprecated
SocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 ChannelConfig
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 DuplexChannelConfig
  - setWriteSpinCount
```
SocketChannelConfig 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 在接口中 DuplexChannelConfig
  - setAllocator
```
SocketChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    setAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setAllocator 在接口中 DuplexChannelConfig
  - setRecvByteBufAllocator
```
SocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 DuplexChannelConfig
  - setAutoRead
```
SocketChannelConfig 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 在接口中 DuplexChannelConfig
  - setAutoClose
```
SocketChannelConfig setAutoClose(boolean autoClose)
```
    从接口复制的说明: ChannelConfig
    
    Sets whether the Channel should be closed automatically and immediately on write failure. The default is true.
    
    指定者:
    
    setAutoClose 在接口中 ChannelConfig
    
    指定者:
    
    setAutoClose 在接口中 DuplexChannelConfig
  - setMessageSizeEstimator
```
SocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口复制的说明: ChannelConfig
    
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ChannelConfig
    
    指定者:
    
    setMessageSizeEstimator 在接口中 DuplexChannelConfig
  - setWriteBufferWaterMark
```
SocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    从接口复制的说明: ChannelConfig
    
    Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
    
    指定者:
    
    setWriteBufferWaterMark 在接口中 ChannelConfig
    
    指定者:
    
    setWriteBufferWaterMark 在接口中 DuplexChannelConfig

接口 SocketChannelConfig

Available options

方法概要

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

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

方法详细资料

isTcpNoDelay

setTcpNoDelay

getSoLinger

setSoLinger

getSendBufferSize

setSendBufferSize

getReceiveBufferSize

setReceiveBufferSize

isKeepAlive

setKeepAlive

getTrafficClass

setTrafficClass

isReuseAddress

setReuseAddress

setPerformancePreferences

setAllowHalfClosure

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setAutoClose

setMessageSizeEstimator

setWriteBufferWaterMark