Interface DatagramChannelConfig

All Superinterfaces:
ChannelConfig
All Known Subinterfaces:
OioDatagramChannelConfig
All Known Implementing Classes:
DefaultDatagramChannelConfig, DefaultOioDatagramChannelConfig, EpollDatagramChannelConfig, IoUringDatagramChannelConfig, KQueueDatagramChannelConfig, NioDatagramChannelConfig
public interface DatagramChannelConfig extends ChannelConfig
A ChannelConfig for a DatagramChannel.

Available options

In addition to the options provided by ChannelConfig, DatagramChannelConfig allows the following options in the option map:
NameAssociated setter method
ChannelOption.SO_BROADCASTsetBroadcast(boolean)
ChannelOption.IP_MULTICAST_ADDRsetInterface(InetAddress)
ChannelOption.IP_MULTICAST_LOOP_DISABLED setLoopbackModeDisabled(boolean)
ChannelOption.IP_MULTICAST_IF setNetworkInterface(NetworkInterface)
ChannelOption.SO_REUSEADDRsetReuseAddress(boolean)
ChannelOption.SO_RCVBUFsetReceiveBufferSize(int)
ChannelOption.SO_SNDBUFsetSendBufferSize(int)
ChannelOption.IP_MULTICAST_TTLsetTimeToLive(int)
ChannelOption.IP_TOSsetTrafficClass(int)

  • Method Details

    • getSendBufferSize

      int getSendBufferSize()
      Gets the StandardSocketOptions.SO_SNDBUF option.

    • setSendBufferSize

      DatagramChannelConfig setSendBufferSize(int sendBufferSize)
      Sets the StandardSocketOptions.SO_SNDBUF option.

    • getReceiveBufferSize

      int getReceiveBufferSize()
      Gets the StandardSocketOptions.SO_RCVBUF option.

    • setReceiveBufferSize

      DatagramChannelConfig setReceiveBufferSize(int receiveBufferSize)
      Sets the StandardSocketOptions.SO_RCVBUF option.

    • getTrafficClass

      int getTrafficClass()
      Gets the StandardSocketOptions.IP_TOS option.

    • setTrafficClass

      DatagramChannelConfig setTrafficClass(int trafficClass)
      Sets the StandardSocketOptions.IP_TOS option.

    • isReuseAddress

      boolean isReuseAddress()
      Gets the StandardSocketOptions.SO_REUSEADDR option.

    • setReuseAddress

      DatagramChannelConfig setReuseAddress(boolean reuseAddress)
      Gets the StandardSocketOptions.SO_REUSEADDR option.

    • isBroadcast

      boolean isBroadcast()
      Gets the StandardSocketOptions.SO_BROADCAST option.

    • setBroadcast

      DatagramChannelConfig setBroadcast(boolean broadcast)
      Sets the StandardSocketOptions.SO_BROADCAST option.

    • isLoopbackModeDisabled

      boolean isLoopbackModeDisabled()
      Gets the StandardSocketOptions.IP_MULTICAST_LOOP option.
      Returns:
      true if and only if the loopback mode has been disabled

    • setLoopbackModeDisabled

      DatagramChannelConfig setLoopbackModeDisabled(boolean loopbackModeDisabled)
      Sets the StandardSocketOptions.IP_MULTICAST_LOOP option.
      Parameters:
      loopbackModeDisabled - true if and only if the loopback mode has been disabled

    • getTimeToLive

      int getTimeToLive()
      Gets the StandardSocketOptions.IP_MULTICAST_TTL option.

    • setTimeToLive

      DatagramChannelConfig setTimeToLive(int ttl)
      Sets the StandardSocketOptions.IP_MULTICAST_TTL option.

    • getInterface

      java.net.InetAddress getInterface()
      Gets the address of the network interface used for multicast packets.

    • setInterface

      DatagramChannelConfig setInterface(java.net.InetAddress interfaceAddress)
      Sets the address of the network interface used for multicast packets.

    • getNetworkInterface

      java.net.NetworkInterface getNetworkInterface()
      Gets the StandardSocketOptions.IP_MULTICAST_IF option.

    • setNetworkInterface

      DatagramChannelConfig setNetworkInterface(java.net.NetworkInterface networkInterface)
      Sets the StandardSocketOptions.IP_MULTICAST_IF option.

    • setMaxMessagesPerRead

      @Deprecated DatagramChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
      Deprecated.
      Specified by:
      setMaxMessagesPerRead in interface ChannelConfig

    • setWriteSpinCount

      DatagramChannelConfig 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

    • setConnectTimeoutMillis

      DatagramChannelConfig 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
      Parameters:
      connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.

    • setAllocator

      DatagramChannelConfig 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

    • setRecvByteBufAllocator

      DatagramChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
      Description copied from interface: ChannelConfig
      Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
      Specified by:
      setRecvByteBufAllocator in interface ChannelConfig

    • setAutoRead

      DatagramChannelConfig 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

    • setAutoClose

      DatagramChannelConfig setAutoClose(boolean autoClose)
      Description copied from interface: ChannelConfig
      Sets whether the Channel should be closed automatically and immediately on write failure. The default is true.
      Specified by:
      setAutoClose in interface ChannelConfig

    • setMessageSizeEstimator

      DatagramChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
      Description copied from interface: ChannelConfig
      Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
      Specified by:
      setMessageSizeEstimator in interface ChannelConfig

    • setWriteBufferWaterMark

      DatagramChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
      Description copied from interface: ChannelConfig
      Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
      Specified by:
      setWriteBufferWaterMark in interface ChannelConfig