DatagramChannelConfig (Netty API Reference (4.1.22.Final))

All Superinterfaces:

ChannelConfig

All Known Subinterfaces:

OioDatagramChannelConfig

所有已知实现类：

DefaultDatagramChannelConfig ， EpollDatagramChannelConfig ， KQueueDatagramChannelConfig
```
public interface DatagramChannelConfig
extends ChannelConfig
```
A ChannelConfig为DatagramChannel 。
可用选项
除了ChannelConfig提供的选项外， DatagramChannelConfig还允许在选项图中使用以下选项： Name Associated setter method ChannelOption.SO_BROADCAST setBroadcast(boolean) ChannelOption.IP_MULTICAST_ADDR setInterface(InetAddress) ChannelOption.IP_MULTICAST_LOOP_DISABLED setLoopbackModeDisabled(boolean) ChannelOption.IP_MULTICAST_IF setNetworkInterface(NetworkInterface) ChannelOption.SO_REUSEADDR setReuseAddress(boolean) ChannelOption.SO_RCVBUF setReceiveBufferSize(int) ChannelOption.SO_SNDBUF setSendBufferSize(int) ChannelOption.IP_MULTICAST_TTL setTimeToLive(int) ChannelOption.IP_TOS setTrafficClass(int)

方法摘要

所有方法接口方法抽象方法弃用的方法
Modifier and Type	Method and Description
`java.net.InetAddress`	`getInterface()` 获取用于多播数据包的网络接口的地址。
`java.net.NetworkInterface`	`getNetworkInterface()` 获取 `StandardSocketOptions.IP_MULTICAST_IF`选项。
`int`	`getReceiveBufferSize()` 获取 `StandardSocketOptions.SO_RCVBUF`选项。
`int`	`getSendBufferSize()` 获取 `StandardSocketOptions.SO_SNDBUF`选项。
`int`	`getTimeToLive()` 获取 `StandardSocketOptions.IP_MULTICAST_TTL`选项。
`int`	`getTrafficClass()` 获取 `StandardSocketOptions.IP_TOS`选项。
`boolean`	`isBroadcast()` 获取 `StandardSocketOptions.SO_BROADCAST`选项。
`boolean`	`isLoopbackModeDisabled()` 获取 `StandardSocketOptions.IP_MULTICAST_LOOP`选项。
`boolean`	`isReuseAddress()` 获取 `StandardSocketOptions.SO_REUSEADDR`选项。
`DatagramChannelConfig`	`setAllocator(ByteBufAllocator allocator)` 设置用于通道分配缓冲区的`ByteBufAllocator` 。
`DatagramChannelConfig`	`setAutoClose(boolean autoClose)`
`DatagramChannelConfig`	`setAutoRead(boolean autoRead)` 设置是否自动调用 `ChannelHandlerContext.read()`，以便用户应用程序根本不需要调用它。
`DatagramChannelConfig`	`setBroadcast(boolean broadcast)` 设置 `StandardSocketOptions.SO_BROADCAST`选项。
`DatagramChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` 以毫秒为单位设置通道的连接超时。
`DatagramChannelConfig`	`setInterface(java.net.InetAddress interfaceAddress)` 设置用于多播数据包的网络接口的地址。
`DatagramChannelConfig`	`setLoopbackModeDisabled(boolean loopbackModeDisabled)` 设置 `StandardSocketOptions.IP_MULTICAST_LOOP`选项。
`DatagramChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`DatagramChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` 设置用于通道的`MessageSizeEstimator`以检测消息的大小。
`DatagramChannelConfig`	`setNetworkInterface(java.net.NetworkInterface networkInterface)` 设置 `StandardSocketOptions.IP_MULTICAST_IF`选项。
`DatagramChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)` 设置 `StandardSocketOptions.SO_RCVBUF`选项。
`DatagramChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` 设置用于通道分配接收缓冲区的`RecvByteBufAllocator` 。
`DatagramChannelConfig`	`setReuseAddress(boolean reuseAddress)` 获取 `StandardSocketOptions.SO_REUSEADDR`选项。
`DatagramChannelConfig`	`setSendBufferSize(int sendBufferSize)` 设置 `StandardSocketOptions.SO_SNDBUF`选项。
`DatagramChannelConfig`	`setTimeToLive(int ttl)` 设置 `StandardSocketOptions.IP_MULTICAST_TTL`选项。
`DatagramChannelConfig`	`setTrafficClass(int trafficClass)` 设置 `StandardSocketOptions.IP_TOS`选项。
`DatagramChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` 设置`WriteBufferWaterMark` ，用于设置写入缓冲区的高位和低位标记。
`DatagramChannelConfig`	`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

- 方法详细信息
  - getSendBufferSize
```
int getSendBufferSize()
```
    获取 StandardSocketOptions.SO_SNDBUF选项。
  - setSendBufferSize
```
DatagramChannelConfig setSendBufferSize(int sendBufferSize)
```
    设置 StandardSocketOptions.SO_SNDBUF选项。
  - getReceiveBufferSize
```
int getReceiveBufferSize()
```
    获取 StandardSocketOptions.SO_RCVBUF选项。
  - setReceiveBufferSize
