org.jboss.netty.channel.socket.nio

Class DefaultNioSocketChannelConfig

java.lang.Object

org.jboss.netty.channel.DefaultChannelConfig

org.jboss.netty.channel.socket.DefaultSocketChannelConfig

org.jboss.netty.channel.socket.nio.DefaultNioSocketChannelConfig

All Implemented Interfaces:

ChannelConfig, NioChannelConfig, NioSocketChannelConfig, SocketChannelConfig

class DefaultNioSocketChannelConfig
extends DefaultSocketChannelConfig
implements NioSocketChannelConfig

The default NioSocketChannelConfig implementation.

Field Summary

Fields

Modifier and Type	Field and Description
private static ReceiveBufferSizePredictorFactory	DEFAULT_PREDICTOR_FACTORY
private static InternalLogger	logger
private ReceiveBufferSizePredictor	predictor
private ReceiveBufferSizePredictorFactory	predictorFactory
private int	writeBufferHighWaterMark
private int	writeBufferLowWaterMark
private int	writeSpinCount

Constructor Summary

Constructors

Constructor and Description
DefaultNioSocketChannelConfig(java.net.Socket socket)

Method Summary

Modifier and Type	Method and Description
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	getWriteBufferHighWaterMark() Returns the high water mark of the write buffer.
int	getWriteBufferLowWaterMark() Returns the low water mark of the write buffer.
int	getWriteSpinCount() Returns the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.
boolean	setOption(java.lang.String key, java.lang.Object value) Sets a configuration property with the specified name and value.
void	setOptions(java.util.Map<java.lang.String,java.lang.Object> options) Sets the configuration properties from the specified Map.
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	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
private void	setWriteBufferHighWaterMark0(int writeBufferHighWaterMark)
void	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
private void	setWriteBufferLowWaterMark0(int writeBufferLowWaterMark)
void	setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

Methods inherited from class org.jboss.netty.channel.socket.DefaultSocketChannelConfig

getReceiveBufferSize, getSendBufferSize, getSoLinger, getTrafficClass, isKeepAlive, isReuseAddress, isTcpNoDelay, setKeepAlive, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSoLinger, setTcpNoDelay, setTrafficClass

Methods inherited from class org.jboss.netty.channel.DefaultChannelConfig

getBufferFactory, getConnectTimeoutMillis, getPipelineFactory, setBufferFactory, setConnectTimeoutMillis, 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.socket.SocketChannelConfig

getReceiveBufferSize, getSendBufferSize, getSoLinger, getTrafficClass, isKeepAlive, isReuseAddress, isTcpNoDelay, setKeepAlive, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSoLinger, setTcpNoDelay, setTrafficClass

Methods inherited from interface org.jboss.netty.channel.ChannelConfig

getBufferFactory, getConnectTimeoutMillis, getPipelineFactory, setBufferFactory, setConnectTimeoutMillis, setPipelineFactory

Field Detail

logger

private static final InternalLogger logger

DEFAULT_PREDICTOR_FACTORY

private static final ReceiveBufferSizePredictorFactory DEFAULT_PREDICTOR_FACTORY

writeBufferHighWaterMark

private volatile int writeBufferHighWaterMark

writeBufferLowWaterMark

private volatile int writeBufferLowWaterMark

predictor

private volatile ReceiveBufferSizePredictor predictor

predictorFactory

private volatile ReceiveBufferSizePredictorFactory predictorFactory

writeSpinCount

private volatile int writeSpinCount

Constructor Detail

DefaultNioSocketChannelConfig

DefaultNioSocketChannelConfig(java.net.Socket socket)

Method Detail

setOptions

public void setOptions(java.util.Map<java.lang.String,java.lang.Object> options)

Description copied from interface: ChannelConfig

Sets the configuration properties from the specified Map.

Specified by:

setOptions in interface ChannelConfig

Overrides:

setOptions in class DefaultChannelConfig

setOption

