Package io.github.mahmoudimus.quic.congestion

Record Class CubicConfig

java.lang.Object
java.lang.Record
io.github.mahmoudimus.quic.congestion.CubicConfig
Record Components:
initialWindow - the initial congestion window in bytes; RFC 9002 recommends min(10 * max_datagram_size, max(2 * max_datagram_size, 14720))
All Implemented Interfaces:
ControllerFactory
public record CubicConfig(long initialWindow) extends Record implements ControllerFactory
Configuration of the Cubic controller.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final CubicConfig
    DEFAULT
    The default: a 12000-byte initial window.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CubicConfig(long initialWindow)
    A configuration.

  • Method Summary

    Modifier and Type
    Method
    Description
    Controller
    build(long now, int currentMtu)
    A new controller.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    initialWindow()
    Returns the value of the initialWindow record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • DEFAULT

      public static final CubicConfig DEFAULT
      The default: a 12000-byte initial window.

  • Constructor Details

    • CubicConfig

      public CubicConfig(long initialWindow)
      A configuration.
      Parameters:
      initialWindow - the initial window, positive

  • Method Details

    • build

      public Controller build(long now, int currentMtu)
      Description copied from interface: ControllerFactory
      A new controller.
      Specified by:
      build in interface ControllerFactory
      Parameters:
      now - the current time, in nanoseconds
      currentMtu - the path's current maximum UDP payload size
      Returns:
      the controller

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • initialWindow

      public long initialWindow()
      Returns the value of the initialWindow record component.
      Returns:
      the value of the initialWindow record component