DefaultSocketChannelConfig (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.DefaultChannelConfig
- - io.netty.channel.socket.DefaultSocketChannelConfig

All Implemented Interfaces:

ChannelConfig ， SocketChannelConfig

已知直接子类：

DefaultOioSocketChannelConfig
```
public class DefaultSocketChannelConfig
extends DefaultChannelConfig
implements SocketChannelConfig
```
默认的SocketChannelConfig实现。

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.net.Socket`	`javaSocket`

Fields inherited from class io.netty.channel.DefaultChannelConfig
channel

构造方法摘要

构造方法
Constructor and Description
`DefaultSocketChannelConfig(SocketChannel channel, java.net.Socket javaSocket)` 创建一个新的实例。

方法摘要

所有方法接口方法具体的方法弃用的方法
Modifier and Type	Method and Description
`<T> T`	`getOption(ChannelOption<T> option)` 返回给定的`ChannelOption`的值
`java.util.Map<ChannelOption<?>,java.lang.Object>`	`getOptions()` 返回所有设置`ChannelOption`的。
`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`以检测消息的大小。
`<T> boolean`	`setOption(ChannelOption<T> option, T value)` 使用指定的名称和值设置配置属性。
`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`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` 设置写入缓冲区的高位标记。
`SocketChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` 设置写入缓冲区的低水位标志。
`SocketChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` 设置`WriteBufferWaterMark` ，用于设置写入缓冲区的高位和低位水印。
`SocketChannelConfig`	`setWriteSpinCount(int writeSpinCount)` 设置写操作的最大循环计数，直到 `WritableByteChannel.write(ByteBuffer)`返回非零值。

Methods inherited from class io.netty.channel.DefaultChannelConfig
autoReadCleared, getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

- 字段详细信息
  - javaSocket
```
protected final java.net.Socket javaSocket
```
- 构造方法详细信息
  - DefaultSocketChannelConfig
```
public DefaultSocketChannelConfig(SocketChannel channel,
                                  java.net.Socket javaSocket)
```
    创建一个新的实例。
- 方法详细信息
  - getOptions
```
public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
```
    从接口ChannelConfig复制的描述
    
    返回所有设置ChannelOption的。
    
    Specified by:
    
    getOptions在界面 ChannelConfig
    
    重写：
    
    getOptions DefaultChannelConfig
  - getOption
```
public <T> T getOption(ChannelOption<T> option)
```
    从界面复制的描述： ChannelConfig
    
    返回给定的ChannelOption的值
    
    Specified by:
    
    getOption ，界面 ChannelConfig
    
    重写：
    
    getOption在类 DefaultChannelConfig
  - setOption
```
public <T> boolean setOption(ChannelOption<T> option,
                             T value)
```
    从接口ChannelConfig复制的描述
    使用指定的名称和值设置配置属性。要正确覆盖此方法，您必须调用超类：
```
  public boolean setOption(ChannelOption<T> option, T value) {
     if (super.setOption(option, value)) {
         return true;
     }

     if (option.equals(additionalOption)) {
         ....
         return true;
     }

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

Class DefaultSocketChannelConfig

Field Summary

Fields inherited from class io.netty.channel.DefaultChannelConfig

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.DefaultChannelConfig

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelConfig

字段详细信息

javaSocket

构造方法详细信息

DefaultSocketChannelConfig

方法详细信息

getOptions

getOption

setOption

getReceiveBufferSize

getSendBufferSize

getSoLinger

getTrafficClass

isKeepAlive

isReuseAddress

isTcpNoDelay

setKeepAlive

setPerformancePreferences

setReceiveBufferSize

setReuseAddress

setSendBufferSize

setSoLinger

setTcpNoDelay

setTrafficClass

isAllowHalfClosure

setAllowHalfClosure

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setAutoClose

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setWriteBufferWaterMark

setMessageSizeEstimator