Top Fields Constructors Methods
io.netty.channel.kqueue

public final Class KQueueDomainDatagramChannelConfig

extends KQueueChannelConfig
implements DomainDatagramChannelConfig
Class Inheritance
All Implemented Interfaces
io.netty.channel.unix.DomainDatagramChannelConfig, io.netty.channel.ChannelConfig
Annotations
@UnstableApi
Imports
io.netty.buffer.ByteBufAllocator, io.netty.channel.ChannelException, .ChannelOption, .FixedRecvByteBufAllocator, .MessageSizeEstimator, .RecvByteBufAllocator, .WriteBufferWaterMark, io.netty.channel.unix.DomainDatagramChannelConfig, io.netty.util.internal.UnstableApi, java.io.IOException, java.util.Map

Field Summary

Modifier and TypeField and Description
private boolean

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
pack-priv boolean
public <T> T
public Map<ChannelOption<?>, Object>
public int
private void
setActiveOnOpen(boolean activeOnOpen)

public KQueueDomainDatagramChannelConfig
public KQueueDomainDatagramChannelConfig
setAutoClose(boolean autoClose)

Overrides io.netty.channel.DefaultChannelConfig.setAutoClose.

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setAutoClose, io.netty.channel.ChannelConfig.setAutoClose.

Sets whether the Channel should be closed automatically and immediately on write failure.
public KQueueDomainDatagramChannelConfig
setAutoRead(boolean autoRead)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setAutoRead.

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setAutoRead, io.netty.channel.ChannelConfig.setAutoRead.

Sets if ChannelHandlerContext#read() will be invoked automatically so that a user application doesn't need to call it at all.
public KQueueDomainDatagramChannelConfig
setConnectTimeoutMillis(int
the connect timeout in milliseconds. 0 to disable.
connectTimeoutMillis
)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setConnectTimeoutMillis.

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setConnectTimeoutMillis, io.netty.channel.ChannelConfig.setConnectTimeoutMillis.

Sets the connect timeout of the channel in milliseconds.
public KQueueDomainDatagramChannelConfig
public KQueueDomainDatagramChannelConfig
setMaxMessagesPerWrite(int maxMessagesPerWrite)

Overrides io.netty.channel.DefaultChannelConfig.setMaxMessagesPerWrite.

Set the maximum number of message to write per eventloop run.
public KQueueDomainDatagramChannelConfig
public <T> boolean
setOption(ChannelOption<T> option, T value)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setOption.

Implements io.netty.channel.ChannelConfig.setOption.

Sets a configuration property with the specified name and value.
public KQueueDomainDatagramChannelConfig
setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setRcvAllocTransportProvidesGuess.

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.
public KQueueDomainDatagramChannelConfig
public KQueueDomainDatagramChannelConfig
public KQueueDomainDatagramChannelConfig
public KQueueDomainDatagramChannelConfig
Inherited from io.netty.channel.kqueue.KQueueChannelConfig:
autoReadClearedgetMaxBytesPerGatheringWritegetRcvAllocTransportProvidesGuesssetMaxBytesPerGatheringWritesetWriteBufferHighWaterMarksetWriteBufferLowWaterMark

Field Detail

activeOnOpenback to summary
private boolean activeOnOpen

Constructor Detail

KQueueDomainDatagramChannelConfigback to summary
pack-priv KQueueDomainDatagramChannelConfig(KQueueDomainDatagramChannel channel)

Method Detail

getActiveOnOpenback to summary
pack-priv boolean getActiveOnOpen()
getOptionback to summary
public <T> T getOption(ChannelOption<T> option)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.getOption.

Implements io.netty.channel.ChannelConfig.getOption.

Doc from io.netty.channel.ChannelConfig.getOption.

Return the value of the given ChannelOption

Annotations
@Override
@SuppressWarnings:unchecked, deprecation
getOptionsback to summary
public Map<ChannelOption<?>, Object> getOptions()

Overrides io.netty.channel.kqueue.KQueueChannelConfig.getOptions.

Implements io.netty.channel.ChannelConfig.getOptions.

Doc from io.netty.channel.ChannelConfig.getOptions.

Return all set ChannelOption's.

Annotations
@Override
@SuppressWarnings:deprecation
getSendBufferSizeback to summary
public int getSendBufferSize()

Implements io.netty.channel.unix.DomainDatagramChannelConfig.getSendBufferSize.

Doc from io.netty.channel.unix.DomainDatagramChannelConfig.getSendBufferSize.

Gets the java.net.StandardSocketOptions#SO_SNDBUF option.

