Package io.netty.channel.udt
Interface UdtChannelConfig
-
- All Superinterfaces:
ChannelConfig
- All Known Subinterfaces:
UdtServerChannelConfig
- All Known Implementing Classes:
DefaultUdtChannelConfig
,DefaultUdtServerChannelConfig
@Deprecated public interface UdtChannelConfig extends ChannelConfig
Deprecated.The UDT transport is no longer maintained and will be removed.AChannelConfig
for aUdtChannel
.Available options
In addition to the options provided byChannelConfig
,UdtChannelConfig
allows the following options in the option map: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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description int
getProtocolReceiveBufferSize()
Deprecated.GetsOptionUDT.Protocol_Receive_Buffer_Size
int
getProtocolSendBufferSize()
Deprecated.GetsOptionUDT.Protocol_Send_Buffer_Size
int
getReceiveBufferSize()
Deprecated.Gets theChannelOption.SO_RCVBUF
option.int
getSendBufferSize()
Deprecated.Gets theChannelOption.SO_SNDBUF
option.int
getSoLinger()
Deprecated.Gets theChannelOption.SO_LINGER
option.int
getSystemReceiveBufferSize()
Deprecated.GetsOptionUDT.System_Receive_Buffer_Size
int
getSystemSendBufferSize()
Deprecated.GetsOptionUDT.System_Send_Buffer_Size
boolean
isReuseAddress()
Deprecated.Gets theChannelOption.SO_REUSEADDR
option.UdtChannelConfig
setAllocator(ByteBufAllocator allocator)
Deprecated.Set theByteBufAllocator
which is used for the channel to allocate buffers.UdtChannelConfig
setAutoClose(boolean autoClose)
Deprecated.Sets whether theChannel
should be closed automatically and immediately on write failure.UdtChannelConfig
setAutoRead(boolean autoRead)
Deprecated.Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all.UdtChannelConfig
setConnectTimeoutMillis(int connectTimeoutMillis)
Deprecated.Sets the connect timeout of the channel in milliseconds.UdtChannelConfig
setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.UdtChannelConfig
setMessageSizeEstimator(MessageSizeEstimator estimator)
Deprecated.Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.UdtChannelConfig
setProtocolReceiveBufferSize(int size)
Deprecated.SetsOptionUDT.Protocol_Receive_Buffer_Size
UdtChannelConfig
setProtocolSendBufferSize(int size)
Deprecated.SetsOptionUDT.Protocol_Send_Buffer_Size
UdtChannelConfig
setReceiveBufferSize(int receiveBufferSize)
Deprecated.Sets theChannelOption.SO_RCVBUF
option.UdtChannelConfig
setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Deprecated.Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.UdtChannelConfig
setReuseAddress(boolean reuseAddress)
Deprecated.Sets theChannelOption.SO_REUSEADDR
option.UdtChannelConfig
setSendBufferSize(int sendBufferSize)
Deprecated.Sets theChannelOption.SO_SNDBUF
option.UdtChannelConfig
setSoLinger(int soLinger)
Deprecated.Sets theChannelOption.SO_LINGER
option.UdtChannelConfig
setSystemReceiveBufferSize(int size)
Deprecated.SetsOptionUDT.System_Receive_Buffer_Size
UdtChannelConfig
setSystemSendBufferSize(int size)
Deprecated.SetsOptionUDT.System_Send_Buffer_Size
UdtChannelConfig
setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Deprecated.Sets the high water mark of the write buffer.UdtChannelConfig
setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Deprecated.Sets the low water mark of the write buffer.UdtChannelConfig
setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Deprecated.Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.UdtChannelConfig
setWriteSpinCount(int writeSpinCount)
Deprecated.Sets the maximum loop count for a write operation untilWritableByteChannel.write(ByteBuffer)
returns a non-zero value.-
Methods inherited from interface io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOption, setOptions
-
-
-
-
Method Detail
-
getProtocolReceiveBufferSize
int getProtocolReceiveBufferSize()
Deprecated.GetsOptionUDT.Protocol_Receive_Buffer_Size
-
getProtocolSendBufferSize
int getProtocolSendBufferSize()
Deprecated.GetsOptionUDT.Protocol_Send_Buffer_Size
-
getReceiveBufferSize
int getReceiveBufferSize()
Deprecated.Gets theChannelOption.SO_RCVBUF
option.
-
getSendBufferSize
int getSendBufferSize()
Deprecated.Gets theChannelOption.SO_SNDBUF
option.
-
getSoLinger
int getSoLinger()
Deprecated.Gets theChannelOption.SO_LINGER
option.
-
getSystemReceiveBufferSize
int getSystemReceiveBufferSize()
Deprecated.GetsOptionUDT.System_Receive_Buffer_Size
-
getSystemSendBufferSize
int getSystemSendBufferSize()
Deprecated.GetsOptionUDT.System_Send_Buffer_Size
-
isReuseAddress
boolean isReuseAddress()
Deprecated.Gets theChannelOption.SO_REUSEADDR
option.
-
setConnectTimeoutMillis
UdtChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
Deprecated.Description copied from interface:ChannelConfig
Sets the connect timeout of the channel in milliseconds. If theChannel
does not support connect operation, this property is not used at all, and therefore will be ignored.- Specified by:
setConnectTimeoutMillis
in interfaceChannelConfig
- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
setMaxMessagesPerRead
@Deprecated UdtChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
-
setWriteSpinCount
UdtChannelConfig setWriteSpinCount(int writeSpinCount)
Deprecated.Description copied from interface:ChannelConfig
Sets the maximum loop count for a write operation untilWritableByteChannel.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 is16
.- Specified by:
setWriteSpinCount
in interfaceChannelConfig
-
setAllocator
UdtChannelConfig setAllocator(ByteBufAllocator allocator)
Deprecated.Description copied from interface:ChannelConfig
Set theByteBufAllocator
which is used for the channel to allocate buffers.- Specified by:
setAllocator
in interfaceChannelConfig
-
setRecvByteBufAllocator
UdtChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Deprecated.Description copied from interface:ChannelConfig
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocator
in interfaceChannelConfig
-
setAutoRead
UdtChannelConfig setAutoRead(boolean autoRead)
Deprecated.Description copied from interface:ChannelConfig
Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all. The default value istrue
.- Specified by:
setAutoRead
in interfaceChannelConfig
-
setAutoClose
UdtChannelConfig setAutoClose(boolean autoClose)
Deprecated.Description copied from interface:ChannelConfig
Sets whether theChannel
should be closed automatically and immediately on write failure. The default istrue
.- Specified by:
setAutoClose
in interfaceChannelConfig
-
setWriteBufferHighWaterMark
UdtChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Deprecated.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 returnfalse
.- Specified by:
setWriteBufferHighWaterMark
in interfaceChannelConfig
-
setWriteBufferLowWaterMark
UdtChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Deprecated.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 returntrue
again.- Specified by:
setWriteBufferLowWaterMark
in interfaceChannelConfig
-
setWriteBufferWaterMark
UdtChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Deprecated.Description copied from interface:ChannelConfig
Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.- Specified by:
setWriteBufferWaterMark
in interfaceChannelConfig
-
setMessageSizeEstimator
UdtChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
Deprecated.Description copied from interface:ChannelConfig
Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.- Specified by:
setMessageSizeEstimator
in interfaceChannelConfig
-
setProtocolReceiveBufferSize
UdtChannelConfig setProtocolReceiveBufferSize(int size)
Deprecated.SetsOptionUDT.Protocol_Receive_Buffer_Size
-
setProtocolSendBufferSize
UdtChannelConfig setProtocolSendBufferSize(int size)
Deprecated.SetsOptionUDT.Protocol_Send_Buffer_Size
-
setReceiveBufferSize
UdtChannelConfig setReceiveBufferSize(int receiveBufferSize)
Deprecated.Sets theChannelOption.SO_RCVBUF
option.
-
setReuseAddress
UdtChannelConfig setReuseAddress(boolean reuseAddress)
Deprecated.Sets theChannelOption.SO_REUSEADDR
option.
-
setSendBufferSize
UdtChannelConfig setSendBufferSize(int sendBufferSize)
Deprecated.Sets theChannelOption.SO_SNDBUF
option.
-
setSoLinger
UdtChannelConfig setSoLinger(int soLinger)
Deprecated.Sets theChannelOption.SO_LINGER
option.
-
setSystemReceiveBufferSize
UdtChannelConfig setSystemReceiveBufferSize(int size)
Deprecated.SetsOptionUDT.System_Receive_Buffer_Size
-
setSystemSendBufferSize
UdtChannelConfig setSystemSendBufferSize(int size)
Deprecated.SetsOptionUDT.System_Send_Buffer_Size
-
-