Class DefaultOioDatagramChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.socket.DefaultDatagramChannelConfig

io.netty.channel.socket.oio.DefaultOioDatagramChannelConfig

All Implemented Interfaces:

ChannelConfig, DatagramChannelConfig, OioDatagramChannelConfig

final class DefaultOioDatagramChannelConfig
extends DefaultDatagramChannelConfig
implements OioDatagramChannelConfig

Field Summary

Fields inherited from class DefaultChannelConfig

channel

Constructor Summary

Constructors

Constructor	Description
DefaultOioDatagramChannelConfig(DatagramChannel channel, DatagramSocket javaSocket)

Method Summary

Modifier and Type	Method	Description
<T> T	getOption(ChannelOption<T> option)	Return the value of the given ChannelOption
Map<ChannelOption<?>, Object>	getOptions()	Return all set ChannelOption's.
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)	Sets whether the Channel should be closed automatically and immediately on write failure.
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(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)
OioDatagramChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator)	Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
OioDatagramChannelConfig	setNetworkInterface(NetworkInterface networkInterface)	Sets the StandardSocketOptions.IP_MULTICAST_IF option.
<T> boolean	setOption(ChannelOption<T> option, T value)	Sets a configuration property with the specified name and value.
OioDatagramChannelConfig	setReceiveBufferSize(int receiveBufferSize)	Sets the StandardSocketOptions.SO_RCVBUF option.
OioDatagramChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator)	Set the RecvByteBufAllocator 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	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)	Set the WriteBufferWaterMark which is used for setting the high and 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 class DefaultDatagramChannelConfig

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

Methods inherited from class DefaultChannelConfig

autoReadCleared, getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions, validate

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions

Methods inherited from interface DatagramChannelConfig

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

Constructor Details

DefaultOioDatagramChannelConfig

DefaultOioDatagramChannelConfig(DatagramChannel channel,
 DatagramSocket javaSocket)

Method Details

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 DefaultDatagramChannelConfig

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 DefaultDatagramChannelConfig

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 DefaultDatagramChannelConfig

Returns:

true if and only if the property has been set

setSoTimeout

public OioDatagramChannelConfig setSoTimeout(int timeout)

Description copied from interface: OioDatagramChannelConfig

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

Specified by:

setSoTimeout in interface OioDatagramChannelConfig

getSoTimeout

public int getSoTimeout()

Description copied from interface: OioDatagramChannelConfig

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

Specified by:

getSoTimeout in interface OioDatagramChannelConfig

setBroadcast

public OioDatagramChannelConfig setBroadcast(boolean broadcast)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.SO_BROADCAST option.

Specified by:

setBroadcast in interface DatagramChannelConfig

Specified by:

setBroadcast in interface OioDatagramChannelConfig

Overrides:

setBroadcast in class DefaultDatagramChannelConfig

setInterface

public OioDatagramChannelConfig setInterface(InetAddress interfaceAddress)

Description copied from interface: DatagramChannelConfig

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

Specified by:

setInterface in interface DatagramChannelConfig

Specified by:

setInterface in interface OioDatagramChannelConfig

Overrides:

setInterface in class DefaultDatagramChannelConfig

setLoopbackModeDisabled

public OioDatagramChannelConfig setLoopbackModeDisabled(boolean loopbackModeDisabled)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_LOOP option.

Specified by:

setLoopbackModeDisabled in interface DatagramChannelConfig

Specified by:

setLoopbackModeDisabled in interface OioDatagramChannelConfig

Overrides:

setLoopbackModeDisabled in class DefaultDatagramChannelConfig

Parameters:

loopbackModeDisabled - true if and only if the loopback mode has been disabled

setNetworkInterface

public OioDatagramChannelConfig setNetworkInterface(NetworkInterface networkInterface)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_IF option.

Specified by:

setNetworkInterface in interface DatagramChannelConfig

Specified by:

setNetworkInterface in interface OioDatagramChannelConfig

Overrides:

setNetworkInterface in class DefaultDatagramChannelConfig