public boolean setOption(java.lang.String key,
                         java.lang.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 DefaultSocketChannelConfig

Returns:

true if and only if the property has been set

getWriteBufferHighWaterMark

public int getWriteBufferHighWaterMark()

Description copied from interface: NioChannelConfig

Returns the high water mark of the write buffer. If the number of bytes queued in the write buffer exceeds this value, Channel.isWritable() will start to return false.

Specified by:

getWriteBufferHighWaterMark in interface NioChannelConfig

setWriteBufferHighWaterMark

public void setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Description copied from interface: NioChannelConfig

Sets the high water mark of the write buffer. If the number of bytes queued in the write buffer exceeds this value, Channel.isWritable() will start to return false.

Specified by:

setWriteBufferHighWaterMark in interface NioChannelConfig

setWriteBufferHighWaterMark0

private void setWriteBufferHighWaterMark0(int writeBufferHighWaterMark)

getWriteBufferLowWaterMark

public int getWriteBufferLowWaterMark()

Description copied from interface: NioChannelConfig

Returns the low water mark of the write buffer. Once the number of bytes queued in the write buffer exceeded the high water mark and then dropped down below this value, Channel.isWritable() will start to return true again.

Specified by:

getWriteBufferLowWaterMark in interface NioChannelConfig

setWriteBufferLowWaterMark

public void setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Description copied from interface: NioChannelConfig

Sets the low water mark of the write buffer. Once the number of bytes queued in the write buffer exceeded the high water mark and then dropped down below this value, Channel.isWritable() will start toreturn true again.

Specified by:

setWriteBufferLowWaterMark in interface NioChannelConfig

setWriteBufferLowWaterMark0

private void setWriteBufferLowWaterMark0(int writeBufferLowWaterMark)

getWriteSpinCount

public int getWriteSpinCount()

Description copied from interface: NioChannelConfig

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 NioChannelConfig

setWriteSpinCount

public void setWriteSpinCount(int writeSpinCount)

Description copied from interface: NioChannelConfig

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 NioChannelConfig

getReceiveBufferSizePredictor

public ReceiveBufferSizePredictor getReceiveBufferSizePredictor()

Description copied from interface: NioSocketChannelConfig

Returns the ReceiveBufferSizePredictor which predicts the number of readable bytes in the socket receive buffer. The default predictor is AdaptiveReceiveBufferSizePredictor(64, 1024, 65536).

Specified by:

getReceiveBufferSizePredictor in interface NioSocketChannelConfig

setReceiveBufferSizePredictor

public void setReceiveBufferSizePredictor(ReceiveBufferSizePredictor predictor)

Description copied from interface: NioSocketChannelConfig

Sets the ReceiveBufferSizePredictor which predicts the number of readable bytes in the socket receive buffer. The default predictor is AdaptiveReceiveBufferSizePredictor(64, 1024, 65536).

Specified by:

setReceiveBufferSizePredictor in interface NioSocketChannelConfig

getReceiveBufferSizePredictorFactory

public ReceiveBufferSizePredictorFactory getReceiveBufferSizePredictorFactory()

Description copied from interface: NioSocketChannelConfig

Returns the ReceiveBufferSizePredictorFactory which creates a new ReceiveBufferSizePredictor when a new channel is created and no ReceiveBufferSizePredictor was set. If no predictor was set for the channel, NioSocketChannelConfig.setReceiveBufferSizePredictor(ReceiveBufferSizePredictor) will be called with the new predictor. The default factory is AdaptiveReceiveBufferSizePredictorFactory(64, 1024, 65536).

Specified by:

getReceiveBufferSizePredictorFactory in interface NioSocketChannelConfig

setReceiveBufferSizePredictorFactory

public void setReceiveBufferSizePredictorFactory(ReceiveBufferSizePredictorFactory predictorFactory)

Description copied from interface: NioSocketChannelConfig

Sets the ReceiveBufferSizePredictor which creates a new ReceiveBufferSizePredictor when a new channel is created and no ReceiveBufferSizePredictor was set. If no predictor was set for the channel, NioSocketChannelConfig.setReceiveBufferSizePredictor(ReceiveBufferSizePredictor) will be called with the new predictor. The default factory is AdaptiveReceiveBufferSizePredictorFactory(64, 1024, 65536).

Specified by:

setReceiveBufferSizePredictorFactory in interface NioSocketChannelConfig