Class KQueueDatagramChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.kqueue.KQueueChannelConfig

io.netty.channel.kqueue.KQueueDatagramChannelConfig

All Implemented Interfaces:

ChannelConfig, DatagramChannelConfig

public final class KQueueDatagramChannelConfig
extends KQueueChannelConfig
implements DatagramChannelConfig

Field Summary

Fields inherited from class DefaultChannelConfig

channel

Method Summary

Modifier and Type	Method	Description
InetAddress	getInterface()	Gets the address of the network interface used for multicast packets.
NetworkInterface	getNetworkInterface()	Gets the StandardSocketOptions.IP_MULTICAST_IF option.
<T> T	getOption(ChannelOption<T> option)	Return the value of the given ChannelOption
Map<ChannelOption<?>, 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(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)	Deprecated.
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(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)	Deprecated.
KQueueDatagramChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark)	Deprecated.
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.

Methods inherited from class KQueueChannelConfig

autoReadCleared, getRcvAllocTransportProvidesGuess

Methods inherited from class DefaultChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions, validate

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions

Method Details

getOptions

public Map<ChannelOption<?>, Object> getOptions()

Description copied from interface: ChannelConfig

Return all set ChannelOption's.

Specified by:

getOptions in interface ChannelConfig

Overrides:

getOptions in class KQueueChannelConfig

getOption

public <T> T getOption(ChannelOption<T> option)

Description copied from interface: ChannelConfig

Return the value of the given ChannelOption

Specified by:

getOption in interface ChannelConfig

Overrides:

getOption in class KQueueChannelConfig

setOption

public <T> boolean setOption(ChannelOption<T> option,
 T value)

Description copied from interface: 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;
}

Specified by:

setOption in interface ChannelConfig

Overrides:

setOption in class KQueueChannelConfig

Returns:

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 Channel.bind(java.net.SocketAddress) to have any affect.

setRcvAllocTransportProvidesGuess

public KQueueDatagramChannelConfig setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)

Description copied from class: 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.

Overrides:

setRcvAllocTransportProvidesGuess in class KQueueChannelConfig

setMessageSizeEstimator

public KQueueDatagramChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Description copied from interface: ChannelConfig

Set the MessageSizeEstimator which is used for the channel to detect the size of a message.

Specified by:

setMessageSizeEstimator in interface ChannelConfig

Specified by:

setMessageSizeEstimator in interface DatagramChannelConfig

Overrides:

setMessageSizeEstimator in class KQueueChannelConfig

setWriteBufferLowWaterMark

@Deprecated
public KQueueDatagramChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Deprecated.

Description copied from interface: 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.

Specified by:

setWriteBufferLowWaterMark in interface ChannelConfig

Overrides:

setWriteBufferLowWaterMark in class KQueueChannelConfig

setWriteBufferHighWaterMark

@Deprecated
public KQueueDatagramChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Deprecated.

Description copied from interface: 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.

Specified by:

setWriteBufferHighWaterMark in interface ChannelConfig

Overrides:

setWriteBufferHighWaterMark in class KQueueChannelConfig

setWriteBufferWaterMark

public KQueueDatagramChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Description copied from interface: ChannelConfig

Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.

Specified by:

setWriteBufferWaterMark in interface ChannelConfig

Specified by:

setWriteBufferWaterMark in interface DatagramChannelConfig

Overrides:

setWriteBufferWaterMark in class KQueueChannelConfig

setAutoClose

public KQueueDatagramChannelConfig setAutoClose(boolean autoClose)

Description copied from interface: ChannelConfig

Sets whether the Channel should be closed automatically and immediately on write failure. The default is true.

Specified by:

setAutoClose in interface ChannelConfig

Specified by:

setAutoClose in interface DatagramChannelConfig

Overrides:

setAutoClose in class DefaultChannelConfig

setAutoRead

public KQueueDatagramChannelConfig setAutoRead(boolean autoRead)

Description copied from interface: 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.

Specified by:

setAutoRead in interface ChannelConfig

Specified by:

setAutoRead in interface DatagramChannelConfig

Overrides:

setAutoRead in class KQueueChannelConfig

setRecvByteBufAllocator

public KQueueDatagramChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

Specified by:

setRecvByteBufAllocator in interface DatagramChannelConfig

Overrides:

setRecvByteBufAllocator in class KQueueChannelConfig

setWriteSpinCount

public KQueueDatagramChannelConfig setWriteSpinCount(int writeSpinCount)

