Package io.github.mahmoudimus.quic.frame

Record Class Frame.Stream

java.lang.Object
java.lang.Record
io.github.mahmoudimus.quic.frame.Frame.Stream
Record Components:
streamId - the stream ID
offset - the offset of the data in the stream
data - the data
fin - whether the data ends the stream
All Implemented Interfaces:
Frame
Enclosing interface:
Frame
public static record Frame.Stream(long streamId, long offset, ByteBuffer data, boolean fin) extends Record implements Frame
A STREAM frame (types 0x08 to 0x0f). encode(ByteBuffer) always writes the Length field, and the Offset field when the offset is not zero.

  • Constructor Details

    • Stream

      public Stream(long streamId, long offset, ByteBuffer data, boolean fin)
      A STREAM frame.
      Parameters:
      streamId - the stream ID
      offset - the stream offset
      data - the data between its position and limit
      fin - whether the data ends the stream

  • Method Details

    • data

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

    • encode

      public static int encode(ByteBuffer out, long streamId, long offset, ByteBuffer data, boolean fin, int budget)
      Writes as much stream data as fits a byte budget in one STREAM frame, as quinn's write_stream_frames does. When all the data fits with a Length field the frame has one; otherwise the frame omits it, fills the whole budget and must be the last frame in the packet, so pass the packet's remaining space as the budget. FIN is set only if all the data is written.
      Parameters:
      out - the buffer, written at its position
      streamId - the stream ID
      offset - the stream offset of the first byte
      data - the data to send; its position moves past the bytes written
      fin - whether the data ends the stream
      budget - the most bytes the frame may take (also bounded by out.remaining())
      Returns:
      the data bytes written (0 for a FIN-only or empty frame), or -1 if the frame did not fit and nothing was written

    • 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. 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.

    • streamId

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

    • offset

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

    • fin

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