io.netty.channel

Interface ChannelConfig

All Known Subinterfaces:

DatagramChannelConfig, ServerSocketChannelConfig, SocketChannelConfig

All Known Implementing Classes:

DefaultChannelConfig, DefaultDatagramChannelConfig, DefaultServerSocketChannelConfig, DefaultSocketChannelConfig

public interface ChannelConfig

A set of configuration properties of a Channel.

Please down-cast to more specific configuration type such as SocketChannelConfig or use setOptions(Map) to set the transport-specific properties:

 Channel ch = ...;
 SocketChannelConfig cfg = (SocketChannelConfig) ch.getConfig();
 cfg.setTcpNoDelay(false);
 

Option map

An option map property is a dynamic write-only property which allows the configuration of a Channel without down-casting its associated ChannelConfig. To update an option map, please call setOptions(Map).

All ChannelConfig has the following options:

Name	Associated setter method
"connectTimeoutMillis"	setConnectTimeoutMillis(int)

More options are available in the sub-types of ChannelConfig. For example, you can configure the parameters which are specific to a TCP/IP socket as explained in SocketChannelConfig.

Method Summary

Methods

Modifier and Type	Method and Description
int	getConnectTimeoutMillis() Returns the connect timeout of the channel in milliseconds.
<T> T	getOption(ChannelOption<T> option) Return the value of the given ChannelOption
Map<ChannelOption<?>,Object>	getOptions() Return all set ChannelOption's.
int	getWriteSpinCount() Returns the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.
void	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
<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.
void	setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

Method Detail

getOptions

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

Return all set ChannelOption's.

setOptions

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

Sets the configuration properties from the specified Map.

getOption

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

Return the value of the given ChannelOption

setOption

<T> boolean setOption(ChannelOption<T> option,
                    T value)

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;
 }
 

Returns:

true if and only if the property has been set

getConnectTimeoutMillis

int getConnectTimeoutMillis()

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.

Returns:

the connect timeout in milliseconds. 0 if disabled.

setConnectTimeoutMillis

void setConnectTimeoutMillis(int connectTimeoutMillis)

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.

Parameters:

connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.

getWriteSpinCount

int getWriteSpinCount()

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.

setWriteSpinCount

void setWriteSpinCount(int writeSpinCount)

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.

Throws:

IllegalArgumentException - if the specified value is 0 or less than 0