Package io.netty.channel.socket.oio
Class DefaultOioDatagramChannelConfig
java.lang.Object
io.netty.channel.DefaultChannelConfig
io.netty.channel.socket.DefaultDatagramChannelConfig
io.netty.channel.socket.oio.DefaultOioDatagramChannelConfig
- All Implemented Interfaces:
ChannelConfig
,DatagramChannelConfig
,OioDatagramChannelConfig
final class DefaultOioDatagramChannelConfig
extends DefaultDatagramChannelConfig
implements OioDatagramChannelConfig
-
Field Summary
Fields inherited from class io.netty.channel.DefaultChannelConfig
channel
-
Constructor Summary
ConstructorsConstructorDescriptionDefaultOioDatagramChannelConfig
(DatagramChannel channel, DatagramSocket javaSocket) -
Method Summary
Modifier and TypeMethodDescription<T> T
getOption
(ChannelOption<T> option) Return the value of the givenChannelOption
Map
<ChannelOption<?>, Object> Return all setChannelOption
's.int
Returns the maximal time a operation on the underlying socket may block.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) 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.<T> boolean
setOption
(ChannelOption<T> option, T value) Sets a configuration property with the specified name and value.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.setSoTimeout
(int timeout) Sets the maximal time a operation on the underlying socket may block.setTimeToLive
(int ttl) Sets theStandardSocketOptions.IP_MULTICAST_TTL
option.setTrafficClass
(int trafficClass) Sets theStandardSocketOptions.IP_TOS
option.setWriteBufferHighWaterMark
(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.setWriteBufferLowWaterMark
(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.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 class io.netty.channel.socket.DefaultDatagramChannelConfig
getInterface, getNetworkInterface, getReceiveBufferSize, getSendBufferSize, getTimeToLive, getTrafficClass, isBroadcast, isLoopbackModeDisabled, isReuseAddress, javaSocket, setMaxMessagesPerWrite
Methods inherited from class io.netty.channel.DefaultChannelConfig
autoReadCleared, getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions, validate
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions
Methods inherited from interface io.netty.channel.socket.DatagramChannelConfig
getInterface, getNetworkInterface, getReceiveBufferSize, getSendBufferSize, getTimeToLive, getTrafficClass, isBroadcast, isLoopbackModeDisabled, isReuseAddress
-
Constructor Details
-
DefaultOioDatagramChannelConfig
DefaultOioDatagramChannelConfig(DatagramChannel channel, DatagramSocket javaSocket)
-
-
Method Details
-
getOptions
Description copied from interface:ChannelConfig
Return all setChannelOption
's.- Specified by:
getOptions
in interfaceChannelConfig
- Overrides:
getOptions
in classDefaultDatagramChannelConfig
-
getOption
Description copied from interface:ChannelConfig
Return the value of the givenChannelOption
- Specified by:
getOption
in interfaceChannelConfig
- Overrides:
getOption
in classDefaultDatagramChannelConfig
-
setOption
Description copied from interface:ChannelConfig
Sets a configuration property with the specified name and value. To override this method properly, you must call the super class:public boolean setOption(ChannelOption<T> option, T value) { if (super.setOption(option, value)) { return true; } if (option.equals(additionalOption)) { .... return true; } return false; }
- Specified by:
setOption
in interfaceChannelConfig
- Overrides:
setOption
in classDefaultDatagramChannelConfig
- Returns:
true
if and only if the property has been set
-
setSoTimeout
Description copied from interface:OioDatagramChannelConfig
Sets the maximal time a operation on the underlying socket may block.- Specified by:
setSoTimeout
in interfaceOioDatagramChannelConfig
-
getSoTimeout
public int getSoTimeout()Description copied from interface:OioDatagramChannelConfig
Returns the maximal time a operation on the underlying socket may block.- Specified by:
getSoTimeout
in interfaceOioDatagramChannelConfig
-
setBroadcast
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.SO_BROADCAST
option.- Specified by:
setBroadcast
in interfaceDatagramChannelConfig
- Specified by:
setBroadcast
in interfaceOioDatagramChannelConfig
- Overrides:
setBroadcast
in classDefaultDatagramChannelConfig
-
setInterface
Description copied from interface:DatagramChannelConfig
Sets the address of the network interface used for multicast packets.- Specified by:
setInterface
in interfaceDatagramChannelConfig
- Specified by:
setInterface
in interfaceOioDatagramChannelConfig
- Overrides:
setInterface
in classDefaultDatagramChannelConfig
-
setLoopbackModeDisabled
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.IP_MULTICAST_LOOP
option.- Specified by:
setLoopbackModeDisabled
in interfaceDatagramChannelConfig
- Specified by:
setLoopbackModeDisabled
in interfaceOioDatagramChannelConfig
- Overrides:
setLoopbackModeDisabled
in classDefaultDatagramChannelConfig
- Parameters:
loopbackModeDisabled
-true
if and only if the loopback mode has been disabled
-
setNetworkInterface
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.IP_MULTICAST_IF
option.- Specified by:
setNetworkInterface
in interfaceDatagramChannelConfig
- Specified by:
setNetworkInterface
in interfaceOioDatagramChannelConfig
- Overrides:
setNetworkInterface
in classDefaultDatagramChannelConfig
-
setReuseAddress
Description copied from interface:DatagramChannelConfig
Gets theStandardSocketOptions.SO_REUSEADDR
option.- Specified by:
setReuseAddress
in interfaceDatagramChannelConfig
- Specified by:
setReuseAddress
in interfaceOioDatagramChannelConfig
- Overrides:
setReuseAddress
in classDefaultDatagramChannelConfig
-
setReceiveBufferSize
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.SO_RCVBUF
option.- Specified by:
setReceiveBufferSize
in interfaceDatagramChannelConfig
- Specified by:
setReceiveBufferSize
in interfaceOioDatagramChannelConfig
- Overrides:
setReceiveBufferSize
in classDefaultDatagramChannelConfig
-
setSendBufferSize
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.SO_SNDBUF
option.- Specified by:
setSendBufferSize
in interfaceDatagramChannelConfig
- Specified by:
setSendBufferSize
in interfaceOioDatagramChannelConfig
- Overrides:
setSendBufferSize
in classDefaultDatagramChannelConfig
-
setTimeToLive
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.IP_MULTICAST_TTL
option.- Specified by:
setTimeToLive
in interfaceDatagramChannelConfig
- Specified by:
setTimeToLive
in interfaceOioDatagramChannelConfig
- Overrides:
setTimeToLive
in classDefaultDatagramChannelConfig
-
setTrafficClass
Description copied from interface:DatagramChannelConfig
Sets theStandardSocketOptions.IP_TOS
option.- Specified by:
setTrafficClass
in interfaceDatagramChannelConfig
- Specified by:
setTrafficClass
in interfaceOioDatagramChannelConfig
- Overrides:
setTrafficClass
in classDefaultDatagramChannelConfig
-
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
- Specified by:
setWriteSpinCount
in interfaceDatagramChannelConfig
- Specified by:
setWriteSpinCount
in interfaceOioDatagramChannelConfig
- Overrides:
setWriteSpinCount
in classDefaultDatagramChannelConfig
-
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
- Specified by:
setConnectTimeoutMillis
in interfaceDatagramChannelConfig
- Specified by:
setConnectTimeoutMillis
in interfaceOioDatagramChannelConfig
- Overrides:
setConnectTimeoutMillis
in classDefaultDatagramChannelConfig
- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
setMaxMessagesPerRead
Description copied from class:DefaultChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceDatagramChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceOioDatagramChannelConfig
- Overrides:
setMaxMessagesPerRead
in classDefaultDatagramChannelConfig
-
setAllocator
Description copied from interface:ChannelConfig
Set theByteBufAllocator
which is used for the channel to allocate buffers.- Specified by:
setAllocator
in interfaceChannelConfig
- Specified by:
setAllocator
in interfaceDatagramChannelConfig
- Specified by:
setAllocator
in interfaceOioDatagramChannelConfig
- Overrides:
setAllocator
in classDefaultDatagramChannelConfig
-
setRecvByteBufAllocator
Description copied from interface:ChannelConfig
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocator
in interfaceChannelConfig
- Specified by:
setRecvByteBufAllocator
in interfaceDatagramChannelConfig
- Specified by:
setRecvByteBufAllocator
in interfaceOioDatagramChannelConfig
- Overrides:
setRecvByteBufAllocator
in classDefaultDatagramChannelConfig
-
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
- Specified by:
setAutoRead
in interfaceDatagramChannelConfig
- Specified by:
setAutoRead
in interfaceOioDatagramChannelConfig
- Overrides:
setAutoRead
in classDefaultDatagramChannelConfig
-
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
- Specified by:
setAutoClose
in interfaceDatagramChannelConfig
- Specified by:
setAutoClose
in interfaceOioDatagramChannelConfig
- Overrides:
setAutoClose
in classDefaultDatagramChannelConfig
-
setWriteBufferHighWaterMark
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
- Specified by:
setWriteBufferHighWaterMark
in interfaceOioDatagramChannelConfig
- Overrides:
setWriteBufferHighWaterMark
in classDefaultDatagramChannelConfig
-
setWriteBufferLowWaterMark
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
- Specified by:
setWriteBufferLowWaterMark
in interfaceOioDatagramChannelConfig
- Overrides:
setWriteBufferLowWaterMark
in classDefaultDatagramChannelConfig
-
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
- Specified by:
setWriteBufferWaterMark
in interfaceDatagramChannelConfig
- Specified by:
setWriteBufferWaterMark
in interfaceOioDatagramChannelConfig
- Overrides:
setWriteBufferWaterMark
in classDefaultDatagramChannelConfig
-
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
- Specified by:
setMessageSizeEstimator
in interfaceDatagramChannelConfig
- Specified by:
setMessageSizeEstimator
in interfaceOioDatagramChannelConfig
- Overrides:
setMessageSizeEstimator
in classDefaultDatagramChannelConfig
-