io.netty.channel.kqueue

Class KQueueDomainDatagramChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.kqueue.KQueueChannelConfig

io.netty.channel.kqueue.KQueueDomainDatagramChannelConfig

All Implemented Interfaces:

ChannelConfig, DomainDatagramChannelConfig

public final class KQueueDomainDatagramChannelConfig
extends KQueueChannelConfig
implements DomainDatagramChannelConfig

Field Summary

Fields inherited from class io.netty.channel.DefaultChannelConfig

channel

Method Summary

Modifier and Type	Method and Description
<T> T	getOption(ChannelOption<T> option) Return the value of the given ChannelOption
Map<ChannelOption<?>,Object>	getOptions() Return all set ChannelOption's.
int	getSendBufferSize() Gets the StandardSocketOptions.SO_SNDBUF option.
KQueueDomainDatagramChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
KQueueDomainDatagramChannelConfig	setAutoClose(boolean autoClose) Sets whether the Channel should be closed automatically and immediately on write failure.
KQueueDomainDatagramChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
KQueueDomainDatagramChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
KQueueDomainDatagramChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Deprecated.
KQueueDomainDatagramChannelConfig	setMaxMessagesPerWrite(int maxMessagesPerWrite) Set the maximum number of message to write per eventloop run.
KQueueDomainDatagramChannelConfig	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.
KQueueDomainDatagramChannelConfig	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.
KQueueDomainDatagramChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
KQueueDomainDatagramChannelConfig	setSendBufferSize(int sendBufferSize) Sets the StandardSocketOptions.SO_SNDBUF option.
KQueueDomainDatagramChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
KQueueDomainDatagramChannelConfig	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 io.netty.channel.kqueue.KQueueChannelConfig

autoReadCleared, getRcvAllocTransportProvidesGuess, setWriteBufferHighWaterMark, setWriteBufferLowWaterMark

Methods inherited from class io.netty.channel.DefaultChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, 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, setWriteBufferHighWaterMark, setWriteBufferLowWaterMark

Method Detail

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

setAllocator

public KQueueDomainDatagramChannelConfig 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 DomainDatagramChannelConfig

Overrides:

setAllocator in class KQueueChannelConfig

setAutoClose

public KQueueDomainDatagramChannelConfig 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 DomainDatagramChannelConfig

Overrides:

setAutoClose in class DefaultChannelConfig

setAutoRead

public KQueueDomainDatagramChannelConfig 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 DomainDatagramChannelConfig

Overrides:

setAutoRead in class KQueueChannelConfig

setConnectTimeoutMillis

public KQueueDomainDatagramChannelConfig 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 DomainDatagramChannelConfig

Overrides:

setConnectTimeoutMillis in class KQueueChannelConfig

Parameters:

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

setMaxMessagesPerRead

@Deprecated
public KQueueDomainDatagramChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Description copied from class: DefaultChannelConfig

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface DomainDatagramChannelConfig

Overrides:

setMaxMessagesPerRead in class KQueueChannelConfig

setMaxMessagesPerWrite

public KQueueDomainDatagramChannelConfig 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

setMessageSizeEstimator

public KQueueDomainDatagramChannelConfig 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 DomainDatagramChannelConfig

Overrides:

setMessageSizeEstimator in class KQueueChannelConfig

setRcvAllocTransportProvidesGuess

public KQueueDomainDatagramChannelConfig 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

setRecvByteBufAllocator

public KQueueDomainDatagramChannelConfig 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 DomainDatagramChannelConfig

Overrides:

setRecvByteBufAllocator in class KQueueChannelConfig

setSendBufferSize

public KQueueDomainDatagramChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: DomainDatagramChannelConfig

Sets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

setSendBufferSize in interface DomainDatagramChannelConfig

getSendBufferSize

public int getSendBufferSize()

Description copied from interface: DomainDatagramChannelConfig

Gets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

getSendBufferSize in interface DomainDatagramChannelConfig

setWriteBufferWaterMark

public KQueueDomainDatagramChannelConfig 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 DomainDatagramChannelConfig

Overrides:

setWriteBufferWaterMark in class KQueueChannelConfig

setWriteSpinCount

public KQueueDomainDatagramChannelConfig 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 DomainDatagramChannelConfig

Overrides:

setWriteSpinCount in class KQueueChannelConfig