io.netty.channel

Class DefaultChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

All Implemented Interfaces:

ChannelConfig

Direct Known Subclasses:

DefaultDatagramChannelConfig, DefaultSctpChannelConfig, DefaultSctpServerChannelConfig, DefaultServerSocketChannelConfig, DefaultSocketChannelConfig, DefaultUdtChannelConfig

public class DefaultChannelConfig
extends Object
implements ChannelConfig

The default SocketChannelConfig implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelConfig

ChannelConfig.ChannelHandlerByteBufType

Field Summary

Fields

Modifier and Type	Field and Description
protected Channel	channel

Constructor Summary

Constructors

Constructor and Description
DefaultChannelConfig(Channel channel)

Method Summary

Methods

Modifier and Type	Method and Description
ByteBufAllocator	getAllocator() Returns ByteBufAllocator which is used for the channel to allocate buffers.
int	getConnectTimeoutMillis() Returns the connect timeout of the channel in milliseconds.
ChannelConfig.ChannelHandlerByteBufType	getDefaultHandlerByteBufType() Returns the ChannelConfig.ChannelHandlerByteBufType which is used to determine what kind of ByteBuf will be created by the ChannelInboundByteHandler.newInboundBuffer(ChannelHandlerContext) and ChannelOutboundByteHandler.newOutboundBuffer(ChannelHandlerContext) methods.
<T> T	getOption(ChannelOption<T> option) Return the value of the given ChannelOption
Map<ChannelOption<?>,Object>	getOptions() Return all set ChannelOption's.
protected Map<ChannelOption<?>,Object>	getOptions(Map<ChannelOption<?>,Object> result, ChannelOption<?>... options)
int	getWriteSpinCount() Returns the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.
boolean	isAutoRead() Returns true if and only if ChannelOutboundInvoker.read() will be invoked automatically so that a user application doesn't need to call it at all.
ChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
ChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelOutboundInvoker.read() will be invoked automatically so that a user application doesn't need to call it at all.
ChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
ChannelConfig	setDefaultHandlerByteBufType(ChannelConfig.ChannelHandlerByteBufType handlerByteBufType) Sets the ChannelConfig.ChannelHandlerByteBufType which is used to determine what kind of ByteBuf will be created by the ChannelInboundByteHandler.newInboundBuffer(ChannelHandlerContext) and ChannelOutboundByteHandler.newOutboundBuffer(ChannelHandlerContext) methods.
<T> boolean	setOption(ChannelOption<T> option, T value) Sets a configuration property with the specified name and value.
boolean	setOptions(Map<ChannelOption<?>,?> options) Sets the configuration properties from the specified Map.
ChannelConfig	setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.
protected <T> void	validate(ChannelOption<T> option, T value)

Methods inherited from class java.lang.Object

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

Field Detail

channel

protected final Channel channel

Constructor Detail

DefaultChannelConfig

public DefaultChannelConfig(Channel channel)

Method Detail

getOptions

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

Description copied from interface: ChannelConfig

Return all set ChannelOption's.

Specified by:

getOptions in interface ChannelConfig

getOptions

protected Map<ChannelOption<?>,Object> getOptions(Map<ChannelOption<?>,Object> result,
                                      ChannelOption<?>... options)

setOptions

public boolean setOptions(Map<ChannelOption<?>,?> options)

Description copied from interface: ChannelConfig

Sets the configuration properties from the specified Map.

Specified by:

setOptions in interface ChannelConfig

getOption

public <T> T getOption(ChannelOption<T> option)

Description copied from interface: ChannelConfig

Return the value of the given ChannelOption

Specified by:

getOption in interface ChannelConfig

setOption

public <T> boolean setOption(ChannelOption<T> option,
                    T 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(ChannelOption<T> option, T value) {
     if (super.setOption(option, value)) {
         return true;
     }

     if (option.equals(additionalOption)) {
         ....
         return true;
     }

     return false;
 }
 

Specified by:

setOption in interface ChannelConfig

Returns:

true if and only if the property has been set

validate

protected <T> void validate(ChannelOption<T> option,
                T value)

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.

setConnectTimeoutMillis

public ChannelConfig 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.

getWriteSpinCount

public int getWriteSpinCount()

Description copied from interface: ChannelConfig

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 ChannelConfig

setWriteSpinCount

public ChannelConfig setWriteSpinCount(int writeSpinCount)

Description copied from interface: ChannelConfig

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 ChannelConfig

getAllocator

public ByteBufAllocator getAllocator()

Description copied from interface: ChannelConfig

Returns ByteBufAllocator which is used for the channel to allocate buffers.

Specified by:

getAllocator in interface ChannelConfig

setAllocator

public ChannelConfig setAllocator(ByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the ByteBufAllocator which is used for the channel to allocate buffers.

Specified by:

setAllocator in interface ChannelConfig

isAutoRead

public boolean isAutoRead()

Description copied from interface: ChannelConfig

Returns true if and only if ChannelOutboundInvoker.read() will be invoked automatically so that a user application doesn't need to call it at all. The default value is true.

Specified by:

isAutoRead in interface ChannelConfig

setAutoRead

public ChannelConfig setAutoRead(boolean autoRead)

Description copied from interface: ChannelConfig

Sets if ChannelOutboundInvoker.read() will be invoked automatically so that a user application doesn't need to call it at all. The default value is true.

Specified by:

setAutoRead in interface ChannelConfig

getDefaultHandlerByteBufType

public ChannelConfig.ChannelHandlerByteBufType getDefaultHandlerByteBufType()

Description copied from interface: ChannelConfig

Returns the ChannelConfig.ChannelHandlerByteBufType which is used to determine what kind of ByteBuf will be created by the ChannelInboundByteHandler.newInboundBuffer(ChannelHandlerContext) and ChannelOutboundByteHandler.newOutboundBuffer(ChannelHandlerContext) methods.

The implementation of ChannelInboundByteHandler or ChannelOutboundByteHandler may still return another ByteBuf if it depends on a special type. The default is ChannelConfig.ChannelHandlerByteBufType.PREFER_DIRECT.

Specified by:

getDefaultHandlerByteBufType in interface ChannelConfig

setDefaultHandlerByteBufType

public ChannelConfig setDefaultHandlerByteBufType(ChannelConfig.ChannelHandlerByteBufType handlerByteBufType)

Description copied from interface: ChannelConfig

Sets the ChannelConfig.ChannelHandlerByteBufType which is used to determine what kind of ByteBuf will be created by the ChannelInboundByteHandler.newInboundBuffer(ChannelHandlerContext) and ChannelOutboundByteHandler.newOutboundBuffer(ChannelHandlerContext) methods.

Specified by:

setDefaultHandlerByteBufType in interface ChannelConfig