OioSocketChannelConfig (Netty 4.0.56.Final API文档

所有超级接口:

ChannelConfig, SocketChannelConfig

所有已知实现类:

DefaultOioSocketChannelConfig
```
public interface OioSocketChannelConfig
extends SocketChannelConfig
```
A ChannelConfig for a OioSocketChannel.
Available options
In addition to the options provided by SocketChannelConfig, OioSocketChannelConfig allows the following options in the option map:

Name Associated setter method
ChannelOption.SO_TIMEOUT setSoTimeout(int)

Name	Associated setter method
`ChannelOption.SO_TIMEOUT`	`setSoTimeout(int)`

方法概要

方法
限定符和类型	方法和说明
`int`	`getSoTimeout()` Returns the maximal time a operation on the underlying socket may block.
`OioSocketChannelConfig`	`setAllocator(ByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
`OioSocketChannelConfig`	`setAllowHalfClosure(boolean allowHalfClosure)` Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
`OioSocketChannelConfig`	`setAutoClose(boolean autoClose)`
`OioSocketChannelConfig`	`setAutoRead(boolean autoRead)` Sets if `ChannelHandlerContext.read()` will be invoked automatically so that a user application doesn't need to call it at all.
`OioSocketChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`OioSocketChannelConfig`	`setKeepAlive(boolean keepAlive)` Sets the `StandardSocketOptions.SO_KEEPALIVE` option.
`OioSocketChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` Sets the maximum number of messages to read per read loop.
`OioSocketChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` Set the `MessageSizeEstimator` which is used for the channel to detect the size of a message.
`OioSocketChannelConfig`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` Sets the performance preferences as specified in `Socket.setPerformancePreferences(int, int, int)`.
`OioSocketChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)` Sets the `StandardSocketOptions.SO_RCVBUF` option.
`OioSocketChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate receive buffers.
`OioSocketChannelConfig`	`setReuseAddress(boolean reuseAddress)` Sets the `StandardSocketOptions.SO_REUSEADDR` option.
`OioSocketChannelConfig`	`setSendBufferSize(int sendBufferSize)` Sets the `StandardSocketOptions.SO_SNDBUF` option.
`OioSocketChannelConfig`	`setSoLinger(int soLinger)` Sets the `StandardSocketOptions.SO_LINGER` option.
`OioSocketChannelConfig`	`setSoTimeout(int timeout)` Sets the maximal time a operation on the underlying socket may block.
`OioSocketChannelConfig`	`setTcpNoDelay(boolean tcpNoDelay)` Sets the `StandardSocketOptions.TCP_NODELAY` option.
`OioSocketChannelConfig`	`setTrafficClass(int trafficClass)` Sets the `StandardSocketOptions.IP_TOS` option.
`OioSocketChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` Sets the high water mark of the write buffer.
`OioSocketChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` Sets the low water mark of the write buffer.
`OioSocketChannelConfig`	`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.SocketChannelConfig
getReceiveBufferSize, getSendBufferSize, getSoLinger, getTrafficClass, isAllowHalfClosure, isKeepAlive, isReuseAddress, isTcpNoDelay

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

- 方法详细资料
  - setSoTimeout
```
OioSocketChannelConfig setSoTimeout(int timeout)
```
    Sets the maximal time a operation on the underlying socket may block.
  - getSoTimeout
```
int getSoTimeout()
```
    Returns the maximal time a operation on the underlying socket may block.
  - setTcpNoDelay
```
OioSocketChannelConfig setTcpNoDelay(boolean tcpNoDelay)
```
    从接口复制的说明: SocketChannelConfig
    
    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.
    
    指定者:
    
    setTcpNoDelay 在接口中 SocketChannelConfig
  - setSoLinger
```
OioSocketChannelConfig setSoLinger(int soLinger)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.SO_LINGER option.
    
    指定者:
    
    setSoLinger 在接口中 SocketChannelConfig
  - setSendBufferSize
```
OioSocketChannelConfig setSendBufferSize(int sendBufferSize)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.SO_SNDBUF option.
    
    指定者:
    
    setSendBufferSize 在接口中 SocketChannelConfig
  - setReceiveBufferSize
```
OioSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.SO_RCVBUF option.
    
    指定者:
    
    setReceiveBufferSize 在接口中 SocketChannelConfig
  - setKeepAlive
```
OioSocketChannelConfig setKeepAlive(boolean keepAlive)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.SO_KEEPALIVE option.
    
    指定者:
    
    setKeepAlive 在接口中 SocketChannelConfig
  - setTrafficClass
```
OioSocketChannelConfig setTrafficClass(int trafficClass)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.IP_TOS option.
    
    指定者:
    
    setTrafficClass 在接口中 SocketChannelConfig
  - setReuseAddress
```
OioSocketChannelConfig setReuseAddress(boolean reuseAddress)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.SO_REUSEADDR option.
    
    指定者:
    
    setReuseAddress 在接口中 SocketChannelConfig
  - setPerformancePreferences
```
OioSocketChannelConfig setPerformancePreferences(int connectionTime,
                                               int latency,
                                               int bandwidth)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the performance preferences as specified in Socket.setPerformancePreferences(int, int, int).
    
    指定者:
    
    setPerformancePreferences 在接口中 SocketChannelConfig
  - setAllowHalfClosure
```
OioSocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)
```
    从接口复制的说明: SocketChannelConfig
    
    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 在接口中 SocketChannelConfig
  - setConnectTimeoutMillis
```
OioSocketChannelConfig 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 在接口中 SocketChannelConfig
    
    参数:
    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.
  - setMaxMessagesPerRead
```
OioSocketChannelConfig 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 在接口中 SocketChannelConfig
  - setWriteSpinCount
```
OioSocketChannelConfig 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 在接口中 SocketChannelConfig
  - setAllocator
```
OioSocketChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    setAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setAllocator 在接口中 SocketChannelConfig
  - setRecvByteBufAllocator
```
OioSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 SocketChannelConfig
  - setAutoRead
```
OioSocketChannelConfig 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 在接口中 SocketChannelConfig
  - setAutoClose
```
OioSocketChannelConfig setAutoClose(boolean autoClose)
```
    指定者:
    
    setAutoClose 在接口中 ChannelConfig
    
    指定者:
    
    setAutoClose 在接口中 SocketChannelConfig
  - setWriteBufferHighWaterMark
```
OioSocketChannelConfig 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
```
OioSocketChannelConfig 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
```
OioSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口复制的说明: ChannelConfig
    
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ChannelConfig
    
    指定者:
    
    setMessageSizeEstimator 在接口中 SocketChannelConfig

接口 OioSocketChannelConfig

Available options

方法概要

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

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

方法详细资料

setSoTimeout

getSoTimeout

setTcpNoDelay

setSoLinger

setSendBufferSize

setReceiveBufferSize

setKeepAlive

setTrafficClass

setReuseAddress

setPerformancePreferences

setAllowHalfClosure

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setAutoClose

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setMessageSizeEstimator