Package io.netty.channel.socket
Interface DatagramChannelConfig
-
- All Superinterfaces:
ChannelConfig
- All Known Subinterfaces:
OioDatagramChannelConfig
- All Known Implementing Classes:
DefaultDatagramChannelConfig
,EpollDatagramChannelConfig
,KQueueDatagramChannelConfig
public interface DatagramChannelConfig extends ChannelConfig
AChannelConfig
for aDatagramChannel
.Available options
In addition to the options provided byChannelConfig
,DatagramChannelConfig
allows the following options in the option map:
-
-
Method Summary
-
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 Detail
-
getSendBufferSize
int getSendBufferSize()
Gets theStandardSocketOptions.SO_SNDBUF
option.
-
setSendBufferSize
DatagramChannelConfig setSendBufferSize(int sendBufferSize)
Sets theStandardSocketOptions.SO_SNDBUF
option.
-
getReceiveBufferSize
int getReceiveBufferSize()
Gets theStandardSocketOptions.SO_RCVBUF
option.
-
setReceiveBufferSize
DatagramChannelConfig setReceiveBufferSize(int receiveBufferSize)
Sets theStandardSocketOptions.SO_RCVBUF
option.
-
getTrafficClass
int getTrafficClass()
Gets theStandardSocketOptions.IP_TOS
option.
-
setTrafficClass
DatagramChannelConfig setTrafficClass(int trafficClass)
Sets theStandardSocketOptions.IP_TOS
option.
-
isReuseAddress
boolean isReuseAddress()
Gets theStandardSocketOptions.SO_REUSEADDR
option.
-
setReuseAddress
DatagramChannelConfig setReuseAddress(boolean reuseAddress)
Gets theStandardSocketOptions.SO_REUSEADDR
option.
-
isBroadcast
boolean isBroadcast()
Gets theStandardSocketOptions.SO_BROADCAST
option.
-
setBroadcast
DatagramChannelConfig setBroadcast(boolean broadcast)
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
DatagramChannelConfig setLoopbackModeDisabled(boolean loopbackModeDisabled)
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
DatagramChannelConfig setTimeToLive(int ttl)
Sets theStandardSocketOptions.IP_MULTICAST_TTL
option.
-
getInterface
InetAddress getInterface()
Gets the address of the network interface used for multicast packets.
-
setInterface
DatagramChannelConfig setInterface(InetAddress interfaceAddress)
Sets the address of the network interface used for multicast packets.
-
getNetworkInterface
NetworkInterface getNetworkInterface()
Gets theStandardSocketOptions.IP_MULTICAST_IF
option.
-
setNetworkInterface
DatagramChannelConfig setNetworkInterface(NetworkInterface networkInterface)
Sets theStandardSocketOptions.IP_MULTICAST_IF
option.
-
setMaxMessagesPerRead
@Deprecated DatagramChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
-
setWriteSpinCount
DatagramChannelConfig setWriteSpinCount(int writeSpinCount)
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
DatagramChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
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
DatagramChannelConfig setAllocator(ByteBufAllocator allocator)
Description copied from interface:ChannelConfig
Set theByteBufAllocator
which is used for the channel to allocate buffers.- Specified by:
setAllocator
in interfaceChannelConfig
-
setRecvByteBufAllocator
DatagramChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Description copied from interface:ChannelConfig
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocator
in interfaceChannelConfig
-
setAutoRead
DatagramChannelConfig setAutoRead(boolean autoRead)
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
DatagramChannelConfig setAutoClose(boolean autoClose)
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
DatagramChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
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
DatagramChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
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
-
-