Top Constructors Methods
io.netty.channel.socket.oio

pack-priv final Class DefaultOioDatagramChannelConfig

extends DefaultDatagramChannelConfig
implements OioDatagramChannelConfig
Class Inheritance
All Implemented Interfaces
io.netty.channel.socket.oio.OioDatagramChannelConfig, io.netty.channel.socket.DatagramChannelConfig, io.netty.channel.ChannelConfig
Imports
io.netty.buffer.ByteBufAllocator, io.netty.channel.ChannelException, .ChannelOption, .MessageSizeEstimator, .PreferHeapByteBufAllocator, .RecvByteBufAllocator, .WriteBufferWaterMark, io.netty.channel.socket.DatagramChannel, .DefaultDatagramChannelConfig, java.io.IOException, java.net.DatagramSocket, .InetAddress, .NetworkInterface, java.util.Map

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public <T> T
public Map<ChannelOption<?>, Object>
public int
getSoTimeout()

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.getSoTimeout.

Returns the maximal time a operation on the underlying socket may block.
public OioDatagramChannelConfig
public OioDatagramChannelConfig
public OioDatagramChannelConfig
setAutoRead(boolean autoRead)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setAutoRead.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setAutoRead, io.netty.channel.socket.DatagramChannelConfig.setAutoRead, io.netty.channel.ChannelConfig.setAutoRead.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets if ChannelHandlerContext#read() will be invoked automatically so that a user application doesn't need to call it at all.
public OioDatagramChannelConfig
public OioDatagramChannelConfig
public OioDatagramChannelConfig
setInterface(InetAddress interfaceAddress)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setInterface.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setInterface, io.netty.channel.socket.DatagramChannelConfig.setInterface.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets the address of the network interface used for multicast packets.
public OioDatagramChannelConfig
public OioDatagramChannelConfig
public OioDatagramChannelConfig
public OioDatagramChannelConfig
public <T> boolean
setOption(ChannelOption<T> option, T value)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setOption.

Implements io.netty.channel.ChannelConfig.setOption.

Sets a configuration property with the specified name and value.
public OioDatagramChannelConfig
public OioDatagramChannelConfig
public OioDatagramChannelConfig
public OioDatagramChannelConfig
public OioDatagramChannelConfig
setSoTimeout(int timeout)

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setSoTimeout.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets the maximal time a operation on the underlying socket may block.
public OioDatagramChannelConfig
public OioDatagramChannelConfig
public OioDatagramChannelConfig
public OioDatagramChannelConfig
public OioDatagramChannelConfig
public OioDatagramChannelConfig
Inherited from io.netty.channel.socket.DefaultDatagramChannelConfig:
getInterfacegetNetworkInterfacegetReceiveBufferSizegetSendBufferSizegetTimeToLivegetTrafficClassisBroadcastisLoopbackModeDisabledisReuseAddressjavaSocketsetMaxMessagesPerWrite

Constructor Detail

DefaultOioDatagramChannelConfigback to summary
pack-priv DefaultOioDatagramChannelConfig(DatagramChannel channel, DatagramSocket javaSocket)

Method Detail

getOptionback to summary
public <T> T getOption(ChannelOption<T> option)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.getOption.

Implements io.netty.channel.ChannelConfig.getOption.

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

Return the value of the given ChannelOption

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

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.getOptions.

Implements io.netty.channel.ChannelConfig.getOptions.

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

Return all set ChannelOption's.

Annotations
@Override
getSoTimeoutback to summary
public int getSoTimeout()

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.getSoTimeout.

Doc from io.netty.channel.socket.oio.OioDatagramChannelConfig.getSoTimeout.

Returns the maximal time a operation on the underlying socket may block.

Annotations
@Override
setAllocatorback to summary
public OioDatagramChannelConfig setAllocator(ByteBufAllocator allocator)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setAllocator.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setAllocator, io.netty.channel.socket.DatagramChannelConfig.setAllocator, io.netty.channel.ChannelConfig.setAllocator.

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

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

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

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

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setAutoClose.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setAutoClose, io.netty.channel.socket.DatagramChannelConfig.setAutoClose, io.netty.channel.ChannelConfig.setAutoClose.

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

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

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

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

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setAutoRead.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setAutoRead, io.netty.channel.socket.DatagramChannelConfig.setAutoRead, io.netty.channel.ChannelConfig.setAutoRead.

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

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

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
setBroadcastback to summary
public OioDatagramChannelConfig setBroadcast(boolean broadcast)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setBroadcast.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setBroadcast, io.netty.channel.socket.DatagramChannelConfig.setBroadcast.

Doc from io.netty.channel.socket.DatagramChannelConfig.setBroadcast.

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

Sets the StandardSocketOptions#SO_BROADCAST option.

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

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setConnectTimeoutMillis.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setConnectTimeoutMillis, io.netty.channel.socket.DatagramChannelConfig.setConnectTimeoutMillis, io.netty.channel.ChannelConfig.setConnectTimeoutMillis.

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

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

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
setInterfaceback to summary
public OioDatagramChannelConfig setInterface(InetAddress interfaceAddress)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setInterface.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setInterface, io.netty.channel.socket.DatagramChannelConfig.setInterface.

Doc from io.netty.channel.socket.DatagramChannelConfig.setInterface.

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

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

