org.jboss.netty.channel.socket.nio

Class DefaultNioDatagramChannelConfig

java.lang.Object

org.jboss.netty.channel.DefaultChannelConfig

org.jboss.netty.channel.socket.DefaultDatagramChannelConfig

org.jboss.netty.channel.socket.nio.DefaultNioDatagramChannelConfig

All Implemented Interfaces:

ChannelConfig, DatagramChannelConfig, NioChannelConfig, NioDatagramChannelConfig

class DefaultNioDatagramChannelConfig
extends DefaultDatagramChannelConfig
implements NioDatagramChannelConfig

The default NioSocketChannelConfig implementation.

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.channels.DatagramChannel	channel
private static InternalLogger	logger
private int	writeBufferHighWaterMark
private int	writeBufferLowWaterMark
private int	writeSpinCount

Constructor Summary

Constructors

Constructor and Description
DefaultNioDatagramChannelConfig(java.nio.channels.DatagramChannel channel)

Method Summary

Modifier and Type	Method and Description
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.
int	getTimeToLive() Gets the StandardSocketOptions.IP_MULTICAST_TTL option.
int	getWriteBufferHighWaterMark() Returns the high water mark of the write buffer.
int	getWriteBufferLowWaterMark() Returns the low water mark of the write buffer.
int	getWriteSpinCount() Returns the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.
boolean	isLoopbackModeDisabled() Gets the StandardSocketOptions.IP_MULTICAST_LOOP option.
void	setInterface(java.net.InetAddress interfaceAddress) Sets the address of the network interface used for multicast packets.
void	setLoopbackModeDisabled(boolean loopbackModeDisabled) Sets the StandardSocketOptions.IP_MULTICAST_LOOP option.
void	setNetworkInterface(java.net.NetworkInterface networkInterface) Sets the StandardSocketOptions.IP_MULTICAST_IF option.
boolean	setOption(java.lang.String key, java.lang.Object value) Sets a configuration property with the specified name and value.
void	setOptions(java.util.Map<java.lang.String,java.lang.Object> options) Sets the configuration properties from the specified Map.
void	setTimeToLive(int ttl) Sets the StandardSocketOptions.IP_MULTICAST_TTL option.
void	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
private void	setWriteBufferHighWaterMark0(int writeBufferHighWaterMark)
void	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
private void	setWriteBufferLowWaterMark0(int writeBufferLowWaterMark)
void	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 org.jboss.netty.channel.socket.DefaultDatagramChannelConfig

getReceiveBufferSize, getReceiveBufferSizePredictor, getReceiveBufferSizePredictorFactory, getSendBufferSize, getTrafficClass, isBroadcast, isReuseAddress, setBroadcast, setReceiveBufferSize, setReceiveBufferSizePredictor, setReceiveBufferSizePredictorFactory, setReuseAddress, setSendBufferSize, setTrafficClass

Methods inherited from class org.jboss.netty.channel.DefaultChannelConfig

getBufferFactory, getConnectTimeoutMillis, getPipelineFactory, setBufferFactory, setConnectTimeoutMillis, setPipelineFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.netty.channel.socket.DatagramChannelConfig

getReceiveBufferSize, getReceiveBufferSizePredictor, getReceiveBufferSizePredictorFactory, getSendBufferSize, getTrafficClass, isBroadcast, isReuseAddress, setBroadcast, setReceiveBufferSize, setReceiveBufferSizePredictor, setReceiveBufferSizePredictorFactory, setReuseAddress, setSendBufferSize, setTrafficClass

Methods inherited from interface org.jboss.netty.channel.ChannelConfig

getBufferFactory, getConnectTimeoutMillis, getPipelineFactory, setBufferFactory, setConnectTimeoutMillis, setPipelineFactory

Field Detail

logger

private static final InternalLogger logger

writeBufferHighWaterMark

private volatile int writeBufferHighWaterMark

writeBufferLowWaterMark

private volatile int writeBufferLowWaterMark

writeSpinCount

private volatile int writeSpinCount

channel

private final java.nio.channels.DatagramChannel channel

Constructor Detail

DefaultNioDatagramChannelConfig

DefaultNioDatagramChannelConfig(java.nio.channels.DatagramChannel channel)

Method Detail

setOptions

public void setOptions(java.util.Map<java.lang.String,java.lang.Object> options)

Description copied from interface: ChannelConfig

Sets the configuration properties from the specified Map.

Specified by:

setOptions in interface ChannelConfig

Overrides:

setOptions in class DefaultChannelConfig

setOption

public boolean setOption(java.lang.String key,
                         java.lang.Object 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(String name, Object value) {
     if (super.setOption(name, value)) {
         return true;
     }

     if (name.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

getWriteBufferHighWaterMark

public int getWriteBufferHighWaterMark()

Description copied from interface: NioChannelConfig

Returns 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:

getWriteBufferHighWaterMark in interface NioChannelConfig

setWriteBufferHighWaterMark

public void setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Description copied from interface: NioChannelConfig

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 NioChannelConfig

setWriteBufferHighWaterMark0

private void setWriteBufferHighWaterMark0(int writeBufferHighWaterMark)

getWriteBufferLowWaterMark

public int getWriteBufferLowWaterMark()

Description copied from interface: NioChannelConfig

Returns 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:

getWriteBufferLowWaterMark in interface NioChannelConfig

setWriteBufferLowWaterMark

public void setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Description copied from interface: NioChannelConfig

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 toreturn true again.

Specified by:

setWriteBufferLowWaterMark in interface NioChannelConfig

setWriteBufferLowWaterMark0

private void setWriteBufferLowWaterMark0(int writeBufferLowWaterMark)

getWriteSpinCount

public int getWriteSpinCount()

Description copied from interface: NioChannelConfig

Returns 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:

getWriteSpinCount in interface NioChannelConfig

setWriteSpinCount

public void setWriteSpinCount(int writeSpinCount)

Description copied from interface: NioChannelConfig

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 NioChannelConfig

setNetworkInterface

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

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

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 void 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 void 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

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

setLoopbackModeDisabled

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