io.netty.channel.udt

Interface UdtServerChannelConfig

All Superinterfaces:

ChannelConfig, UdtChannelConfig

All Known Implementing Classes:

DefaultUdtServerChannelConfig

public interface UdtServerChannelConfig
extends UdtChannelConfig

A ChannelConfig for a UdtServerChannel.

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	getBacklog() Gets KindUDT.ACCEPTOR channel backlog via ChannelOption.SO_BACKLOG.
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.
UdtServerChannelConfig	setProtocolReceiveBufferSize(int size) Sets OptionUDT.Protocol_Receive_Buffer_Size
UdtServerChannelConfig	setProtocolSendBufferSize(int size) 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 size) Sets OptionUDT.System_Receive_Buffer_Size
UdtServerChannelConfig	setSystemSendBufferSize(int size) 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 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, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOption, setOptions

Method Detail

getBacklog

int getBacklog()

Gets KindUDT.ACCEPTOR channel backlog via ChannelOption.SO_BACKLOG.

setBacklog

UdtServerChannelConfig setBacklog(int backlog)

Sets KindUDT.ACCEPTOR channel backlog via ChannelOption.SO_BACKLOG.

setConnectTimeoutMillis

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

Parameters:

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

setMaxMessagesPerRead

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

setWriteSpinCount

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

setAllocator

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

setRecvByteBufAllocator

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

setAutoRead

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

setAutoClose

UdtServerChannelConfig setAutoClose(boolean autoClose)

Specified by:

setAutoClose in interface ChannelConfig

Specified by:

setAutoClose in interface UdtChannelConfig

setProtocolReceiveBufferSize

UdtServerChannelConfig setProtocolReceiveBufferSize(int size)

Description copied from interface: UdtChannelConfig

Sets OptionUDT.Protocol_Receive_Buffer_Size

Specified by:

setProtocolReceiveBufferSize in interface UdtChannelConfig

setProtocolSendBufferSize

UdtServerChannelConfig setProtocolSendBufferSize(int size)

Description copied from interface: UdtChannelConfig

Sets OptionUDT.Protocol_Send_Buffer_Size

Specified by:

setProtocolSendBufferSize in interface UdtChannelConfig

setReceiveBufferSize

UdtServerChannelConfig setReceiveBufferSize(int receiveBufferSize)

Description copied from interface: UdtChannelConfig

Sets the ChannelOption.SO_RCVBUF option.

Specified by:

setReceiveBufferSize in interface UdtChannelConfig

setReuseAddress

UdtServerChannelConfig setReuseAddress(boolean reuseAddress)

Description copied from interface: UdtChannelConfig

Sets the ChannelOption.SO_REUSEADDR option.

Specified by:

setReuseAddress in interface UdtChannelConfig

setSendBufferSize

UdtServerChannelConfig setSendBufferSize(int sendBufferSize)

Description copied from interface: UdtChannelConfig

Sets the ChannelOption.SO_SNDBUF option.

Specified by:

setSendBufferSize in interface UdtChannelConfig

setSoLinger

UdtServerChannelConfig setSoLinger(int soLinger)

Description copied from interface: UdtChannelConfig

Sets the ChannelOption.SO_LINGER option.

Specified by:

setSoLinger in interface UdtChannelConfig

setSystemReceiveBufferSize

UdtServerChannelConfig setSystemReceiveBufferSize(int size)

Description copied from interface: UdtChannelConfig

Sets OptionUDT.System_Receive_Buffer_Size

Specified by:

setSystemReceiveBufferSize in interface UdtChannelConfig

setSystemSendBufferSize

UdtServerChannelConfig setSystemSendBufferSize(int size)

Description copied from interface: UdtChannelConfig

Sets OptionUDT.System_Send_Buffer_Size

Specified by:

setSystemSendBufferSize in interface UdtChannelConfig

setWriteBufferHighWaterMark

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

setWriteBufferLowWaterMark

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

setMessageSizeEstimator

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