Package io.netty.channel.socket
Interface DatagramChannelConfig
- All Superinterfaces:
ChannelConfig
- All Known Subinterfaces:
OioDatagramChannelConfig
- All Known Implementing Classes:
DefaultDatagramChannelConfig
,DefaultOioDatagramChannelConfig
,EpollDatagramChannelConfig
,KQueueDatagramChannelConfig
,NioDatagramChannelConfig
A
ChannelConfig
for a DatagramChannel
.
Available options
In addition to the options provided byChannelConfig
,
DatagramChannelConfig
allows the following options in the option map:
-
Method Summary
Modifier and TypeMethodDescriptionGets the address of the network interface used for multicast packets.Gets theStandardSocketOptions.IP_MULTICAST_IF
option.int
Gets theStandardSocketOptions.SO_RCVBUF
option.int
Gets theStandardSocketOptions.SO_SNDBUF
option.int
Gets theStandardSocketOptions.IP_MULTICAST_TTL
option.int
Gets theStandardSocketOptions.IP_TOS
option.boolean
Gets theStandardSocketOptions.SO_BROADCAST
option.boolean
Gets theStandardSocketOptions.IP_MULTICAST_LOOP
option.boolean
Gets theStandardSocketOptions.SO_REUSEADDR
option.setAllocator
(ByteBufAllocator allocator) Set theByteBufAllocator
which is used for the channel to allocate buffers.setAutoClose
(boolean autoClose) Sets whether theChannel
should be closed automatically and immediately on write failure.setAutoRead
(boolean autoRead) Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all.setBroadcast
(boolean broadcast) Sets theStandardSocketOptions.SO_BROADCAST
option.setConnectTimeoutMillis
(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.setInterface
(InetAddress interfaceAddress) Sets the address of the network interface used for multicast packets.setLoopbackModeDisabled
(boolean loopbackModeDisabled) Sets theStandardSocketOptions.IP_MULTICAST_LOOP
option.setMaxMessagesPerRead
(int maxMessagesPerRead) Deprecated.setMessageSizeEstimator
(MessageSizeEstimator estimator) Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.setNetworkInterface
(NetworkInterface networkInterface) Sets theStandardSocketOptions.IP_MULTICAST_IF
option.setReceiveBufferSize
(int receiveBufferSize) Sets theStandardSocketOptions.SO_RCVBUF
option.setRecvByteBufAllocator
(RecvByteBufAllocator allocator) Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.setReuseAddress
(boolean reuseAddress) Gets theStandardSocketOptions.SO_REUSEADDR
option.setSendBufferSize
(int sendBufferSize) Sets theStandardSocketOptions.SO_SNDBUF
option.setTimeToLive
(int ttl) Sets theStandardSocketOptions.IP_MULTICAST_TTL
option.setTrafficClass
(int trafficClass) Sets theStandardSocketOptions.IP_TOS
option.setWriteBufferWaterMark
(WriteBufferWaterMark writeBufferWaterMark) Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.setWriteSpinCount
(int writeSpinCount) 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, setWriteBufferHighWaterMark, setWriteBufferLowWaterMark
-
Method Details
-
getSendBufferSize
int getSendBufferSize()Gets theStandardSocketOptions.SO_SNDBUF
option. -
setSendBufferSize
Sets theStandardSocketOptions.SO_SNDBUF
option. -
getReceiveBufferSize
int getReceiveBufferSize()Gets theStandardSocketOptions.SO_RCVBUF
option. -
setReceiveBufferSize
Sets theStandardSocketOptions.SO_RCVBUF
option. -
getTrafficClass
int getTrafficClass()Gets theStandardSocketOptions.IP_TOS
option. -
setTrafficClass
Sets theStandardSocketOptions.IP_TOS
option. -
isReuseAddress
boolean isReuseAddress()Gets theStandardSocketOptions.SO_REUSEADDR
option. -
setReuseAddress
Gets theStandardSocketOptions.SO_REUSEADDR
option. -
isBroadcast
boolean isBroadcast()Gets theStandardSocketOptions.SO_BROADCAST
option. -
setBroadcast
Sets theStandardSocketOptions.SO_BROADCAST
option. -
isLoopbackModeDisabled
boolean isLoopbackModeDisabled()Gets theStandardSocketOptions.IP_MULTICAST_LOOP
option.- Returns:
true
if and only if the loopback mode has been disabled
-
setLoopbackModeDisabled
Sets theStandardSocketOptions.IP_MULTICAST_LOOP
option.- Parameters:
loopbackModeDisabled
-true
if and only if the loopback mode has been disabled
-
getTimeToLive
int getTimeToLive()Gets theStandardSocketOptions.IP_MULTICAST_TTL
option. -
setTimeToLive
Sets theStandardSocketOptions.IP_MULTICAST_TTL
option. -
getInterface
InetAddress getInterface()Gets the address of the network interface used for multicast packets. -
setInterface
Sets the address of the network interface used for multicast packets. -
getNetworkInterface
NetworkInterface getNetworkInterface()Gets theStandardSocketOptions.IP_MULTICAST_IF
option. -
setNetworkInterface
Sets theStandardSocketOptions.IP_MULTICAST_IF
option. -
setMaxMessagesPerRead
Deprecated.- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
-
setWriteSpinCount
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
-
setConnectTimeoutMillis
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.
-
setAllocator
Description copied from interface:ChannelConfig
Set theByteBufAllocator
which is used for the channel to allocate buffers.- Specified by:
setAllocator
in interfaceChannelConfig
-
setRecvByteBufAllocator
Description copied from interface:ChannelConfig
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocator
in interfaceChannelConfig
-
setAutoRead
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
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
-
setMessageSizeEstimator
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
-
setWriteBufferWaterMark
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
-