KQueueDatagramChannelConfig (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.channel.DefaultChannelConfig
- - io.netty.channel.kqueue.KQueueChannelConfig
  - - io.netty.channel.kqueue.KQueueDatagramChannelConfig

所有已实现的接口:: ChannelConfig, DatagramChannelConfig

@UnstableApi
public final class KQueueDatagramChannelConfig
extends KQueueChannelConfig
implements DatagramChannelConfig

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

方法概要

All Methods Instance Methods Concrete Methods Deprecated Methods
限定符和类型	方法和说明
`java.net.InetAddress`	`getInterface()` Gets the address of the network interface used for multicast packets.
`java.net.NetworkInterface`	`getNetworkInterface()` Gets the `StandardSocketOptions.IP_MULTICAST_IF` option.
`<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`	`getReceiveBufferSize()` Gets the `StandardSocketOptions.SO_RCVBUF` option.
`int`	`getSendBufferSize()` Gets the `StandardSocketOptions.SO_SNDBUF` option.
`int`	`getTimeToLive()` Gets the `StandardSocketOptions.IP_MULTICAST_TTL` option.
`int`	`getTrafficClass()` Gets the `StandardSocketOptions.IP_TOS` option.
`boolean`	`isBroadcast()` Gets the `StandardSocketOptions.SO_BROADCAST` option.
`boolean`	`isLoopbackModeDisabled()` Gets the `StandardSocketOptions.IP_MULTICAST_LOOP` option.
`boolean`	`isReuseAddress()` Gets the `StandardSocketOptions.SO_REUSEADDR` option.
`boolean`	`isReusePort()` Returns `true` if the SO_REUSEPORT option is set.
`KQueueDatagramChannelConfig`	`setAllocator(ByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
`KQueueDatagramChannelConfig`	`setAutoClose(boolean autoClose)` Sets whether the `Channel` should be closed automatically and immediately on write failure.
`KQueueDatagramChannelConfig`	`setAutoRead(boolean autoRead)` Sets if `ChannelHandlerContext.read()` will be invoked automatically so that a user application doesn't need to call it at all.
`KQueueDatagramChannelConfig`	`setBroadcast(boolean broadcast)` Sets the `StandardSocketOptions.SO_BROADCAST` option.
`KQueueDatagramChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`KQueueDatagramChannelConfig`	`setInterface(java.net.InetAddress interfaceAddress)` Sets the address of the network interface used for multicast packets.
`DatagramChannelConfig`	`setLoopbackModeDisabled(boolean loopbackModeDisabled)` Sets the `StandardSocketOptions.IP_MULTICAST_LOOP` option.
`KQueueDatagramChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` 已过时。
`KQueueDatagramChannelConfig`	`setMaxMessagesPerWrite(int maxMessagesPerWrite)` Set the maximum number of message to write per eventloop run.
`KQueueDatagramChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` Set the `MessageSizeEstimator` which is used for the channel to detect the size of a message.
`KQueueDatagramChannelConfig`	`setNetworkInterface(java.net.NetworkInterface networkInterface)` Sets the `StandardSocketOptions.IP_MULTICAST_IF` option.
`<T> boolean`	`setOption(ChannelOption<T> option, T value)` Sets a configuration property with the specified name and value.
`KQueueDatagramChannelConfig`	`setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)` If this is `true` then the `RecvByteBufAllocator.Handle#guess()` will be overridden to always attempt to read as many bytes as kqueue says are available.
`KQueueDatagramChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)` Sets the `StandardSocketOptions.SO_RCVBUF` option.
`KQueueDatagramChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` Set the `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.
`KQueueDatagramChannelConfig`	`setReuseAddress(boolean reuseAddress)` Gets the `StandardSocketOptions.SO_REUSEADDR` option.
`KQueueDatagramChannelConfig`	`setReusePort(boolean reusePort)` Set the SO_REUSEPORT option on the underlying Channel.
`KQueueDatagramChannelConfig`	`setSendBufferSize(int sendBufferSize)` Sets the `StandardSocketOptions.SO_SNDBUF` option.
`KQueueDatagramChannelConfig`	`setTimeToLive(int ttl)` Sets the `StandardSocketOptions.IP_MULTICAST_TTL` option.
`KQueueDatagramChannelConfig`	`setTrafficClass(int trafficClass)` Sets the `StandardSocketOptions.IP_TOS` option.
`KQueueDatagramChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` 已过时。
`KQueueDatagramChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` 已过时。
`KQueueDatagramChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` Set the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.
`KQueueDatagramChannelConfig`	`setWriteSpinCount(int writeSpinCount)` Sets the maximum loop count for a write operation until `WritableByteChannel.write(ByteBuffer)` returns a non-zero value.

从类继承的方法 io.netty.channel.kqueue.KQueueChannelConfig
autoReadCleared, getRcvAllocTransportProvidesGuess

从类继承的方法 io.netty.channel.DefaultChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions, validate

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

- 方法详细资料
  - getOptions
```
public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
```
    从接口复制的说明: ChannelConfig
    
    Return all set ChannelOption's.
    
    指定者:
    
    getOptions 在接口中 ChannelConfig
    
    覆盖:
    
    getOptions 在类中 KQueueChannelConfig
  - getOption
```
public <T> T getOption(ChannelOption<T> option)
```
    从接口复制的说明: ChannelConfig
    
    Return the value of the given ChannelOption
    
    指定者:
    
    getOption 在接口中 ChannelConfig
    
    覆盖:
    
    getOption 在类中 KQueueChannelConfig
  - 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 在类中 KQueueChannelConfig
    
    返回:
    
    true if and only if the property has been set
  - isReusePort
```
public boolean isReusePort()
```
    Returns true if the SO_REUSEPORT option is set.
  - setReusePort
```
public KQueueDatagramChannelConfig setReusePort(boolean reusePort)
```
    Set the SO_REUSEPORT option on the underlying Channel. This will allow to bind multiple KQueueSocketChannels to the same port and so accept connections with multiple threads. Be aware this method needs be called before AbstractChannel.bind(java.net.SocketAddress) to have any affect.
  - setRcvAllocTransportProvidesGuess
```
public KQueueDatagramChannelConfig setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)
```
    从类复制的说明: KQueueChannelConfig
    
    If this is true then the RecvByteBufAllocator.Handle#guess() will be overridden to always attempt to read as many bytes as kqueue says are available.
    
    覆盖:
    
    setRcvAllocTransportProvidesGuess 在类中 KQueueChannelConfig
  - setMessageSizeEstimator
```
public KQueueDatagramChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    从接口复制的说明: ChannelConfig
    
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ChannelConfig
    
    指定者:
    
    setMessageSizeEstimator 在接口中 DatagramChannelConfig
    
    覆盖:
    
    setMessageSizeEstimator 在类中 KQueueChannelConfig
  - setWriteBufferLowWaterMark
