DefaultOioServerSocketChannelConfig (Netty 4.0.56.Final API文档

java.lang.Object
- io.netty.channel.DefaultChannelConfig
- - io.netty.channel.socket.DefaultServerSocketChannelConfig
  - - io.netty.channel.socket.oio.DefaultOioServerSocketChannelConfig

所有已实现的接口:

ChannelConfig, OioServerSocketChannelConfig, ServerSocketChannelConfig
```
public class DefaultOioServerSocketChannelConfig
extends DefaultServerSocketChannelConfig
implements OioServerSocketChannelConfig
```
Default OioServerSocketChannelConfig implementation

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

构造器概要

构造器
构造器和说明

DefaultOioServerSocketChannelConfig(ServerSocketChannel channel, java.net.ServerSocket javaSocket)
已过时。

构造器
构造器和说明
`DefaultOioServerSocketChannelConfig(ServerSocketChannel channel, java.net.ServerSocket javaSocket)` 已过时。

方法概要

方法
限定符和类型	方法和说明
`protected void`	`autoReadCleared()` Is called once `DefaultChannelConfig.setAutoRead(boolean)` is called with `false` and `DefaultChannelConfig.isAutoRead()` was `true` before.
`<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`	`getSoTimeout()` Returns the maximal time a operation on the underlying socket may block.
`OioServerSocketChannelConfig`	`setAllocator(ByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
`OioServerSocketChannelConfig`	`setAutoClose(boolean autoClose)`
`OioServerSocketChannelConfig`	`setAutoRead(boolean autoRead)` Sets if `ChannelHandlerContext.read()` will be invoked automatically so that a user application doesn't need to call it at all.
`OioServerSocketChannelConfig`	`setBacklog(int backlog)` Sets the backlog value to specify when the channel binds to a local address.
`OioServerSocketChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`OioServerSocketChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` Sets the maximum number of messages to read per read loop.
`OioServerSocketChannelConfig`	`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.
`OioServerSocketChannelConfig`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` Sets the performance preferences as specified in `ServerSocket.setPerformancePreferences(int, int, int)`.
`OioServerSocketChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)` Gets the `StandardSocketOptions.SO_SNDBUF` option.
`OioServerSocketChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate receive buffers.
`OioServerSocketChannelConfig`	`setReuseAddress(boolean reuseAddress)` Sets the `StandardSocketOptions.SO_REUSEADDR` option.
`OioServerSocketChannelConfig`	`setSoTimeout(int timeout)` Sets the maximal time a operation on the underlying socket may block.
`OioServerSocketChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` Sets the high water mark of the write buffer.
`OioServerSocketChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` Sets the low water mark of the write buffer.
`OioServerSocketChannelConfig`	`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.DefaultServerSocketChannelConfig
getBacklog, getReceiveBufferSize, isReuseAddress

从类继承的方法 io.netty.channel.DefaultChannelConfig
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.socket.ServerSocketChannelConfig
getBacklog, getReceiveBufferSize, isReuseAddress

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

- 构造器详细资料
  - DefaultOioServerSocketChannelConfig
```
@Deprecated
public DefaultOioServerSocketChannelConfig(ServerSocketChannel channel,
                                              java.net.ServerSocket javaSocket)
```
    已过时。
- 方法详细资料
  - getOptions
```
public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
```
    从接口复制的说明: ChannelConfig
    
    Return all set ChannelOption's.
    
    指定者:
    
    getOptions 在接口中 ChannelConfig
    
    覆盖:
    
    getOptions 在类中 DefaultServerSocketChannelConfig
  - getOption
```
public <T> T getOption(ChannelOption<T> option)
```
    从接口复制的说明: ChannelConfig
    
    Return the value of the given ChannelOption
    
    指定者:
    
    getOption 在接口中 ChannelConfig
    
    覆盖:
    
    getOption 在类中 DefaultServerSocketChannelConfig
  - 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 在类中 DefaultServerSocketChannelConfig
    
    返回:
    true if and only if the property has been set
  - setSoTimeout
```
public OioServerSocketChannelConfig setSoTimeout(int timeout)
```
    从接口复制的说明: OioServerSocketChannelConfig
    
    Sets the maximal time a operation on the underlying socket may block.
    
    指定者:
    
    setSoTimeout 在接口中 OioServerSocketChannelConfig
  - getSoTimeout
```
public int getSoTimeout()
```
    从接口复制的说明: OioServerSocketChannelConfig
    
    Returns the maximal time a operation on the underlying socket may block.
    
    指定者:
    
    getSoTimeout 在接口中 OioServerSocketChannelConfig
  - setBacklog
```
public OioServerSocketChannelConfig setBacklog(int backlog)
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Sets the backlog value to specify when the channel binds to a local address.
    
    指定者:
    
    setBacklog 在接口中 OioServerSocketChannelConfig
    
    指定者:
    
    setBacklog 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setBacklog 在类中 DefaultServerSocketChannelConfig
  - setReuseAddress
```
public OioServerSocketChannelConfig setReuseAddress(boolean reuseAddress)
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Sets the StandardSocketOptions.SO_REUSEADDR option.
    
    指定者:
    
    setReuseAddress 在接口中 OioServerSocketChannelConfig
    
    指定者:
    
    setReuseAddress 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setReuseAddress 在类中 DefaultServerSocketChannelConfig
  - setReceiveBufferSize
```
public OioServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Gets the StandardSocketOptions.SO_SNDBUF option.
    
    指定者:
    
    setReceiveBufferSize 在接口中 OioServerSocketChannelConfig
    
    指定者:
    
    setReceiveBufferSize 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setReceiveBufferSize 在类中 DefaultServerSocketChannelConfig
  - setPerformancePreferences
```
public OioServerSocketChannelConfig setPerformancePreferences(int connectionTime,
                                                     int latency,
                                                     int bandwidth)
```
    从接口复制的说明: ServerSocketChannelConfig
    
    Sets the performance preferences as specified in ServerSocket.setPerformancePreferences(int, int, int).
    
    指定者:
    
    setPerformancePreferences 在接口中 OioServerSocketChannelConfig
    
    指定者:
    
    setPerformancePreferences 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setPerformancePreferences 在类中 DefaultServerSocketChannelConfig
  - setConnectTimeoutMillis
```
public OioServerSocketChannelConfig 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 在接口中 OioServerSocketChannelConfig
    
    指定者:
    
    setConnectTimeoutMillis 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setConnectTimeoutMillis 在类中 DefaultServerSocketChannelConfig
    
    参数:
    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.
  - setMaxMessagesPerRead
```
public OioServerSocketChannelConfig 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 在接口中 OioServerSocketChannelConfig
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setMaxMessagesPerRead 在类中 DefaultServerSocketChannelConfig
  - setWriteSpinCount
```
public OioServerSocketChannelConfig 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 在接口中 OioServerSocketChannelConfig
    
    指定者:
    
    setWriteSpinCount 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setWriteSpinCount 在类中 DefaultServerSocketChannelConfig
  - setAllocator
```
public OioServerSocketChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    setAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setAllocator 在接口中 OioServerSocketChannelConfig
    
    指定者:
    
    setAllocator 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setAllocator 在类中 DefaultServerSocketChannelConfig
  - setRecvByteBufAllocator
```
public OioServerSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 OioServerSocketChannelConfig
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setRecvByteBufAllocator 在类中 DefaultServerSocketChannelConfig
  - setAutoRead
```
public OioServerSocketChannelConfig 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 在接口中 OioServerSocketChannelConfig
    
    指定者:
    
    setAutoRead 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setAutoRead 在类中 DefaultServerSocketChannelConfig
  - autoReadCleared
```
protected void autoReadCleared()
```
    从类复制的说明: DefaultChannelConfig
    
    Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.
    
    覆盖:
    
    autoReadCleared 在类中 DefaultChannelConfig
  - setAutoClose
```
public OioServerSocketChannelConfig setAutoClose(boolean autoClose)
```
    指定者:
    
    setAutoClose 在接口中 ChannelConfig
    
    指定者:
    
    setAutoClose 在接口中 OioServerSocketChannelConfig
    
    覆盖:
    
    setAutoClose 在类中 DefaultChannelConfig
  - setWriteBufferHighWaterMark
```
public OioServerSocketChannelConfig 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 在接口中 OioServerSocketChannelConfig
    
    覆盖:
    
    setWriteBufferHighWaterMark 在类中 DefaultServerSocketChannelConfig
  - setWriteBufferLowWaterMark
```
public OioServerSocketChannelConfig 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 在接口中 OioServerSocketChannelConfig
    
    覆盖:
    
    setWriteBufferLowWaterMark 在类中 DefaultServerSocketChannelConfig
  - setMessageSizeEstimator
```
public OioServerSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口复制的说明: ChannelConfig
    
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ChannelConfig
    
    指定者:
    
    setMessageSizeEstimator 在接口中 OioServerSocketChannelConfig
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ServerSocketChannelConfig
    
    覆盖:
    
    setMessageSizeEstimator 在类中 DefaultServerSocketChannelConfig

类 DefaultOioServerSocketChannelConfig

字段概要

从类继承的字段 io.netty.channel.socket.DefaultServerSocketChannelConfig

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

构造器概要

方法概要

从类继承的方法 io.netty.channel.socket.DefaultServerSocketChannelConfig

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

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

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

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

构造器详细资料

DefaultOioServerSocketChannelConfig

方法详细资料

getOptions

getOption

setOption

setSoTimeout

getSoTimeout

setBacklog

setReuseAddress

setReceiveBufferSize

setPerformancePreferences

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

autoReadCleared

setAutoClose

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setMessageSizeEstimator