io.netty.channel.udt

Class DefaultUdtChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.udt.DefaultUdtChannelConfig

All Implemented Interfaces:

ChannelConfig, UdtChannelConfig

Direct Known Subclasses:

DefaultUdtServerChannelConfig

public class DefaultUdtChannelConfig
extends DefaultChannelConfig
implements UdtChannelConfig

The default UdtChannelConfig implementation.

Field Summary

Fields inherited from class io.netty.channel.DefaultChannelConfig

channel

Constructor Summary

Constructors

Constructor and Description
DefaultUdtChannelConfig(UdtChannel channel, com.barchart.udt.nio.ChannelUDT channelUDT, boolean apply)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	apply(com.barchart.udt.nio.ChannelUDT channelUDT)
<T> T	getOption(ChannelOption<T> option) Return the value of the given ChannelOption
Map<ChannelOption<?>,Object>	getOptions() Return all set ChannelOption's.
int	getProtocolReceiveBufferSize() Gets OptionUDT.Protocol_Receive_Buffer_Size
int	getProtocolSendBufferSize() Gets OptionUDT.Protocol_Send_Buffer_Size
int	getReceiveBufferSize() Gets the ChannelOption.SO_RCVBUF option.
int	getSendBufferSize() Gets the ChannelOption.SO_SNDBUF option.
int	getSoLinger() Gets the ChannelOption.SO_LINGER option.
int	getSystemReceiveBufferSize() Gets OptionUDT.System_Receive_Buffer_Size
int	getSystemSendBufferSize() Gets OptionUDT.System_Send_Buffer_Size
boolean	isReuseAddress() Gets the ChannelOption.SO_REUSEADDR option.
UdtChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
UdtChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
UdtChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
UdtChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Sets the maximum number of messages to read per read loop.
UdtChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Set the ByteBufAllocator which is used for the channel to detect the size of a message.
<T> boolean	setOption(ChannelOption<T> option, T value) Sets a configuration property with the specified name and value.
UdtChannelConfig	setProtocolReceiveBufferSize(int protocolReceiveBufferSize) Sets OptionUDT.Protocol_Receive_Buffer_Size
UdtChannelConfig	setProtocolSendBufferSize(int protocolSendBufferSize) Sets OptionUDT.Protocol_Send_Buffer_Size
UdtChannelConfig	setReceiveBufferSize(int receiveBufferSize) Sets the ChannelOption.SO_RCVBUF option.
UdtChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
UdtChannelConfig	setReuseAddress(boolean reuseAddress) Sets the ChannelOption.SO_REUSEADDR option.
UdtChannelConfig	setSendBufferSize(int sendBufferSize) Sets the ChannelOption.SO_SNDBUF option.
UdtChannelConfig	setSoLinger(int soLinger) Sets the ChannelOption.SO_LINGER option.
UdtChannelConfig	setSystemReceiveBufferSize(int systemSendBufferSize) Sets OptionUDT.System_Receive_Buffer_Size
UdtChannelConfig	setSystemSendBufferSize(int systemReceiveBufferSize) Sets OptionUDT.System_Send_Buffer_Size
UdtChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
UdtChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
UdtChannelConfig	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 io.netty.channel.DefaultChannelConfig

autoReadCleared, getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoRead, setOptions, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoRead, setOptions

Constructor Detail

DefaultUdtChannelConfig

public DefaultUdtChannelConfig(UdtChannel channel,
                       com.barchart.udt.nio.ChannelUDT channelUDT,
                       boolean apply)
                        throws IOException

Throws:

IOException

Method Detail

apply

protected void apply(com.barchart.udt.nio.ChannelUDT channelUDT)
              throws IOException

Throws:

IOException

getProtocolReceiveBufferSize

public int getProtocolReceiveBufferSize()

Description copied from interface: UdtChannelConfig

Gets OptionUDT.Protocol_Receive_Buffer_Size

Specified by:

getProtocolReceiveBufferSize in interface UdtChannelConfig

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

Overrides:

getOption in class DefaultChannelConfig

getOptions

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

Description copied from interface: ChannelConfig

Return all set ChannelOption's.

Specified by:

getOptions in interface ChannelConfig

Overrides:

getOptions in class DefaultChannelConfig

getReceiveBufferSize

public int getReceiveBufferSize()

Description copied from interface: UdtChannelConfig

Gets the ChannelOption.SO_RCVBUF option.

Specified by:

getReceiveBufferSize in interface UdtChannelConfig

getSendBufferSize

public int getSendBufferSize()

Description copied from interface: UdtChannelConfig

Gets the ChannelOption.SO_SNDBUF option.

Specified by:

getSendBufferSize in interface UdtChannelConfig

getSoLinger

public int getSoLinger()

Description copied from interface: UdtChannelConfig

Gets the ChannelOption.SO_LINGER option.

Specified by:

getSoLinger in interface UdtChannelConfig

isReuseAddress

public boolean isReuseAddress()

Description copied from interface: UdtChannelConfig

Gets the ChannelOption.SO_REUSEADDR option.

Specified by:

isReuseAddress in interface UdtChannelConfig

setProtocolReceiveBufferSize