```
@Deprecated
public KQueueDatagramChannelConfig 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 在类中 KQueueChannelConfig
  - setWriteBufferHighWaterMark
```
@Deprecated
public KQueueDatagramChannelConfig 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 在类中 KQueueChannelConfig
  - setWriteBufferWaterMark
```
public KQueueDatagramChannelConfig 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 在接口中 DatagramChannelConfig
    
    覆盖:
    
    setWriteBufferWaterMark 在类中 KQueueChannelConfig
  - setAutoClose
```
public KQueueDatagramChannelConfig setAutoClose(boolean autoClose)
```
    从接口复制的说明: ChannelConfig
    
    Sets whether the Channel should be closed automatically and immediately on write failure. The default is true.
    
    指定者:
    
    setAutoClose 在接口中 ChannelConfig
    
    指定者:
    
    setAutoClose 在接口中 DatagramChannelConfig
    
    覆盖:
    
    setAutoClose 在类中 DefaultChannelConfig
  - setAutoRead
```
public KQueueDatagramChannelConfig 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 在接口中 DatagramChannelConfig
    
    覆盖:
    
    setAutoRead 在类中 KQueueChannelConfig
  - setRecvByteBufAllocator
```
public KQueueDatagramChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 DatagramChannelConfig
    
    覆盖:
    
    setRecvByteBufAllocator 在类中 KQueueChannelConfig
  - setWriteSpinCount
```
public KQueueDatagramChannelConfig 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 在接口中 DatagramChannelConfig
    
    覆盖:
    
    setWriteSpinCount 在类中 KQueueChannelConfig
  - setAllocator
