DefaultDatagramChannelConfig (The Netty Project API Reference (3.2.6.Final))

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.netty.channel.socket
Class DefaultDatagramChannelConfig

java.lang.Object
  org.jboss.netty.channel.DefaultChannelConfig
      org.jboss.netty.channel.socket.DefaultDatagramChannelConfig

All Implemented Interfaces:: ChannelConfig, DatagramChannelConfig

public class DefaultDatagramChannelConfig
extends DefaultChannelConfig
implements DatagramChannelConfig
extends DefaultChannelConfig
implements DatagramChannelConfig

The default DatagramChannelConfig implementation.

Version:: $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
Author:: The Netty Project, Trustin Lee

Constructor Summary
`DefaultDatagramChannelConfig(DatagramSocket socket)` Creates a new instance.

Method Summary
`InetAddress`	`getInterface()` Gets the address of the network interface used for multicast packets.
`NetworkInterface`	`getNetworkInterface()` Gets the network interface for outgoing multicast datagrams sent on the `DatagramChannel`.
`int`	`getReceiveBufferSize()` Gets the `SO_RCVBUF` option.
`ReceiveBufferSizePredictor`	`getReceiveBufferSizePredictor()` Returns the `ReceiveBufferSizePredictor` which predicts the number of readable bytes in the socket receive buffer.
`ReceiveBufferSizePredictorFactory`	`getReceiveBufferSizePredictorFactory()` Returns the `ReceiveBufferSizePredictorFactory` which creates a new `ReceiveBufferSizePredictor` when a new channel is created and no `ReceiveBufferSizePredictor` was set.
`int`	`getSendBufferSize()` Gets the `SO_SNDBUF` option.
`int`	`getTimeToLive()` Gets the default time-to-live for multicast packets sent out on the socket.
`int`	`getTrafficClass()` Gets the traffic class.
`boolean`	`isBroadcast()` Gets the `SO_BROADCAST` option.
`boolean`	`isLoopbackModeDisabled()` Gets the setting for local loopback of multicast datagrams.
`boolean`	`isReuseAddress()` Gets the `SO_REUSEADDR` option.
`void`	`setBroadcast(boolean broadcast)` Sets the `SO_BROADCAST` option.
`void`	`setInterface(InetAddress interfaceAddress)` Sets the address of the network interface used for multicast packets.
`void`	`setLoopbackModeDisabled(boolean loopbackModeDisabled)` Sets the setting for local loopback of multicast datagrams.
`void`	`setNetworkInterface(NetworkInterface networkInterface)` Sets the network interface for outgoing multicast datagrams sent on the `DatagramChannel`.
`boolean`	`setOption(String key, Object value)` Sets a configuration property with the specified name and value.
`void`	`setReceiveBufferSize(int receiveBufferSize)` Gets the `SO_RCVBUF` option.
`void`	`setReceiveBufferSizePredictor(ReceiveBufferSizePredictor predictor)` Sets the `ReceiveBufferSizePredictor` which predicts the number of readable bytes in the socket receive buffer.
`void`	`setReceiveBufferSizePredictorFactory(ReceiveBufferSizePredictorFactory predictorFactory)` Sets the `ReceiveBufferSizePredictor` which creates a new `ReceiveBufferSizePredictor` when a new channel is created and no `ReceiveBufferSizePredictor` was set.
`void`	`setReuseAddress(boolean reuseAddress)` Sets the `SO_REUSEADDR` option.
`void`	`setSendBufferSize(int sendBufferSize)` Sets the `SO_SNDBUF` option.
`void`	`setTimeToLive(int ttl)` Sets the default time-to-live for multicast packets sent out on the `DatagramChannel` in order to control the scope of the multicasts.
`void`	`setTrafficClass(int trafficClass)` Sets the traffic class as specified in `DatagramSocket.setTrafficClass(int)`.

Methods inherited from class org.jboss.netty.channel.DefaultChannelConfig
`getBufferFactory, getConnectTimeoutMillis, getPipelineFactory, setBufferFactory, setConnectTimeoutMillis, setOptions, 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.ChannelConfig
`getBufferFactory, getConnectTimeoutMillis, getPipelineFactory, setBufferFactory, setConnectTimeoutMillis, setOptions, setPipelineFactory`

Constructor Detail

DefaultDatagramChannelConfig

public DefaultDatagramChannelConfig(DatagramSocket socket)

Creates a new instance.

Method Detail

setOption

public boolean setOption(String key,
                         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 DefaultChannelConfig

Returns:: true if and only if the property has been set