Description copied from interface: 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.

Specified by:

setWriteSpinCount in interface ChannelConfig

Specified by:

setWriteSpinCount in interface DatagramChannelConfig

Overrides:

setWriteSpinCount in class KQueueChannelConfig

setAllocator

public KQueueDatagramChannelConfig setAllocator(ByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the ByteBufAllocator which is used for the channel to allocate buffers.

Specified by:

setAllocator in interface ChannelConfig

Specified by:

setAllocator in interface DatagramChannelConfig

Overrides:

setAllocator in class KQueueChannelConfig

setConnectTimeoutMillis

public KQueueDatagramChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Description copied from interface: 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.

Specified by:

setConnectTimeoutMillis in interface ChannelConfig

Specified by:

setConnectTimeoutMillis in interface DatagramChannelConfig

Overrides:

setConnectTimeoutMillis in class KQueueChannelConfig

Parameters:

connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.

setMaxMessagesPerRead

@Deprecated
public KQueueDatagramChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Description copied from class: DefaultChannelConfig

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface DatagramChannelConfig

Overrides:

setMaxMessagesPerRead in class KQueueChannelConfig

getSendBufferSize

public int getSendBufferSize()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

getSendBufferSize in interface DatagramChannelConfig

setSendBufferSize

public KQueueDatagramChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

setSendBufferSize in interface DatagramChannelConfig

getReceiveBufferSize

public int getReceiveBufferSize()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

getReceiveBufferSize in interface DatagramChannelConfig

setReceiveBufferSize

public KQueueDatagramChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

setReceiveBufferSize in interface DatagramChannelConfig

getTrafficClass

public int getTrafficClass()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.IP_TOS option.

Specified by:

getTrafficClass in interface DatagramChannelConfig

setTrafficClass

public KQueueDatagramChannelConfig setTrafficClass(int trafficClass)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_TOS option.

Specified by:

setTrafficClass in interface DatagramChannelConfig

isReuseAddress

public boolean isReuseAddress()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

isReuseAddress in interface DatagramChannelConfig

setReuseAddress

public KQueueDatagramChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface DatagramChannelConfig

isBroadcast

public boolean isBroadcast()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.SO_BROADCAST option.

Specified by:

isBroadcast in interface DatagramChannelConfig

setBroadcast

public KQueueDatagramChannelConfig setBroadcast(boolean broadcast)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.SO_BROADCAST option.

Specified by:

setBroadcast in interface DatagramChannelConfig

isLoopbackModeDisabled

public boolean isLoopbackModeDisabled()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.IP_MULTICAST_LOOP option.

Specified by:

isLoopbackModeDisabled in interface DatagramChannelConfig

Returns:

true if and only if the loopback mode has been disabled

setLoopbackModeDisabled

public DatagramChannelConfig setLoopbackModeDisabled(boolean loopbackModeDisabled)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_LOOP option.

Specified by:

setLoopbackModeDisabled in interface DatagramChannelConfig

Parameters:

loopbackModeDisabled - true if and only if the loopback mode has been disabled

getTimeToLive

public int getTimeToLive()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.IP_MULTICAST_TTL option.

Specified by:

getTimeToLive in interface DatagramChannelConfig

setTimeToLive

public KQueueDatagramChannelConfig setTimeToLive(int ttl)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_TTL option.

Specified by:

setTimeToLive in interface DatagramChannelConfig

getInterface

public InetAddress getInterface()

Description copied from interface: DatagramChannelConfig

Gets the address of the network interface used for multicast packets.

Specified by:

getInterface in interface DatagramChannelConfig

setInterface

public KQueueDatagramChannelConfig setInterface(InetAddress interfaceAddress)

Description copied from interface: DatagramChannelConfig

Sets the address of the network interface used for multicast packets.

Specified by:

setInterface in interface DatagramChannelConfig

getNetworkInterface

public NetworkInterface getNetworkInterface()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.IP_MULTICAST_IF option.

Specified by:

getNetworkInterface in interface DatagramChannelConfig

setNetworkInterface

public KQueueDatagramChannelConfig setNetworkInterface(NetworkInterface networkInterface)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_IF option.

Specified by:

setNetworkInterface in interface DatagramChannelConfig

setMaxMessagesPerWrite

public KQueueDatagramChannelConfig setMaxMessagesPerWrite(int maxMessagesPerWrite)

Description copied from class: 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.

Overrides:

setMaxMessagesPerWrite in class DefaultChannelConfig