```
public KQueueDatagramChannelConfig setAllocator(ByteBufAllocator allocator)
```
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    setAllocator 在接口中 ChannelConfig
    
    指定者:
    
    setAllocator 在接口中 DatagramChannelConfig
    
    覆盖:
    
    setAllocator 在类中 KQueueChannelConfig
  - setConnectTimeoutMillis
```
public KQueueDatagramChannelConfig 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 在接口中 DatagramChannelConfig
    
    覆盖:
    
    setConnectTimeoutMillis 在类中 KQueueChannelConfig
    
    参数:
    
    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.
  - setMaxMessagesPerRead
```
@Deprecated
public KQueueDatagramChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    从类复制的说明: DefaultChannelConfig
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 ChannelConfig
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 DatagramChannelConfig
    
    覆盖:
    
    setMaxMessagesPerRead 在类中 KQueueChannelConfig
  - getSendBufferSize
```
public int getSendBufferSize()
```
    从接口复制的说明: DatagramChannelConfig
    
    Gets the StandardSocketOptions.SO_SNDBUF option.
    
    指定者:
    
    getSendBufferSize 在接口中 DatagramChannelConfig
  - setSendBufferSize
```
public KQueueDatagramChannelConfig setSendBufferSize(int sendBufferSize)
```
    从接口复制的说明: DatagramChannelConfig
    
    Sets the StandardSocketOptions.SO_SNDBUF option.
    
    指定者:
    
    setSendBufferSize 在接口中 DatagramChannelConfig
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    从接口复制的说明: DatagramChannelConfig
    
    Gets the StandardSocketOptions.SO_RCVBUF option.
    
    指定者:
    
    getReceiveBufferSize 在接口中 DatagramChannelConfig
  - setReceiveBufferSize
