DefaultSocketChannelConfig (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 DefaultSocketChannelConfig

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

All Implemented Interfaces:: ChannelConfig, SocketChannelConfig

public class DefaultSocketChannelConfig
extends DefaultChannelConfig
implements SocketChannelConfig
extends DefaultChannelConfig
implements SocketChannelConfig

The default SocketChannelConfig implementation.

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

Constructor Summary
`DefaultSocketChannelConfig(Socket socket)` Creates a new instance.

Method Summary
`int`	`getReceiveBufferSize()` Gets the `SO_RCVBUF` option.
`int`	`getSendBufferSize()` Gets the `SO_SNDBUF` option.
`int`	`getSoLinger()` Gets the `SO_LINGER` option.
`int`	`getTrafficClass()` Gets the traffic class.
`boolean`	`isKeepAlive()` Gets the `SO_KEEPALIVE` option.
`boolean`	`isReuseAddress()` Gets the `SO_REUSEADDR` option.
`boolean`	`isTcpNoDelay()` Gets the `SO_TCPNODELAY` option.
`void`	`setKeepAlive(boolean keepAlive)` Sets the `SO_KEEPALIVE` option.
`boolean`	`setOption(String key, Object value)` Sets a configuration property with the specified name and value.
`void`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` Sets the performance preferences as specified in `Socket.setPerformancePreferences(int, int, int)`.
`void`	`setReceiveBufferSize(int receiveBufferSize)` Gets the `SO_RCVBUF` option.
`void`	`setReuseAddress(boolean reuseAddress)` Sets the `SO_REUSEADDR` option.
`void`	`setSendBufferSize(int sendBufferSize)` Sets the `SO_SNDBUF` option.
`void`	`setSoLinger(int soLinger)` Sets the `SO_LINGER` option.
`void`	`setTcpNoDelay(boolean tcpNoDelay)` Sets the `SO_TCPNODELAY` option.
`void`	`setTrafficClass(int trafficClass)` Sets the traffic class as specified in `Socket.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

DefaultSocketChannelConfig

public DefaultSocketChannelConfig(Socket 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