Annotations
@Override
setLoopbackModeDisabledback to summary
public OioDatagramChannelConfig setLoopbackModeDisabled(boolean loopbackModeDisabled)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setLoopbackModeDisabled.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setLoopbackModeDisabled, io.netty.channel.socket.DatagramChannelConfig.setLoopbackModeDisabled.

Doc from io.netty.channel.socket.DatagramChannelConfig.setLoopbackModeDisabled.

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

Sets the StandardSocketOptions#IP_MULTICAST_LOOP option.

Parameters
loopbackModeDisabled:boolean

true if and only if the loopback mode has been disabled

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

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setMaxMessagesPerRead.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setMaxMessagesPerRead, io.netty.channel.socket.DatagramChannelConfig.setMaxMessagesPerRead, io.netty.channel.ChannelConfig.setMaxMessagesPerRead.

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

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

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

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setMessageSizeEstimator.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setMessageSizeEstimator, io.netty.channel.socket.DatagramChannelConfig.setMessageSizeEstimator, io.netty.channel.ChannelConfig.setMessageSizeEstimator.

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

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

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

Annotations
@Override
setNetworkInterfaceback to summary
public OioDatagramChannelConfig setNetworkInterface(NetworkInterface networkInterface)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setNetworkInterface.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setNetworkInterface, io.netty.channel.socket.DatagramChannelConfig.setNetworkInterface.

Doc from io.netty.channel.socket.DatagramChannelConfig.setNetworkInterface.

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

Sets the StandardSocketOptions#IP_MULTICAST_IF option.

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

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.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
setReceiveBufferSizeback to summary
public OioDatagramChannelConfig setReceiveBufferSize(int receiveBufferSize)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setReceiveBufferSize.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setReceiveBufferSize, io.netty.channel.socket.DatagramChannelConfig.setReceiveBufferSize.

Doc from io.netty.channel.socket.DatagramChannelConfig.setReceiveBufferSize.

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

Sets the StandardSocketOptions#SO_RCVBUF option.

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

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setRecvByteBufAllocator.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setRecvByteBufAllocator, io.netty.channel.socket.DatagramChannelConfig.setRecvByteBufAllocator, io.netty.channel.ChannelConfig.setRecvByteBufAllocator.

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

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

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

Annotations
@Override
setReuseAddressback to summary
public OioDatagramChannelConfig setReuseAddress(boolean reuseAddress)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setReuseAddress.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setReuseAddress, io.netty.channel.socket.DatagramChannelConfig.setReuseAddress.

Doc from io.netty.channel.socket.DatagramChannelConfig.setReuseAddress.

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

Gets the StandardSocketOptions#SO_REUSEADDR option.

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

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setSendBufferSize.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setSendBufferSize, io.netty.channel.socket.DatagramChannelConfig.setSendBufferSize.

Doc from io.netty.channel.socket.DatagramChannelConfig.setSendBufferSize.

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

Sets the StandardSocketOptions#SO_SNDBUF option.

Annotations
@Override
setSoTimeoutback to summary
public OioDatagramChannelConfig setSoTimeout(int timeout)

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setSoTimeout.

Doc from io.netty.channel.socket.oio.OioDatagramChannelConfig.setSoTimeout.

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

Sets the maximal time a operation on the underlying socket may block.

Annotations
@Override
setTimeToLiveback to summary
public OioDatagramChannelConfig setTimeToLive(int ttl)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setTimeToLive.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setTimeToLive, io.netty.channel.socket.DatagramChannelConfig.setTimeToLive.

Doc from io.netty.channel.socket.DatagramChannelConfig.setTimeToLive.

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

Sets the StandardSocketOptions#IP_MULTICAST_TTL option.

Annotations
@Override
setTrafficClassback to summary
public OioDatagramChannelConfig setTrafficClass(int trafficClass)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setTrafficClass.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setTrafficClass, io.netty.channel.socket.DatagramChannelConfig.setTrafficClass.

Doc from io.netty.channel.socket.DatagramChannelConfig.setTrafficClass.

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

Sets the StandardSocketOptions#IP_TOS option.

Annotations
@Override
setWriteBufferHighWaterMarkback to summary
public OioDatagramChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setWriteBufferHighWaterMark.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setWriteBufferHighWaterMark, io.netty.channel.ChannelConfig.setWriteBufferHighWaterMark.

Doc from io.netty.channel.ChannelConfig.setWriteBufferHighWaterMark.

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

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.

Annotations
@Override
setWriteBufferLowWaterMarkback to summary
public OioDatagramChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setWriteBufferLowWaterMark.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setWriteBufferLowWaterMark, io.netty.channel.ChannelConfig.setWriteBufferLowWaterMark.

Doc from io.netty.channel.ChannelConfig.setWriteBufferLowWaterMark.

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

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.

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

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setWriteBufferWaterMark.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setWriteBufferWaterMark, io.netty.channel.socket.DatagramChannelConfig.setWriteBufferWaterMark, io.netty.channel.ChannelConfig.setWriteBufferWaterMark.

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

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

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

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

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.setWriteSpinCount.

Implements io.netty.channel.socket.oio.OioDatagramChannelConfig.setWriteSpinCount, io.netty.channel.socket.DatagramChannelConfig.setWriteSpinCount, io.netty.channel.ChannelConfig.setWriteSpinCount.

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

Deprecated

as a consequence of OioDatagramChannelConfig being deprecated. See corresponding docs for further information.

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