Class OptionUDT<T>

java.lang.Object
com.barchart.udt.OptionUDT<T>

public class OptionUDT<T> extends Object
The Enum OptionUDT.

provide 2 names: 1) UDT original and 2) human-readble

keep code values in sync with udt.h - UDT::UDTOpt; enum starts with index 0

See Also:
  • udt options
     UDT_MSS, // the Maximum Transfer Unit
     UDT_SNDSYN, // if sending is blocking
     UDT_RCVSYN, // if receiving is blocking
     UDT_CC, // custom congestion control algorithm
     UDT_FC, // Flight flag size (window size)
     UDT_SNDBUF, // maximum buffer in sending queue
     UDT_RCVBUF, // UDT receiving buffer size
     UDT_LINGER, // waiting for unsent data when closing
     UDP_SNDBUF, // UDP sending buffer size
     UDP_RCVBUF, // UDP receiving buffer size
     UDT_MAXMSG, // maximum datagram message size
     UDT_MSGTTL, // time-to-live of a datagram message
     UDT_RENDEZVOUS, // rendezvous connection mode
     UDT_SNDTIMEO, // send() timeout
     UDT_RCVTIMEO, // recv() timeout
     UDT_REUSEADDR, // reuse an existing port or create a new one
     UDT_MAXBW, // maximum bandwidth (bytes per second) that the connection can  use
     UDT_STATE, // current socket state, see UDTSTATUS, read only
     UDT_EVENT, // current avalable events associated with the socket
     UDT_SNDDATA, // size of data in the sending buffer
     UDT_RCVDATA // size of data available for recv
     
  • Field Details

    • UDT_MSS

      public static final OptionUDT<Integer> UDT_MSS
      the Maximum Transfer Unit.
    • Maximum_Transfer_Unit

      public static final OptionUDT<Integer> Maximum_Transfer_Unit
      the Maximum Transfer Unit., bytes
    • UDT_SNDSYN

      public static final OptionUDT<Boolean> UDT_SNDSYN
      if sending is blocking.
    • Is_Send_Synchronous

      public static final OptionUDT<Boolean> Is_Send_Synchronous
      if sending is blocking., true/false
    • UDT_RCVSYN

      public static final OptionUDT<Boolean> UDT_RCVSYN
      if receiving is blocking.
    • Is_Receive_Synchronous

      public static final OptionUDT<Boolean> Is_Receive_Synchronous
      if receiving is blocking, true/false
    • UDT_CC

      public static final OptionUDT<FactoryUDT> UDT_CC
      custom congestion control algorithm
    • Custom_Congestion_Control

      public static final OptionUDT<FactoryUDT> Custom_Congestion_Control
      custom congestion control algorithm, class factory
    • UDT_FC

      public static final OptionUDT<Integer> UDT_FC
      Flight flag size (window size).
    • Flight_Window_Size

      public static final OptionUDT<Integer> Flight_Window_Size
      Flight flag size (window size), bytes
    • UDT_SNDBUF

      public static final OptionUDT<Integer> UDT_SNDBUF
      maximum buffer in sending queue.
    • Protocol_Send_Buffer_Size

      public static final OptionUDT<Integer> Protocol_Send_Buffer_Size
      maximum buffer in sending queue.
    • UDT_RCVBUF

      public static final OptionUDT<Integer> UDT_RCVBUF
      UDT receiving buffer size.
    • Protocol_Receive_Buffer_Size

      public static final OptionUDT<Integer> Protocol_Receive_Buffer_Size
      UDT receiving buffer size limit, bytes
    • UDT_LINGER

      public static final OptionUDT<LingerUDT> UDT_LINGER
      waiting for unsent data when closing.
    • Time_To_Linger_On_Close

      public static final OptionUDT<LingerUDT> Time_To_Linger_On_Close
      waiting for unsent data when closing. true/false and timeout, seconds
    • UDP_SNDBUF

      public static final OptionUDT<Integer> UDP_SNDBUF
      UDP sending buffer size.
    • System_Send_Buffer_Size

      public static final OptionUDT<Integer> System_Send_Buffer_Size
      UDP sending buffer size limit, bytes
    • UDP_RCVBUF

      public static final OptionUDT<Integer> UDP_RCVBUF
      UDP receiving buffer size.
    • System_Receive_Buffer_Size

      public static final OptionUDT<Integer> System_Receive_Buffer_Size
      UDP receiving buffer size limit, bytes
    • UDT_RENDEZVOUS

      public static final OptionUDT<Boolean> UDT_RENDEZVOUS
      rendezvous connection mode.
    • Is_Randezvous_Connect_Enabled

      public static final OptionUDT<Boolean> Is_Randezvous_Connect_Enabled
      rendezvous connection mode, enabled/disabled
    • UDT_SNDTIMEO

      public static final OptionUDT<Integer> UDT_SNDTIMEO
      send() timeout.
    • Send_Timeout

      public static final OptionUDT<Integer> Send_Timeout
      send() timeout. milliseconds
    • UDT_RCVTIMEO

      public static final OptionUDT<Integer> UDT_RCVTIMEO
      recv() timeout.
    • Receive_Timeout

      public static final OptionUDT<Integer> Receive_Timeout
      recv() timeout. milliseconds
    • UDT_REUSEADDR

      public static final OptionUDT<Boolean> UDT_REUSEADDR
      reuse an existing port or create a one.
    • Is_Address_Reuse_Enabled

      public static final OptionUDT<Boolean> Is_Address_Reuse_Enabled
      reuse an existing port or create a one. true/false
    • UDT_MAXBW

      public static final OptionUDT<Long> UDT_MAXBW
      maximum bandwidth (bytes per second) that the connection can use.
    • Maximum_Bandwidth

      public static final OptionUDT<Long> Maximum_Bandwidth
      maximum bandwidth (bytes per second) that the connection can use.
    • UDT_STATE

      public static final OptionUDT<Integer> UDT_STATE
      current socket state, see UDTSTATUS, read only
    • Status_Code

      public static final OptionUDT<Integer> Status_Code
      current socket status code, see StatusUDT.getCode(), read only
    • UDT_EVENT

      public static final OptionUDT<Integer> UDT_EVENT
      current available events associated with the socket
    • Epoll_Event_Mask

      public static final OptionUDT<Integer> Epoll_Event_Mask
      current available epoll events, see EpollUDT.Opt.code
    • UDT_SNDDATA

      public static final OptionUDT<Integer> UDT_SNDDATA
      size of data in the sending buffer
    • Send_Buffer_Consumed

      public static final OptionUDT<Integer> Send_Buffer_Consumed
      current consumed sending buffer utilization, read only, bytes
    • UDT_RCVDATA

      public static final OptionUDT<Integer> UDT_RCVDATA
      size of data available for recv
    • Receive_Buffer_Available

      public static final OptionUDT<Integer> Receive_Buffer_Available
      current available receiving buffer capacity, read only, bytes
    • log

      protected static final org.slf4j.Logger log
    • values

      protected static final List<OptionUDT<?>> values
    • code

      private final int code
    • type

      private final Class<?> type
    • format

      private final OptionUDT.Format format
    • name

      private String name
  • Constructor Details

  • Method Details