io.netty.channel.udt

Class DefaultUdtServerChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.udt.DefaultUdtChannelConfig

io.netty.channel.udt.DefaultUdtServerChannelConfig

All Implemented Interfaces:

ChannelConfig, UdtChannelConfig, UdtServerChannelConfig

public class DefaultUdtServerChannelConfig
extends DefaultUdtChannelConfig
implements UdtServerChannelConfig

The default UdtServerChannelConfig implementation.

Field Summary

Fields inherited from class io.netty.channel.DefaultChannelConfig

channel

Constructor Summary

Constructors

Constructor and Description
DefaultUdtServerChannelConfig(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)
int	getBacklog() Gets KindUDT.ACCEPTOR channel backlog via ChannelOption.SO_BACKLOG.
<T> T	getOption(ChannelOption<T> option) Return the value of the given ChannelOption
Map<ChannelOption<?>,Object>	getOptions() Return all set ChannelOption's.
UdtServerChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
UdtServerChannelConfig	setAutoClose(boolean autoClose)
UdtServerChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
UdtServerChannelConfig	setBacklog(int backlog) Sets KindUDT.ACCEPTOR channel backlog via ChannelOption.SO_BACKLOG.
UdtServerChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
UdtServerChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Sets the maximum number of messages to read per read loop.
UdtServerChannelConfig	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.
UdtServerChannelConfig	setProtocolReceiveBufferSize(int protocolReceiveBuferSize) Sets OptionUDT.Protocol_Receive_Buffer_Size
UdtServerChannelConfig	setProtocolSendBufferSize(int protocolSendBuferSize) Sets OptionUDT.Protocol_Send_Buffer_Size
UdtServerChannelConfig	setReceiveBufferSize(int receiveBufferSize) Sets the ChannelOption.SO_RCVBUF option.
UdtServerChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
UdtServerChannelConfig	setReuseAddress(boolean reuseAddress) Sets the ChannelOption.SO_REUSEADDR option.
UdtServerChannelConfig	setSendBufferSize(int sendBufferSize) Sets the ChannelOption.SO_SNDBUF option.
UdtServerChannelConfig	setSoLinger(int soLinger) Sets the ChannelOption.SO_LINGER option.
UdtServerChannelConfig	setSystemReceiveBufferSize(int systemSendBuferSize) Sets OptionUDT.System_Receive_Buffer_Size
UdtServerChannelConfig	setSystemSendBufferSize(int systemReceiveBufferSize) Sets OptionUDT.System_Send_Buffer_Size
UdtServerChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
UdtServerChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
UdtServerChannelConfig	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.udt.DefaultUdtChannelConfig

getProtocolReceiveBufferSize, getProtocolSendBufferSize, getReceiveBufferSize, getSendBufferSize, getSoLinger, getSystemReceiveBufferSize, getSystemSendBufferSize, isReuseAddress

Methods inherited from class io.netty.channel.DefaultChannelConfig

autoReadCleared, getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoClose, 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.udt.UdtChannelConfig

getProtocolReceiveBufferSize, getProtocolSendBufferSize, getReceiveBufferSize, getSendBufferSize, getSoLinger, getSystemReceiveBufferSize, getSystemSendBufferSize, isReuseAddress

Methods inherited from interface io.netty.channel.ChannelConfig

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

Constructor Detail

DefaultUdtServerChannelConfig

