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
Class DefaultChannelConfig

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

All Implemented Interfaces:
  ChannelConfig

Direct Known Subclasses:
  DefaultDatagramChannelConfig, DefaultSocketChannelConfig

    public class DefaultChannelConfig

extends Object
implements ChannelConfig

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
`DefaultChannelConfig()` Creates a new instance.

Method Summary
`ChannelBufferFactory` | `getBufferFactory()` Returns the default `ChannelBufferFactory` used to create a new `ChannelBuffer`.
`int` | `getConnectTimeoutMillis()` Returns the connect timeout of the channel in milliseconds.
`ChannelPipelineFactory` | `getPipelineFactory()` Returns the `ChannelPipelineFactory` which will be used when a child channel is created.
`void` | `setBufferFactory(ChannelBufferFactory bufferFactory)` Sets the default `ChannelBufferFactory` used to create a new `ChannelBuffer`.
`void` | `setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`boolean` | `setOption(String key, Object value)` Sets a configuration property with the specified name and value.
`void` | `setOptions(Map<String,Object> options)` Sets the configuration properties from the specified `Map`.
`void` | `setPipelineFactory(ChannelPipelineFactory pipelineFactory)` Sets the `ChannelPipelineFactory` which will be used when a child channel is created.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### DefaultChannelConfig

    public DefaultChannelConfig()

  Creates a new instance.

Method Detail

### setOptions

    public void setOptions(Map<String,Object> options)

  Description copied from interface: `ChannelConfig`
  Sets the configuration properties from the specified `Map`.

  Specified by:
    `setOptions` in interface `ChannelConfig`

### 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`
  Returns:
    `true` if and only if the property has been set

### getConnectTimeoutMillis

    public int getConnectTimeoutMillis()

  Description copied from interface: `ChannelConfig`
  Returns the connect timeout of the channel in milliseconds. If the `Channel` does not support connect operation, this property is not used at all, and therefore will be ignored.

  Specified by:
    `getConnectTimeoutMillis` in interface `ChannelConfig`
  Returns:
    the connect timeout in milliseconds. `0` if disabled.

### getBufferFactory

    public ChannelBufferFactory getBufferFactory()

  Description copied from interface: `ChannelConfig`
  Returns the default `ChannelBufferFactory` used to create a new `ChannelBuffer`. The default is `HeapChannelBufferFactory`. You can specify a different factory to change the default `ByteOrder` for example.

  Specified by:
    `getBufferFactory` in interface `ChannelConfig`

### setBufferFactory

    public void setBufferFactory(ChannelBufferFactory bufferFactory)

  Description copied from interface: `ChannelConfig`
  Sets the default `ChannelBufferFactory` used to create a new `ChannelBuffer`. The default is `HeapChannelBufferFactory`. You can specify a different factory to change the default `ByteOrder` for example.

  Specified by:
    `setBufferFactory` in interface `ChannelConfig`

### getPipelineFactory

    public ChannelPipelineFactory getPipelineFactory()

  Description copied from interface: `ChannelConfig`
  Returns the `ChannelPipelineFactory` which will be used when a child channel is created. If the `Channel` does not create a child channel, this property is not used at all, and therefore will be ignored.

  Specified by:
    `getPipelineFactory` in interface `ChannelConfig`

### setConnectTimeoutMillis

    public void setConnectTimeoutMillis(int connectTimeoutMillis)

  Description copied from interface: `ChannelConfig`
  Sets the connect timeout of the channel in milliseconds. If the `Channel` does not support connect operation, this property is not used at all, and therefore will be ignored.

  Specified by:
    `setConnectTimeoutMillis` in interface `ChannelConfig`
  Parameters:
    `connectTimeoutMillis` - the connect timeout in milliseconds. `0` to disable.

### setPipelineFactory

    public void setPipelineFactory(ChannelPipelineFactory pipelineFactory)

  Description copied from interface: `ChannelConfig`
  Sets the `ChannelPipelineFactory` which will be used when a child channel is created. If the `Channel` does not create a child channel, this property is not used at all, and therefore will be ignored.

  Specified by:
    `setPipelineFactory` in interface `ChannelConfig`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008-2010 JBoss, a division of Red Hat, Inc.. All Rights Reserved.