```
DatagramChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    设置 StandardSocketOptions.SO_RCVBUF选项。
  - getTrafficClass
```
int getTrafficClass()
```
    获取 StandardSocketOptions.IP_TOS选项。
  - setTrafficClass
```
DatagramChannelConfig setTrafficClass(int trafficClass)
```
    设置 StandardSocketOptions.IP_TOS选项。
  - isReuseAddress
```
boolean isReuseAddress()
```
    获取 StandardSocketOptions.SO_REUSEADDR选项。
  - setReuseAddress
```
DatagramChannelConfig setReuseAddress(boolean reuseAddress)
```
    获取 StandardSocketOptions.SO_REUSEADDR选项。
  - isBroadcast
```
boolean isBroadcast()
```
    获取 StandardSocketOptions.SO_BROADCAST选项。
  - setBroadcast
```
DatagramChannelConfig setBroadcast(boolean broadcast)
```
    设置 StandardSocketOptions.SO_BROADCAST选项。
  - isLoopbackModeDisabled
```
boolean isLoopbackModeDisabled()
```
    获取 StandardSocketOptions.IP_MULTICAST_LOOP选项。
    
    结果
    
    true当且仅当环回模式已被禁用
  - setLoopbackModeDisabled
```
DatagramChannelConfig setLoopbackModeDisabled(boolean loopbackModeDisabled)
```
    设置 StandardSocketOptions.IP_MULTICAST_LOOP选项。
    
    参数
    
    loopbackModeDisabled - true当且仅当环回模式已被禁用
  - getTimeToLive
```
int getTimeToLive()
```
    获取 StandardSocketOptions.IP_MULTICAST_TTL选项。
  - setTimeToLive
```
DatagramChannelConfig setTimeToLive(int ttl)
```
    设置 StandardSocketOptions.IP_MULTICAST_TTL选项。
  - getInterface
```
java.net.InetAddress getInterface()
```
    获取用于多播数据包的网络接口的地址。
  - setInterface
```
DatagramChannelConfig setInterface(java.net.InetAddress interfaceAddress)
```
    设置用于多播数据包的网络接口的地址。
  - getNetworkInterface
```
java.net.NetworkInterface getNetworkInterface()
```
    获取 StandardSocketOptions.IP_MULTICAST_IF选项。
  - setNetworkInterface
```
DatagramChannelConfig setNetworkInterface(java.net.NetworkInterface networkInterface)
```
    设置 StandardSocketOptions.IP_MULTICAST_IF选项。
  - setMaxMessagesPerRead
```
@Deprecated
DatagramChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    Specified by:
    
    setMaxMessagesPerRead在界面 ChannelConfig
  - setWriteSpinCount
```
DatagramChannelConfig setWriteSpinCount(int writeSpinCount)
```
    从接口ChannelConfig复制的描述
    
    设置写入操作的最大循环数，直到WritableByteChannel.write(ByteBuffer)返回非零值。它类似于在并发编程中使用自旋锁。它可以提高内存利用率并根据运行JVM的平台来编写吞吐量。默认值是16 。
    
    Specified by:
    
    setWriteSpinCount在界面 ChannelConfig
  - setConnectTimeoutMillis
```
DatagramChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    从接口ChannelConfig复制的描述
    
    以毫秒为单位设置通道的连接超时。如果Channel不支持连接操作，则完全不使用此属性，因此将被忽略。
    
    Specified by:
    
    setConnectTimeoutMillis在界面 ChannelConfig
    
    参数
    
    connectTimeoutMillis - 以毫秒为单位的连接超时。 0禁用。
  - setAllocator
```
DatagramChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从界面复制的描述： ChannelConfig
    
    设置用于通道分配缓冲区的ByteBufAllocator 。
    
    Specified by:
    
    setAllocator在界面 ChannelConfig
  - setRecvByteBufAllocator
```
DatagramChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口ChannelConfig复制的描述
    
    设置用于通道分配接收缓冲区的RecvByteBufAllocator 。
    
    Specified by:
    
    setRecvByteBufAllocator在界面 ChannelConfig
  - setAutoRead
```
DatagramChannelConfig setAutoRead(boolean autoRead)
```
    从接口复制的描述： ChannelConfig
    
    设置是否将自动调用ChannelHandlerContext.read()，以便用户应用程序根本不需要调用它。默认值是true 。
    
    Specified by:
    
    setAutoRead在界面 ChannelConfig
  - setAutoClose
```
DatagramChannelConfig setAutoClose(boolean autoClose)
```
    Specified by:
    
    setAutoClose在界面 ChannelConfig
  - setMessageSizeEstimator
```
DatagramChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口ChannelConfig复制的描述
    
    设置用于通道的MessageSizeEstimator以检测消息的大小。
    
    Specified by:
    
    setMessageSizeEstimator在界面 ChannelConfig
  - setWriteBufferWaterMark
```
DatagramChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    从接口ChannelConfig复制的描述
    
    设置WriteBufferWaterMark用于设置写入缓冲区的高位和低位水印。
    
    Specified by:
    
    setWriteBufferWaterMark在界面 ChannelConfig

Interface DatagramChannelConfig

可用选项

方法摘要

Methods inherited from interface io.netty.channel.ChannelConfig

方法详细信息

getSendBufferSize

setSendBufferSize

getReceiveBufferSize

setReceiveBufferSize

getTrafficClass

setTrafficClass

isReuseAddress

setReuseAddress

isBroadcast

setBroadcast

isLoopbackModeDisabled

setLoopbackModeDisabled

getTimeToLive

setTimeToLive

getInterface

setInterface

getNetworkInterface

setNetworkInterface

setMaxMessagesPerRead

setWriteSpinCount

setConnectTimeoutMillis

setAllocator

setRecvByteBufAllocator

setAutoRead

setAutoClose

setMessageSizeEstimator

setWriteBufferWaterMark