Class NioDatagramChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.socket.DefaultDatagramChannelConfig

io.netty.channel.socket.nio.NioDatagramChannelConfig

All Implemented Interfaces:

ChannelConfig, DatagramChannelConfig

class NioDatagramChannelConfig
extends DefaultDatagramChannelConfig

The default NioDatagramChannelConfig implementation.

Field Summary

Fields

Modifier and Type	Field	Description
private final java.nio.channels.DatagramChannel	javaChannel

Fields inherited from class DefaultChannelConfig

channel

Constructor Summary

Constructors

Constructor	Description
NioDatagramChannelConfig(NioDatagramChannel channel, java.nio.channels.DatagramChannel javaChannel)

Method Summary

Modifier and Type	Method	Description
protected void	autoReadCleared()	Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.
java.net.InetAddress	getInterface()	Gets the address of the network interface used for multicast packets.
java.net.NetworkInterface	getNetworkInterface()	Gets the StandardSocketOptions.IP_MULTICAST_IF option.
<T> T	getOption(ChannelOption<T> option)	Return the value of the given ChannelOption
private <T> T	getOption0(java.net.SocketOption<T> option)
java.util.Map<ChannelOption<?>, java.lang.Object>	getOptions()	Return all set ChannelOption's.
int	getTimeToLive()	Gets the StandardSocketOptions.IP_MULTICAST_TTL option.
boolean	isLoopbackModeDisabled()	Gets the StandardSocketOptions.IP_MULTICAST_LOOP option.
DatagramChannelConfig	setAutoRead(boolean autoRead)	Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
DatagramChannelConfig	setInterface(java.net.InetAddress interfaceAddress)	Sets the address of the network interface used for multicast packets.
DatagramChannelConfig	setLoopbackModeDisabled(boolean loopbackModeDisabled)	Sets the StandardSocketOptions.IP_MULTICAST_LOOP option.
DatagramChannelConfig	setNetworkInterface(java.net.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.
private <T> void	setOption0(java.net.SocketOption<T> option, T value)
DatagramChannelConfig	setTimeToLive(int ttl)	Sets the StandardSocketOptions.IP_MULTICAST_TTL option.

Methods inherited from class DefaultDatagramChannelConfig

getReceiveBufferSize, getSendBufferSize, getTrafficClass, isBroadcast, isReuseAddress, javaSocket, setAllocator, setAutoClose, setBroadcast, setConnectTimeoutMillis, setMaxMessagesPerRead, setMaxMessagesPerWrite, setMessageSizeEstimator, setReceiveBufferSize, setRecvByteBufAllocator, setReuseAddress, setSendBufferSize, setTrafficClass, setWriteBufferHighWaterMark, setWriteBufferLowWaterMark, setWriteBufferWaterMark, setWriteSpinCount

Methods inherited from class DefaultChannelConfig

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

Methods inherited from class java.lang.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

Field Details

javaChannel

private final java.nio.channels.DatagramChannel javaChannel

Constructor Details

NioDatagramChannelConfig

NioDatagramChannelConfig(NioDatagramChannel channel,
 java.nio.channels.DatagramChannel javaChannel)

Method Details

getTimeToLive

public int getTimeToLive()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.IP_MULTICAST_TTL option.

Specified by:

getTimeToLive in interface DatagramChannelConfig

Overrides:

getTimeToLive in class DefaultDatagramChannelConfig

setTimeToLive

public DatagramChannelConfig setTimeToLive(int ttl)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_TTL option.

Specified by:

setTimeToLive in interface DatagramChannelConfig

Overrides:

setTimeToLive in class DefaultDatagramChannelConfig

getInterface

public java.net.InetAddress getInterface()

Description copied from interface: DatagramChannelConfig

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

Specified by:

getInterface in interface DatagramChannelConfig

Overrides:

getInterface in class DefaultDatagramChannelConfig

setInterface

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

Overrides:

setInterface in class DefaultDatagramChannelConfig

getNetworkInterface

public java.net.NetworkInterface getNetworkInterface()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.IP_MULTICAST_IF option.

Specified by:

getNetworkInterface in interface DatagramChannelConfig

Overrides:

getNetworkInterface in class DefaultDatagramChannelConfig

setNetworkInterface

public DatagramChannelConfig setNetworkInterface(java.net.NetworkInterface networkInterface)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_IF option.

Specified by:

setNetworkInterface in interface DatagramChannelConfig

Overrides:

setNetworkInterface in class DefaultDatagramChannelConfig

isLoopbackModeDisabled

public boolean isLoopbackModeDisabled()

Description copied from interface: DatagramChannelConfig

Gets the StandardSocketOptions.IP_MULTICAST_LOOP option.

Specified by:

isLoopbackModeDisabled in interface DatagramChannelConfig

Overrides:

isLoopbackModeDisabled in class DefaultDatagramChannelConfig

Returns:

true if and only if the loopback mode has been disabled

setLoopbackModeDisabled

public DatagramChannelConfig setLoopbackModeDisabled(boolean loopbackModeDisabled)

Description copied from interface: DatagramChannelConfig

Sets the StandardSocketOptions.IP_MULTICAST_LOOP option.

Specified by:

setLoopbackModeDisabled in interface DatagramChannelConfig

Overrides:

setLoopbackModeDisabled in class DefaultDatagramChannelConfig

Parameters:

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

setAutoRead

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

Overrides:

setAutoRead in class DefaultDatagramChannelConfig

autoReadCleared

protected void autoReadCleared()

Description copied from class: DefaultChannelConfig

Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.

Overrides:

autoReadCleared in class DefaultChannelConfig

getOption0

private <T> T getOption0(java.net.SocketOption<T> option)

setOption0

private <T> void setOption0(java.net.SocketOption<T> option,
 T value)

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

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

getOptions

public java.util.Map<ChannelOption<?>, java.lang.Object> getOptions()

Description copied from interface: ChannelConfig

Return all set ChannelOption's.

Specified by:

getOptions in interface ChannelConfig

Overrides:

getOptions in class DefaultDatagramChannelConfig