```
public KQueueDatagramChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    从接口复制的说明: DatagramChannelConfig
    
    Sets the StandardSocketOptions.SO_RCVBUF option.
    
    指定者:
    
    setReceiveBufferSize 在接口中 DatagramChannelConfig
  - getTrafficClass
```
public int getTrafficClass()
```
    从接口复制的说明: DatagramChannelConfig
    
    Gets the StandardSocketOptions.IP_TOS option.
    
    指定者:
    
    getTrafficClass 在接口中 DatagramChannelConfig
  - setTrafficClass
```
public KQueueDatagramChannelConfig setTrafficClass(int trafficClass)
```
    从接口复制的说明: DatagramChannelConfig
    
    Sets the StandardSocketOptions.IP_TOS option.
    
    指定者:
    
    setTrafficClass 在接口中 DatagramChannelConfig
  - isReuseAddress
```
public boolean isReuseAddress()
```
    从接口复制的说明: DatagramChannelConfig
    
    Gets the StandardSocketOptions.SO_REUSEADDR option.
    
    指定者:
    
    isReuseAddress 在接口中 DatagramChannelConfig
  - setReuseAddress
```
public KQueueDatagramChannelConfig setReuseAddress(boolean reuseAddress)
```
    从接口复制的说明: DatagramChannelConfig
    
    Gets the StandardSocketOptions.SO_REUSEADDR option.
    
    指定者:
    
    setReuseAddress 在接口中 DatagramChannelConfig
  - isBroadcast
```
public boolean isBroadcast()
```
    从接口复制的说明: DatagramChannelConfig
    
    Gets the StandardSocketOptions.SO_BROADCAST option.
    
    指定者:
    
    isBroadcast 在接口中 DatagramChannelConfig
  - setBroadcast
```
public KQueueDatagramChannelConfig setBroadcast(boolean broadcast)
```
    从接口复制的说明: DatagramChannelConfig
    
    Sets the StandardSocketOptions.SO_BROADCAST option.
    
    指定者:
    
    setBroadcast 在接口中 DatagramChannelConfig
  - isLoopbackModeDisabled
```
public boolean isLoopbackModeDisabled()
```
    从接口复制的说明: DatagramChannelConfig
    
    Gets the StandardSocketOptions.IP_MULTICAST_LOOP option.
    
    指定者:
    
    isLoopbackModeDisabled 在接口中 DatagramChannelConfig
    
    返回:
    
    true if and only if the loopback mode has been disabled
  - setLoopbackModeDisabled
```
public DatagramChannelConfig setLoopbackModeDisabled(boolean loopbackModeDisabled)
```
    从接口复制的说明: DatagramChannelConfig
    
    Sets the StandardSocketOptions.IP_MULTICAST_LOOP option.
    
    指定者:
    
    setLoopbackModeDisabled 在接口中 DatagramChannelConfig
    
    参数:
    
    loopbackModeDisabled - true if and only if the loopback mode has been disabled
  - getTimeToLive
```
public int getTimeToLive()
```
    从接口复制的说明: DatagramChannelConfig
    
    Gets the StandardSocketOptions.IP_MULTICAST_TTL option.
    
    指定者:
    
    getTimeToLive 在接口中 DatagramChannelConfig
  - setTimeToLive
```
public KQueueDatagramChannelConfig setTimeToLive(int ttl)
```
    从接口复制的说明: DatagramChannelConfig
    
    Sets the StandardSocketOptions.IP_MULTICAST_TTL option.
    
    指定者:
    
    setTimeToLive 在接口中 DatagramChannelConfig
  - getInterface
```
public java.net.InetAddress getInterface()
```
    从接口复制的说明: DatagramChannelConfig
    
    Gets the address of the network interface used for multicast packets.
    
    指定者:
    
    getInterface 在接口中 DatagramChannelConfig
  - setInterface
```
public KQueueDatagramChannelConfig setInterface(java.net.InetAddress interfaceAddress)
```
    从接口复制的说明: DatagramChannelConfig
    
    Sets the address of the network interface used for multicast packets.
    
    指定者:
    
    setInterface 在接口中 DatagramChannelConfig
  - getNetworkInterface
```
public java.net.NetworkInterface getNetworkInterface()
```
    从接口复制的说明: DatagramChannelConfig
    
    Gets the StandardSocketOptions.IP_MULTICAST_IF option.
    
    指定者:
    
    getNetworkInterface 在接口中 DatagramChannelConfig
  - setNetworkInterface
```
public KQueueDatagramChannelConfig setNetworkInterface(java.net.NetworkInterface networkInterface)
```
    从接口复制的说明: DatagramChannelConfig
    
    Sets the StandardSocketOptions.IP_MULTICAST_IF option.
    
    指定者:
    
    setNetworkInterface 在接口中 DatagramChannelConfig
  - setMaxMessagesPerWrite
```
public KQueueDatagramChannelConfig setMaxMessagesPerWrite(int maxMessagesPerWrite)
```
    从类复制的说明: DefaultChannelConfig
    
    Set the maximum number of message to write per eventloop run. Once this limit is reached we will continue to process other events before trying to write the remaining messages.
    
    覆盖:
    
    setMaxMessagesPerWrite 在类中 DefaultChannelConfig

类 KQueueDatagramChannelConfig

字段概要

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

方法概要

从类继承的方法 io.netty.channel.kqueue.KQueueChannelConfig

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

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

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

方法详细资料

getOptions

getOption

setOption

isReusePort

setReusePort

setRcvAllocTransportProvidesGuess

setMessageSizeEstimator

setWriteBufferLowWaterMark

setWriteBufferHighWaterMark

setWriteBufferWaterMark

setAutoClose

setAutoRead

setRecvByteBufAllocator

setWriteSpinCount

setAllocator

setConnectTimeoutMillis

setMaxMessagesPerRead

getSendBufferSize

setSendBufferSize

getReceiveBufferSize

setReceiveBufferSize

getTrafficClass

setTrafficClass

isReuseAddress

setReuseAddress

isBroadcast

setBroadcast

isLoopbackModeDisabled

setLoopbackModeDisabled

getTimeToLive

setTimeToLive

getInterface

setInterface

getNetworkInterface

setNetworkInterface

setMaxMessagesPerWrite