io.netty.channel.udt

Interface UdtChannelConfig

All Superinterfaces:

ChannelConfig

All Known Subinterfaces:

UdtServerChannelConfig

All Known Implementing Classes:

DefaultUdtChannelConfig, DefaultUdtServerChannelConfig

public interface UdtChannelConfig
extends ChannelConfig

A ChannelConfig for a UdtChannel.

Available options

In addition to the options provided by ChannelConfig, UdtChannelConfig allows the following options in the option map:

Name	Associated setter method
ChannelOption.SO_REUSEADDR	setReuseAddress(boolean)
ChannelOption.SO_RCVBUF	setReceiveBufferSize(int)
ChannelOption.SO_SNDBUF	setSendBufferSize(int)
ChannelOption.SO_REUSEADDR	setReuseAddress(boolean)
ChannelOption.SO_LINGER	setSoLinger(int)
ChannelOption.SO_RCVBUF	setReceiveBufferSize(int)
ChannelOption.SO_SNDBUF	setSendBufferSize(int)
UdtChannelOption.PROTOCOL_RECEIVE_BUFFER_SIZE	setProtocolReceiveBufferSize(int)
UdtChannelOption.PROTOCOL_SEND_BUFFER_SIZE	setProtocolSendBufferSize(int)
UdtChannelOption.SYSTEM_RECEIVE_BUFFER_SIZE	setSystemReceiveBufferSize(int)
UdtChannelOption.SYSTEM_SEND_BUFFER_SIZE	setSystemSendBufferSize(int)

Note that TypeUDT.DATAGRAM message oriented channels treat "receiveBufferSize" and "sendBufferSize" as maximum message size. If received or sent message does not fit specified sizes, ChannelException will be thrown.

Method Summary

Methods

Modifier and Type	Method and Description
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 ChannelOutboundInvoker.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 in a MessageList of a channelRead() event.
UdtChannelConfig	setProtocolReceiveBufferSize(int size) Sets OptionUDT.Protocol_Receive_Buffer_Size
UdtChannelConfig	setProtocolSendBufferSize(int size) 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 size) Sets OptionUDT.System_Receive_Buffer_Size
UdtChannelConfig	setSystemSendBufferSize(int size) Sets OptionUDT.System_Send_Buffer_Size
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 interface io.netty.channel.ChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoRead, setOption, setOptions, setWriteBufferHighWaterMark, setWriteBufferLowWaterMark

Method Detail

getProtocolReceiveBufferSize

int getProtocolReceiveBufferSize()

Gets OptionUDT.Protocol_Receive_Buffer_Size

getProtocolSendBufferSize

int getProtocolSendBufferSize()

Gets OptionUDT.Protocol_Send_Buffer_Size

getReceiveBufferSize

int getReceiveBufferSize()

Gets the ChannelOption.SO_RCVBUF option.

getSendBufferSize

int getSendBufferSize()

Gets the ChannelOption.SO_SNDBUF option.

getSoLinger

int getSoLinger()

Gets the ChannelOption.SO_LINGER option.

getSystemReceiveBufferSize

int getSystemReceiveBufferSize()

Gets OptionUDT.System_Receive_Buffer_Size

getSystemSendBufferSize

int getSystemSendBufferSize()

Gets OptionUDT.System_Send_Buffer_Size

isReuseAddress

boolean isReuseAddress()

Gets the ChannelOption.SO_REUSEADDR option.

setConnectTimeoutMillis

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

Parameters:

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

setMaxMessagesPerRead

UdtChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Description copied from interface: ChannelConfig

Sets the maximum number of messages in a MessageList of a channelRead() event. If this value is greater than 1, an event loop might attempt to read multiple times to fill multiple messages into the MessageList.

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

setWriteSpinCount

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

setAllocator

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

setRecvByteBufAllocator

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

setAutoRead

UdtChannelConfig 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

setProtocolReceiveBufferSize

UdtChannelConfig setProtocolReceiveBufferSize(int size)

Sets OptionUDT.Protocol_Receive_Buffer_Size

setProtocolSendBufferSize

UdtChannelConfig setProtocolSendBufferSize(int size)

Sets OptionUDT.Protocol_Send_Buffer_Size

setReceiveBufferSize

UdtChannelConfig setReceiveBufferSize(int receiveBufferSize)

Sets the ChannelOption.SO_RCVBUF option.

setReuseAddress

UdtChannelConfig setReuseAddress(boolean reuseAddress)

Sets the ChannelOption.SO_REUSEADDR option.

setSendBufferSize

UdtChannelConfig setSendBufferSize(int sendBufferSize)

Sets the ChannelOption.SO_SNDBUF option.

setSoLinger

UdtChannelConfig setSoLinger(int soLinger)

Sets the ChannelOption.SO_LINGER option.

setSystemReceiveBufferSize

UdtChannelConfig setSystemReceiveBufferSize(int size)

Sets OptionUDT.System_Receive_Buffer_Size

setSystemSendBufferSize

UdtChannelConfig setSystemSendBufferSize(int size)

Sets OptionUDT.System_Send_Buffer_Size