setReuseAddress

public OioDatagramChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface DatagramChannelConfig

Specified by:

setReuseAddress in interface OioDatagramChannelConfig

Overrides:

setReuseAddress in class DefaultDatagramChannelConfig

setReceiveBufferSize

public OioDatagramChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.SO_RCVBUF option.

Specified by:

setReceiveBufferSize in interface DatagramChannelConfig

Specified by:

setReceiveBufferSize in interface OioDatagramChannelConfig

Overrides:

setReceiveBufferSize in class DefaultDatagramChannelConfig

setSendBufferSize

public OioDatagramChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.SO_SNDBUF option.

Specified by:

setSendBufferSize in interface DatagramChannelConfig

Specified by:

setSendBufferSize in interface OioDatagramChannelConfig

Overrides:

setSendBufferSize in class DefaultDatagramChannelConfig

setTimeToLive

public OioDatagramChannelConfig setTimeToLive(int ttl)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_TTL option.

Specified by:

setTimeToLive in interface DatagramChannelConfig

Specified by:

setTimeToLive in interface OioDatagramChannelConfig

Overrides:

setTimeToLive in class DefaultDatagramChannelConfig

setTrafficClass

public OioDatagramChannelConfig setTrafficClass(int trafficClass)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_TOS option.

Specified by:

setTrafficClass in interface DatagramChannelConfig

Specified by:

setTrafficClass in interface OioDatagramChannelConfig

Overrides:

setTrafficClass in class DefaultDatagramChannelConfig

setWriteSpinCount

public 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

Specified by:

setWriteSpinCount in interface OioDatagramChannelConfig

Overrides:

setWriteSpinCount in class DefaultDatagramChannelConfig

setConnectTimeoutMillis

public 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

Specified by:

setConnectTimeoutMillis in interface OioDatagramChannelConfig

Overrides:

setConnectTimeoutMillis in class DefaultDatagramChannelConfig

Parameters:

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

setMaxMessagesPerRead

public OioDatagramChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Description copied from class: DefaultChannelConfig

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface DatagramChannelConfig

Specified by:

setMaxMessagesPerRead in interface OioDatagramChannelConfig

Overrides:

setMaxMessagesPerRead in class DefaultDatagramChannelConfig

setAllocator

public 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

Specified by:

setAllocator in interface OioDatagramChannelConfig

Overrides:

setAllocator in class DefaultDatagramChannelConfig

setRecvByteBufAllocator

public OioDatagramChannelConfig 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 DatagramChannelConfig

Specified by:

setRecvByteBufAllocator in interface OioDatagramChannelConfig

Overrides:

setRecvByteBufAllocator in class DefaultDatagramChannelConfig

setAutoRead

public 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

Specified by:

setAutoRead in interface OioDatagramChannelConfig

Overrides:

setAutoRead in class DefaultDatagramChannelConfig

setAutoClose

public OioDatagramChannelConfig 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 DatagramChannelConfig

Specified by:

setAutoClose in interface OioDatagramChannelConfig

Overrides:

setAutoClose in class DefaultDatagramChannelConfig

setWriteBufferHighWaterMark

public 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

Specified by:

setWriteBufferHighWaterMark in interface OioDatagramChannelConfig

Overrides:

setWriteBufferHighWaterMark in class DefaultDatagramChannelConfig

setWriteBufferLowWaterMark

public 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

Specified by:

setWriteBufferLowWaterMark in interface OioDatagramChannelConfig

Overrides:

setWriteBufferLowWaterMark in class DefaultDatagramChannelConfig

setWriteBufferWaterMark

public OioDatagramChannelConfig 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 DatagramChannelConfig

Specified by:

setWriteBufferWaterMark in interface OioDatagramChannelConfig

Overrides:

setWriteBufferWaterMark in class DefaultDatagramChannelConfig

setMessageSizeEstimator

public 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

Specified by:

setMessageSizeEstimator in interface OioDatagramChannelConfig

Overrides:

setMessageSizeEstimator in class DefaultDatagramChannelConfig