Package io.github.mahmoudimus.quic.connection

Record Class StreamMeta

java.lang.Object
java.lang.Record
io.github.mahmoudimus.quic.connection.StreamMeta
Record Components:
id - the stream
start - the first stream offset carried
end - one past the last stream offset carried
fin - whether the frame carried the FIN bit
public record StreamMeta(StreamId id, long start, long end, boolean fin) extends Record
What a sent STREAM frame carried, without its data, which stays in the stream's SendBuffer: kept with the sent packet to acknowledge or retransmit the range.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    SIZE_BOUND
    The largest STREAM frame header: type, stream ID, offset and length.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StreamMeta(StreamId id, long start, long end, boolean fin)
    Creates an instance of a StreamMeta record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    encodeHeader(boolean length, ByteBuffer out)
    Writes the STREAM frame header (RFC 9000 section 19.8); the data follows.
    long
    end()
    Returns the value of the end record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    fin()
    Returns the value of the fin record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    StreamId
    id()
    Returns the value of the id record component.
    long
    start()
    Returns the value of the start 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

    • SIZE_BOUND

      public static final int SIZE_BOUND
      The largest STREAM frame header: type, stream ID, offset and length.
      See Also:

  • Constructor Details

    • StreamMeta

      public StreamMeta(StreamId id, long start, long end, boolean fin)
      Creates an instance of a StreamMeta record class.
      Parameters:
      id - the value for the id record component
      start - the value for the start record component
      end - the value for the end record component
      fin - the value for the fin record component

  • Method Details

    • encodeHeader

      public void encodeHeader(boolean length, ByteBuffer out)
      Writes the STREAM frame header (RFC 9000 section 19.8); the data follows.
      Parameters:
      length - whether to include the Length field
      out - the buffer, written at its position

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • id

      public StreamId id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • start

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

    • end

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

    • fin

      public boolean fin()
      Returns the value of the fin record component.
      Returns:
      the value of the fin record component