Package io.github.mahmoudimus.quic.frame

Record Class Frame.Datagram

java.lang.Object
java.lang.Record
io.github.mahmoudimus.quic.frame.Frame.Datagram
Record Components:
data - the unreliable datagram payload
All Implemented Interfaces:
Frame
Enclosing interface:
Frame
public static record Frame.Datagram(ByteBuffer data) extends Record implements Frame
A DATAGRAM frame (RFC 9221; 0x30 without and 0x31 with a Length field). encode(ByteBuffer) writes the Length field.

  • Constructor Details

    • Datagram

      public Datagram(ByteBuffer data)
      A DATAGRAM frame.
      Parameters:
      data - the payload between its position and limit

  • Method Details

    • data

      public ByteBuffer data()
      The payload.
      Returns:
      an independent view of the payload

    • encodedLength

      public int encodedLength(boolean withLength)
      The encoded length with or without the Length field.
      Parameters:
      withLength - whether to count the Length field
      Returns:
      the frame length in bytes

    • encode

      public void encode(ByteBuffer out, boolean withLength)
      Writes the frame, with the Length field or, when it ends the packet, without.
      Parameters:
      out - the buffer, written at its position
      withLength - whether to write the Length field (type 0x31)
      Throws:
      BufferOverflowException - if the frame does not fit; nothing is written then

    • type

      public FrameType type()
      Description copied from interface: Frame
      The frame type.
      Specified by:
      type in interface Frame
      Returns:
      the type

    • typeCode

      public long typeCode()
      Description copied from interface: Frame
      The exact type code this frame encodes with, flags included.
      Specified by:
      typeCode in interface Frame
      Returns:
      the type code

    • encodedLength

      public int encodedLength()
      Description copied from interface: Frame
      The encoded length.
      Specified by:
      encodedLength in interface Frame
      Returns:
      the bytes Frame.encode(java.nio.ByteBuffer) writes

    • encode

      public void encode(ByteBuffer out)
      Description copied from interface: Frame
      Writes the frame at the buffer's position.
      Specified by:
      encode in interface Frame
      Parameters:
      out - the buffer

    • 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 Objects::equals(Object,Object).
      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.