io.netty.channel.socket.oio

Interface OioDatagramChannelConfig

All Superinterfaces:

ChannelConfig, DatagramChannelConfig

public interface OioDatagramChannelConfig
extends DatagramChannelConfig

Method Summary

Modifier and Type	Method and Description
int	getSoTimeout() Returns the maximal time a operation on the underlying socket may block.
OioDatagramChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
OioDatagramChannelConfig	setAutoClose(boolean autoClose)
OioDatagramChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
OioDatagramChannelConfig	setBroadcast(boolean broadcast) Sets the StandardSocketOptions.SO_BROADCAST option.
OioDatagramChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
OioDatagramChannelConfig	setInterface(java.net.InetAddress interfaceAddress) Sets the address of the network interface used for multicast packets.
OioDatagramChannelConfig	setLoopbackModeDisabled(boolean loopbackModeDisabled) Sets the StandardSocketOptions.IP_MULTICAST_LOOP option.
OioDatagramChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Sets the maximum number of messages to read per read loop.
OioDatagramChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
OioDatagramChannelConfig	setNetworkInterface(java.net.NetworkInterface networkInterface) Sets the StandardSocketOptions.IP_MULTICAST_IF option.
OioDatagramChannelConfig	setReceiveBufferSize(int receiveBufferSize) Sets the StandardSocketOptions.SO_RCVBUF option.
OioDatagramChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
OioDatagramChannelConfig	setReuseAddress(boolean reuseAddress) Gets the StandardSocketOptions.SO_REUSEADDR option.
OioDatagramChannelConfig	setSendBufferSize(int sendBufferSize) Sets the StandardSocketOptions.SO_SNDBUF option.
OioDatagramChannelConfig	setSoTimeout(int timeout) Sets the maximal time a operation on the underlying socket may block.
OioDatagramChannelConfig	setTimeToLive(int ttl) Sets the StandardSocketOptions.IP_MULTICAST_TTL option.
OioDatagramChannelConfig	setTrafficClass(int trafficClass) Sets the StandardSocketOptions.IP_TOS option.
OioDatagramChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
OioDatagramChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
OioDatagramChannelConfig	setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

Methods inherited from interface io.netty.channel.socket.DatagramChannelConfig

getInterface, getNetworkInterface, getReceiveBufferSize, getSendBufferSize, getTimeToLive, getTrafficClass, isBroadcast, isLoopbackModeDisabled, isReuseAddress

Methods inherited from interface io.netty.channel.ChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOption, setOptions

Method Detail

setSoTimeout

OioDatagramChannelConfig setSoTimeout(int timeout)

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

getSoTimeout

int getSoTimeout()

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

setSendBufferSize

OioDatagramChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

setSendBufferSize in interface DatagramChannelConfig

setReceiveBufferSize

OioDatagramChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

setReceiveBufferSize in interface DatagramChannelConfig

setTrafficClass

OioDatagramChannelConfig setTrafficClass(int trafficClass)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_TOS option.

Specified by:

setTrafficClass in interface DatagramChannelConfig

setReuseAddress

OioDatagramChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface DatagramChannelConfig

setBroadcast

OioDatagramChannelConfig setBroadcast(boolean broadcast)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.SO_BROADCAST option.

Specified by:

setBroadcast in interface DatagramChannelConfig

setLoopbackModeDisabled

OioDatagramChannelConfig 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

setTimeToLive

OioDatagramChannelConfig setTimeToLive(int ttl)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_TTL option.

Specified by:

setTimeToLive in interface DatagramChannelConfig

setInterface

OioDatagramChannelConfig setInterface(java.net.InetAddress interfaceAddress)

Description copied from interface: DatagramChannelConfig

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

Specified by:

setInterface in interface DatagramChannelConfig

setNetworkInterface

OioDatagramChannelConfig setNetworkInterface(java.net.NetworkInterface networkInterface)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_IF option.

Specified by:

setNetworkInterface in interface DatagramChannelConfig

setMaxMessagesPerRead

OioDatagramChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Description copied from interface: ChannelConfig

Sets the maximum number of messages to read per read loop. If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface DatagramChannelConfig

setWriteSpinCount

OioDatagramChannelConfig 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

setConnectTimeoutMillis

OioDatagramChannelConfig 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

Parameters:

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

setAllocator

OioDatagramChannelConfig 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

setRecvByteBufAllocator

OioDatagramChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

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

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

Specified by:

setRecvByteBufAllocator in interface DatagramChannelConfig

setAutoRead

OioDatagramChannelConfig 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

setAutoClose

OioDatagramChannelConfig setAutoClose(boolean autoClose)

Specified by:

setAutoClose in interface ChannelConfig

Specified by:

setAutoClose in interface DatagramChannelConfig

setMessageSizeEstimator

OioDatagramChannelConfig 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

setWriteBufferHighWaterMark

OioDatagramChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

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

setWriteBufferLowWaterMark

OioDatagramChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

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