Annotations
@Override
setActiveOnOpenback to summary
private void setActiveOnOpen(boolean activeOnOpen)
setAllocatorback to summary
public KQueueDomainDatagramChannelConfig setAllocator(ByteBufAllocator allocator)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setAllocator.

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setAllocator, io.netty.channel.ChannelConfig.setAllocator.

Doc from io.netty.channel.ChannelConfig.setAllocator.

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

Annotations
@Override
setAutoCloseback to summary
public KQueueDomainDatagramChannelConfig setAutoClose(boolean autoClose)

Overrides io.netty.channel.DefaultChannelConfig.setAutoClose.

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setAutoClose, io.netty.channel.ChannelConfig.setAutoClose.

Doc from io.netty.channel.ChannelConfig.setAutoClose.

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

Annotations
@Override
setAutoReadback to summary
public KQueueDomainDatagramChannelConfig setAutoRead(boolean autoRead)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setAutoRead.

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setAutoRead, io.netty.channel.ChannelConfig.setAutoRead.

Doc from io.netty.channel.ChannelConfig.setAutoRead.

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.

Annotations
@Override
setConnectTimeoutMillisback to summary
public KQueueDomainDatagramChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setConnectTimeoutMillis.

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setConnectTimeoutMillis, io.netty.channel.ChannelConfig.setConnectTimeoutMillis.

Doc from io.netty.channel.ChannelConfig.setConnectTimeoutMillis.

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.

Parameters
connectTimeoutMillis:int

the connect timeout in milliseconds. 0 to disable.

Annotations
@Override
setMaxMessagesPerReadback to summary
public KQueueDomainDatagramChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setMaxMessagesPerRead.

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setMaxMessagesPerRead, io.netty.channel.ChannelConfig.setMaxMessagesPerRead.

Doc from io.netty.channel.DefaultChannelConfig.setMaxMessagesPerRead.

Deprecated

Annotations
@Override
@Deprecated
setMaxMessagesPerWriteback to summary
public KQueueDomainDatagramChannelConfig setMaxMessagesPerWrite(int maxMessagesPerWrite)

Overrides io.netty.channel.DefaultChannelConfig.setMaxMessagesPerWrite.

Doc from io.netty.channel.DefaultChannelConfig.setMaxMessagesPerWrite.

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.

Annotations
@Override
setMessageSizeEstimatorback to summary
public KQueueDomainDatagramChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setMessageSizeEstimator.

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setMessageSizeEstimator, io.netty.channel.ChannelConfig.setMessageSizeEstimator.

Doc from io.netty.channel.ChannelConfig.setMessageSizeEstimator.

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

Annotations
@Override
setOptionback to summary
public <T> boolean setOption(ChannelOption<T> option, T value)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setOption.

Implements io.netty.channel.ChannelConfig.setOption.

Doc from io.netty.channel.ChannelConfig.setOption.

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;
}
Returns:boolean

true if and only if the property has been set

Annotations
@Override
@SuppressWarnings:deprecation
setRcvAllocTransportProvidesGuessback to summary
public KQueueDomainDatagramChannelConfig setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setRcvAllocTransportProvidesGuess.

Doc from io.netty.channel.kqueue.KQueueChannelConfig.setRcvAllocTransportProvidesGuess.

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.

Annotations
@Override
setRecvByteBufAllocatorback to summary
public KQueueDomainDatagramChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setRecvByteBufAllocator.

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setRecvByteBufAllocator, io.netty.channel.ChannelConfig.setRecvByteBufAllocator.

Doc from io.netty.channel.ChannelConfig.setRecvByteBufAllocator.

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

Annotations
@Override
setSendBufferSizeback to summary
public KQueueDomainDatagramChannelConfig setSendBufferSize(int sendBufferSize)

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setSendBufferSize.

Doc from io.netty.channel.unix.DomainDatagramChannelConfig.setSendBufferSize.

Sets the java.net.StandardSocketOptions#SO_SNDBUF option.

Annotations
@Override
setWriteBufferWaterMarkback to summary
public KQueueDomainDatagramChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setWriteBufferWaterMark.

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setWriteBufferWaterMark, io.netty.channel.ChannelConfig.setWriteBufferWaterMark.

Doc from io.netty.channel.ChannelConfig.setWriteBufferWaterMark.

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

Annotations
@Override
setWriteSpinCountback to summary
public KQueueDomainDatagramChannelConfig setWriteSpinCount(int writeSpinCount)

Overrides io.netty.channel.kqueue.KQueueChannelConfig.setWriteSpinCount.

Implements io.netty.channel.unix.DomainDatagramChannelConfig.setWriteSpinCount, io.netty.channel.ChannelConfig.setWriteSpinCount.

Doc from io.netty.channel.ChannelConfig.setWriteSpinCount.

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.

Annotations
@Override