public DefaultUdtServerChannelConfig(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

Overrides:

apply in class DefaultUdtChannelConfig

Throws:

IOException

getBacklog

public int getBacklog()

Description copied from interface: UdtServerChannelConfig

Gets KindUDT.ACCEPTOR channel backlog via ChannelOption.SO_BACKLOG.

Specified by:

getBacklog in interface UdtServerChannelConfig

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 DefaultUdtChannelConfig

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 DefaultUdtChannelConfig

setBacklog

public UdtServerChannelConfig setBacklog(int backlog)

Description copied from interface: UdtServerChannelConfig

Sets KindUDT.ACCEPTOR channel backlog via ChannelOption.SO_BACKLOG.

Specified by:

setBacklog in interface UdtServerChannelConfig

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 DefaultUdtChannelConfig

Returns:

true if and only if the property has been set

setProtocolReceiveBufferSize

public UdtServerChannelConfig setProtocolReceiveBufferSize(int protocolReceiveBuferSize)

Description copied from interface: UdtChannelConfig

Sets OptionUDT.Protocol_Receive_Buffer_Size

Specified by:

setProtocolReceiveBufferSize in interface UdtChannelConfig

Specified by:

setProtocolReceiveBufferSize in interface UdtServerChannelConfig

Overrides:

setProtocolReceiveBufferSize in class DefaultUdtChannelConfig

setProtocolSendBufferSize

public UdtServerChannelConfig setProtocolSendBufferSize(int protocolSendBuferSize)

Description copied from interface: UdtChannelConfig

Sets OptionUDT.Protocol_Send_Buffer_Size

Specified by:

setProtocolSendBufferSize in interface UdtChannelConfig

Specified by:

setProtocolSendBufferSize in interface UdtServerChannelConfig

Overrides:

setProtocolSendBufferSize in class DefaultUdtChannelConfig

setReceiveBufferSize

public UdtServerChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: UdtChannelConfig

Sets the ChannelOption.SO_RCVBUF option.

Specified by:

setReceiveBufferSize in interface UdtChannelConfig

Specified by:

setReceiveBufferSize in interface UdtServerChannelConfig

Overrides:

setReceiveBufferSize in class DefaultUdtChannelConfig

setReuseAddress

public UdtServerChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: UdtChannelConfig

Sets the ChannelOption.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface UdtChannelConfig

Specified by:

setReuseAddress in interface UdtServerChannelConfig

Overrides:

setReuseAddress in class DefaultUdtChannelConfig

setSendBufferSize

public UdtServerChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: UdtChannelConfig

Sets the ChannelOption.SO_SNDBUF option.

Specified by:

setSendBufferSize in interface UdtChannelConfig

Specified by:

setSendBufferSize in interface UdtServerChannelConfig

Overrides:

setSendBufferSize in class DefaultUdtChannelConfig

setSoLinger

public UdtServerChannelConfig setSoLinger(int soLinger)

Description copied from interface: UdtChannelConfig

Sets the ChannelOption.SO_LINGER option.

Specified by:

setSoLinger in interface UdtChannelConfig

Specified by:

setSoLinger in interface UdtServerChannelConfig

Overrides:

setSoLinger in class DefaultUdtChannelConfig

setSystemReceiveBufferSize

public UdtServerChannelConfig setSystemReceiveBufferSize(int systemSendBuferSize)

Description copied from interface: UdtChannelConfig

Sets OptionUDT.System_Receive_Buffer_Size

Specified by:

setSystemReceiveBufferSize in interface UdtChannelConfig

Specified by:

setSystemReceiveBufferSize in interface UdtServerChannelConfig

Overrides:

setSystemReceiveBufferSize in class DefaultUdtChannelConfig

setSystemSendBufferSize

public UdtServerChannelConfig setSystemSendBufferSize(int systemReceiveBufferSize)

Description copied from interface: UdtChannelConfig

Sets OptionUDT.System_Send_Buffer_Size

Specified by:

setSystemSendBufferSize in interface UdtChannelConfig

Specified by:

setSystemSendBufferSize in interface UdtServerChannelConfig

Overrides:

setSystemSendBufferSize in class DefaultUdtChannelConfig

setConnectTimeoutMillis

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

Specified by:

setConnectTimeoutMillis in interface UdtServerChannelConfig

Overrides:

setConnectTimeoutMillis in class DefaultUdtChannelConfig

Parameters:

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

setMaxMessagesPerRead

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

Specified by:

setMaxMessagesPerRead in interface UdtServerChannelConfig

Overrides:

setMaxMessagesPerRead in class DefaultUdtChannelConfig

setWriteSpinCount

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

Specified by:

setWriteSpinCount in interface UdtServerChannelConfig

Overrides:

setWriteSpinCount in class DefaultUdtChannelConfig

setAllocator

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

Specified by:

setAllocator in interface UdtServerChannelConfig

Overrides:

setAllocator in class DefaultUdtChannelConfig

setRecvByteBufAllocator

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

Specified by:

setRecvByteBufAllocator in interface UdtServerChannelConfig

Overrides:

setRecvByteBufAllocator in class DefaultUdtChannelConfig

setAutoRead

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

Specified by:

setAutoRead in interface UdtServerChannelConfig

Overrides:

setAutoRead in class DefaultUdtChannelConfig

setAutoClose

public UdtServerChannelConfig setAutoClose(boolean autoClose)

Specified by:

setAutoClose in interface ChannelConfig

Specified by:

setAutoClose in interface UdtChannelConfig

Specified by:

setAutoClose in interface UdtServerChannelConfig

Overrides:

setAutoClose in class DefaultUdtChannelConfig

setWriteBufferLowWaterMark

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

Specified by:

setWriteBufferLowWaterMark in interface UdtServerChannelConfig

Overrides:

setWriteBufferLowWaterMark in class DefaultUdtChannelConfig

setWriteBufferHighWaterMark

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

Specified by:

setWriteBufferHighWaterMark in interface UdtServerChannelConfig

Overrides:

setWriteBufferHighWaterMark in class DefaultUdtChannelConfig

setMessageSizeEstimator

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

Specified by:

setMessageSizeEstimator in interface UdtServerChannelConfig

Overrides:

setMessageSizeEstimator in class DefaultUdtChannelConfig