Top Methods
io.netty.channel.socket.oio

public Interface OioDatagramChannelConfig

extends DatagramChannelConfig
Known Direct Implementers
io.netty.channel.socket.oio.DefaultOioDatagramChannelConfig
Annotations
@Deprecated
Imports
io.netty.buffer.ByteBufAllocator, io.netty.channel.MessageSizeEstimator, .RecvByteBufAllocator, .WriteBufferWaterMark, io.netty.channel.socket.DatagramChannelConfig, java.net.InetAddress, .NetworkInterface

Deprecated

use NIO / EPOLL / KQUEUE transport.

Method Summary

Modifier and TypeMethod and Description
public int
getSoTimeout()

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

public OioDatagramChannelConfig
setAllocator(ByteBufAllocator allocator)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setAllocator.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Set the ByteBufAllocator which is used for the channel to allocate buffers.
public OioDatagramChannelConfig
setAutoClose(boolean autoClose)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setAutoClose.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets whether the Channel should be closed automatically and immediately on write failure.
public OioDatagramChannelConfig
setAutoRead(boolean autoRead)

Redeclares io.netty.channel.socket.DatagramChannelConfig.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
setBroadcast(boolean broadcast)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setBroadcast.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets the StandardSocketOptions#SO_BROADCAST option.
public OioDatagramChannelConfig
setConnectTimeoutMillis(int
the connect timeout in milliseconds. 0 to disable.
connectTimeoutMillis
)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setConnectTimeoutMillis.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets the connect timeout of the channel in milliseconds.
public OioDatagramChannelConfig
setInterface(InetAddress interfaceAddress)

Redeclares 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
setLoopbackModeDisabled(boolean
true if and only if the loopback mode has been disabled
loopbackModeDisabled
)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setLoopbackModeDisabled.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets the StandardSocketOptions#IP_MULTICAST_LOOP option.
public OioDatagramChannelConfig
setMaxMessagesPerRead(int maxMessagesPerRead)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setMaxMessagesPerRead.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
public OioDatagramChannelConfig
setMessageSizeEstimator(MessageSizeEstimator estimator)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setMessageSizeEstimator.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
public OioDatagramChannelConfig
public OioDatagramChannelConfig
setReceiveBufferSize(int receiveBufferSize)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setReceiveBufferSize.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets the StandardSocketOptions#SO_RCVBUF option.
public OioDatagramChannelConfig
setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setRecvByteBufAllocator.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
public OioDatagramChannelConfig
setReuseAddress(boolean reuseAddress)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setReuseAddress.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Gets the StandardSocketOptions#SO_REUSEADDR option.
public OioDatagramChannelConfig
setSendBufferSize(int sendBufferSize)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setSendBufferSize.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets the StandardSocketOptions#SO_SNDBUF option.
public OioDatagramChannelConfig
setSoTimeout(int timeout)

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets the maximal time a operation on the underlying socket may block.
public OioDatagramChannelConfig
setTimeToLive(int ttl)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setTimeToLive.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets the StandardSocketOptions#IP_MULTICAST_TTL option.
public OioDatagramChannelConfig
setTrafficClass(int trafficClass)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setTrafficClass.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets the StandardSocketOptions#IP_TOS option.
public OioDatagramChannelConfig
setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Redeclares io.netty.channel.ChannelConfig.setWriteBufferHighWaterMark.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.

Sets the high water mark of the write buffer.

public OioDatagramChannelConfig
setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Redeclares io.netty.channel.ChannelConfig.setWriteBufferLowWaterMark.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.

Sets the low water mark of the write buffer.

public OioDatagramChannelConfig
setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setWriteBufferWaterMark.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
public OioDatagramChannelConfig
setWriteSpinCount(int writeSpinCount)

Redeclares io.netty.channel.socket.DatagramChannelConfig.setWriteSpinCount.

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
Sets the maximum loop count for a write operation until WritableByteChannel#write(ByteBuffer) returns a non-zero value.
Inherited from io.netty.channel.socket.DatagramChannelConfig:
getInterfacegetNetworkInterfacegetReceiveBufferSizegetSendBufferSizegetTimeToLivegetTrafficClassisBroadcastisLoopbackModeDisabledisReuseAddress

Method Detail

getSoTimeoutback to summary
public int getSoTimeout()

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

setAllocatorback to summary
public OioDatagramChannelConfig setAllocator(ByteBufAllocator allocator)

Redeclares io.netty.channel.socket.DatagramChannelConfig.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)

Redeclares io.netty.channel.socket.DatagramChannelConfig.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)

Redeclares io.netty.channel.socket.DatagramChannelConfig.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)

Redeclares 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)

Redeclares io.netty.channel.socket.DatagramChannelConfig.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)

Redeclares 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)

Redeclares 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)

Redeclares io.netty.channel.socket.DatagramChannelConfig.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)

Redeclares io.netty.channel.socket.DatagramChannelConfig.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)

Redeclares 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
setReceiveBufferSizeback to summary
public OioDatagramChannelConfig setReceiveBufferSize(int receiveBufferSize)

Redeclares 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)

Redeclares io.netty.channel.socket.DatagramChannelConfig.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)

Redeclares 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)

Redeclares 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)

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.

setTimeToLiveback to summary
public OioDatagramChannelConfig setTimeToLive(int ttl)

Redeclares 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)

Redeclares 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)

Redeclares 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)

Redeclares 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)

Redeclares io.netty.channel.socket.DatagramChannelConfig.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)

Redeclares io.netty.channel.socket.DatagramChannelConfig.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