Top Description Fields Constructors Methods
io.netty.channel.socket.nio

pack-priv Class NioDatagramChannelConfig

extends DefaultDatagramChannelConfig
Class Inheritance
Imports
io.netty.channel.ChannelException, .ChannelOption, io.netty.channel.socket.DatagramChannelConfig, .DefaultDatagramChannelConfig, io.netty.util.internal.PlatformDependent, .SocketUtils, java.lang.reflect.Method, java.net.InetAddress, .NetworkInterface, .SocketException, java.nio.channels.DatagramChannel, java.util.Enumeration, .Map
The default NioDatagramChannelConfig implementation.

Field Summary

Modifier and TypeField and Description
private static final Method
GET_OPTION

private static final Object
IP_MULTICAST_IF

private static final Object
IP_MULTICAST_LOOP

private static final Object
IP_MULTICAST_TTL

private final DatagramChannel
javaChannel

private static final Method
SET_OPTION

Constructor Summary

AccessConstructor and Description
pack-priv
NioDatagramChannelConfig(NioDatagramChannel channel, DatagramChannel javaChannel)

Method Summary

Modifier and TypeMethod and Description
protected void
autoReadCleared()

Overrides io.netty.channel.DefaultChannelConfig.autoReadCleared.

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

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.getInterface.

Implements io.netty.channel.socket.DatagramChannelConfig.getInterface.

Gets the address of the network interface used for multicast packets.
public NetworkInterface
getNetworkInterface()

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.getNetworkInterface.

Implements io.netty.channel.socket.DatagramChannelConfig.getNetworkInterface.

Gets the StandardSocketOptions#IP_MULTICAST_IF option.
public <T> T
getOption(ChannelOption<T> option)

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

Implements io.netty.channel.ChannelConfig.getOption.

Return the value of the given ChannelOption
private Object
getOption0(Object option)

public Map<ChannelOption<?>, Object>
getOptions()

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

Implements io.netty.channel.ChannelConfig.getOptions.

Return all set ChannelOption's.
public int
getTimeToLive()

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.getTimeToLive.

Implements io.netty.channel.socket.DatagramChannelConfig.getTimeToLive.

Gets the StandardSocketOptions#IP_MULTICAST_TTL option.
public boolean
isLoopbackModeDisabled()

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.isLoopbackModeDisabled.

Implements io.netty.channel.socket.DatagramChannelConfig.isLoopbackModeDisabled.

Gets the StandardSocketOptions#IP_MULTICAST_LOOP option.
public DatagramChannelConfig
setAutoRead(boolean autoRead)

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

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

Sets if ChannelHandlerContext#read() will be invoked automatically so that a user application doesn't need to call it at all.
public DatagramChannelConfig
setInterface(InetAddress interfaceAddress)

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

Implements io.netty.channel.socket.DatagramChannelConfig.setInterface.

Sets the address of the network interface used for multicast packets.
public DatagramChannelConfig
setLoopbackModeDisabled(boolean
true if and only if the loopback mode has been disabled
loopbackModeDisabled)

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

Implements io.netty.channel.socket.DatagramChannelConfig.setLoopbackModeDisabled.

Sets the StandardSocketOptions#IP_MULTICAST_LOOP option.
public DatagramChannelConfig
setNetworkInterface(NetworkInterface networkInterface)

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

Implements io.netty.channel.socket.DatagramChannelConfig.setNetworkInterface.

Sets the StandardSocketOptions#IP_MULTICAST_IF option.
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.
private void
setOption0(Object option, Object value)

public DatagramChannelConfig
setTimeToLive(int ttl)

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

Implements io.netty.channel.socket.DatagramChannelConfig.setTimeToLive.

Sets the StandardSocketOptions#IP_MULTICAST_TTL option.
Inherited from io.netty.channel.socket.DefaultDatagramChannelConfig:
getReceiveBufferSizegetSendBufferSizegetTrafficClassisBroadcastisReuseAddressjavaSocketsetAllocatorsetAutoClosesetBroadcastsetConnectTimeoutMillissetMaxMessagesPerReadsetMaxMessagesPerWritesetMessageSizeEstimatorsetReceiveBufferSizesetRecvByteBufAllocatorsetReuseAddresssetSendBufferSizesetTrafficClasssetWriteBufferHighWaterMarksetWriteBufferLowWaterMarksetWriteBufferWaterMarksetWriteSpinCount

Field Detail

GET_OPTIONback to summary
private static final Method GET_OPTION
IP_MULTICAST_IFback to summary
private static final Object IP_MULTICAST_IF
IP_MULTICAST_LOOPback to summary
private static final Object IP_MULTICAST_LOOP
IP_MULTICAST_TTLback to summary
private static final Object IP_MULTICAST_TTL
javaChannelback to summary
private final DatagramChannel javaChannel
SET_OPTIONback to summary
private static final Method SET_OPTION

Constructor Detail

NioDatagramChannelConfigback to summary
pack-priv NioDatagramChannelConfig(NioDatagramChannel channel, DatagramChannel javaChannel)

Method Detail

autoReadClearedback to summary
protected void autoReadCleared()

Overrides io.netty.channel.DefaultChannelConfig.autoReadCleared.

Doc from io.netty.channel.DefaultChannelConfig.autoReadCleared.

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

Annotations
@Override
getInterfaceback to summary
public InetAddress getInterface()

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.getInterface.

Implements io.netty.channel.socket.DatagramChannelConfig.getInterface.

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

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

Annotations
@Override
getNetworkInterfaceback to summary
public NetworkInterface getNetworkInterface()

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.getNetworkInterface.

Implements io.netty.channel.socket.DatagramChannelConfig.getNetworkInterface.

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

Gets the StandardSocketOptions#IP_MULTICAST_IF option.

Annotations
@Override
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
@Override
getOption0back to summary
private Object getOption0(Object option)
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
@SuppressWarnings:unchecked
@Override
getTimeToLiveback to summary
public int getTimeToLive()

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.getTimeToLive.

Implements io.netty.channel.socket.DatagramChannelConfig.getTimeToLive.

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

Gets the StandardSocketOptions#IP_MULTICAST_TTL option.

Annotations
@Override
isLoopbackModeDisabledback to summary
public boolean isLoopbackModeDisabled()

Overrides io.netty.channel.socket.DefaultDatagramChannelConfig.isLoopbackModeDisabled.

Implements io.netty.channel.socket.DatagramChannelConfig.isLoopbackModeDisabled.

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

Gets the StandardSocketOptions#IP_MULTICAST_LOOP option.

Returns:boolean

true if and only if the loopback mode has been disabled

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

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

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

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

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

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

Implements io.netty.channel.socket.DatagramChannelConfig.setInterface.

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

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

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

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

Implements io.netty.channel.socket.DatagramChannelConfig.setLoopbackModeDisabled.

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

Sets the StandardSocketOptions#IP_MULTICAST_LOOP option.

Parameters
loopbackModeDisabled:boolean

true if and only if the loopback mode has been disabled

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

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

Implements io.netty.channel.socket.DatagramChannelConfig.setNetworkInterface.

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

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
setOption0back to summary
private void setOption0(Object option, Object value)
setTimeToLiveback to summary
public DatagramChannelConfig setTimeToLive(int ttl)

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

Implements io.netty.channel.socket.DatagramChannelConfig.setTimeToLive.

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

Sets the StandardSocketOptions#IP_MULTICAST_TTL option.

Annotations
@Override