public UdtChannelConfig setProtocolReceiveBufferSize(int protocolReceiveBufferSize)

Description copied from interface: UdtChannelConfig

Sets OptionUDT.Protocol_Receive_Buffer_Size

Specified by:

setProtocolReceiveBufferSize in interface UdtChannelConfig

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

Overrides:

setOption in class DefaultChannelConfig

Returns:

true if and only if the property has been set

setReceiveBufferSize

public UdtChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: UdtChannelConfig

Sets the ChannelOption.SO_RCVBUF option.

Specified by:

setReceiveBufferSize in interface UdtChannelConfig

setReuseAddress

public UdtChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: UdtChannelConfig

Sets the ChannelOption.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface UdtChannelConfig

setSendBufferSize

public UdtChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: UdtChannelConfig

Sets the ChannelOption.SO_SNDBUF option.

Specified by:

setSendBufferSize in interface UdtChannelConfig

setSoLinger

public UdtChannelConfig setSoLinger(int soLinger)

Description copied from interface: UdtChannelConfig

Sets the ChannelOption.SO_LINGER option.

Specified by:

setSoLinger in interface UdtChannelConfig

getSystemReceiveBufferSize

public int getSystemReceiveBufferSize()

Description copied from interface: UdtChannelConfig

Gets OptionUDT.System_Receive_Buffer_Size

Specified by:

getSystemReceiveBufferSize in interface UdtChannelConfig

setSystemSendBufferSize

public UdtChannelConfig setSystemSendBufferSize(int systemReceiveBufferSize)

Description copied from interface: UdtChannelConfig

Sets OptionUDT.System_Send_Buffer_Size

Specified by:

setSystemSendBufferSize in interface UdtChannelConfig

getProtocolSendBufferSize

public int getProtocolSendBufferSize()

Description copied from interface: UdtChannelConfig

Gets OptionUDT.Protocol_Send_Buffer_Size

Specified by:

getProtocolSendBufferSize in interface UdtChannelConfig

setProtocolSendBufferSize

public UdtChannelConfig setProtocolSendBufferSize(int protocolSendBufferSize)

Description copied from interface: UdtChannelConfig

Sets OptionUDT.Protocol_Send_Buffer_Size

Specified by:

setProtocolSendBufferSize in interface UdtChannelConfig

setSystemReceiveBufferSize

public UdtChannelConfig setSystemReceiveBufferSize(int systemSendBufferSize)

Description copied from interface: UdtChannelConfig

Sets OptionUDT.System_Receive_Buffer_Size

Specified by:

setSystemReceiveBufferSize in interface UdtChannelConfig

getSystemSendBufferSize

public int getSystemSendBufferSize()

Description copied from interface: UdtChannelConfig

Gets OptionUDT.System_Send_Buffer_Size

Specified by:

getSystemSendBufferSize in interface UdtChannelConfig

setConnectTimeoutMillis

public UdtChannelConfig 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

Specified by:

setConnectTimeoutMillis in interface UdtChannelConfig

Overrides:

setConnectTimeoutMillis in class DefaultChannelConfig

Parameters:

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

setMaxMessagesPerRead

public UdtChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Description copied from interface: ChannelConfig

Sets the maximum number of messages to read per read loop. If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface UdtChannelConfig

Overrides:

setMaxMessagesPerRead in class DefaultChannelConfig

setWriteSpinCount

public UdtChannelConfig 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

Specified by:

setWriteSpinCount in interface UdtChannelConfig

Overrides:

setWriteSpinCount in class DefaultChannelConfig

setAllocator

public UdtChannelConfig 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

Specified by:

setAllocator in interface UdtChannelConfig

Overrides:

setAllocator in class DefaultChannelConfig

setRecvByteBufAllocator

public UdtChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

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

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

Specified by:

setRecvByteBufAllocator in interface UdtChannelConfig

Overrides:

setRecvByteBufAllocator in class DefaultChannelConfig

setAutoRead

public UdtChannelConfig setAutoRead(boolean autoRead)

Description copied from interface: ChannelConfig

Sets if ChannelHandlerContext.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

Specified by:

setAutoRead in interface UdtChannelConfig

Overrides:

setAutoRead in class DefaultChannelConfig

setWriteBufferLowWaterMark

public UdtChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Description copied from interface: ChannelConfig

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 to return true again.

Specified by:

setWriteBufferLowWaterMark in interface ChannelConfig

Specified by:

setWriteBufferLowWaterMark in interface UdtChannelConfig

Overrides:

setWriteBufferLowWaterMark in class DefaultChannelConfig

setWriteBufferHighWaterMark

public UdtChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Description copied from interface: ChannelConfig

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 ChannelConfig

Specified by:

setWriteBufferHighWaterMark in interface UdtChannelConfig

Overrides:

setWriteBufferHighWaterMark in class DefaultChannelConfig

setMessageSizeEstimator

public UdtChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Description copied from interface: ChannelConfig

Set the ByteBufAllocator which is used for the channel to detect the size of a message.

Specified by:

setMessageSizeEstimator in interface ChannelConfig

Specified by:

setMessageSizeEstimator in interface UdtChannelConfig

Overrides:

setMessageSizeEstimator in class DefaultChannelConfig