Package io.github.mahmoudimus.quic.frame

Record Class Frame.Crypto

java.lang.Object
java.lang.Record
io.github.mahmoudimus.quic.frame.Frame.Crypto
Record Components:
offset - the offset of the data in the level's crypto stream
data - the data
All Implemented Interfaces:
Frame
Enclosing interface:
Frame
public static record Frame.Crypto(long offset, ByteBuffer data) extends Record implements Frame
A CRYPTO frame (type 0x06), carrying TLS handshake bytes.

  • Constructor Details

    • Crypto

      public Crypto(long offset, ByteBuffer data)
      A CRYPTO frame.
      Parameters:
      offset - the stream offset
      data - the data between its position and limit

  • Method Details

    • data

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

    • encode

      public static int encode(ByteBuffer out, long offset, ByteBuffer data, int budget)
      Writes as much of the data as fits a byte budget in one CRYPTO frame, with an exact Length field, as quinn fills packets with handshake data.
      Parameters:
      out - the buffer, written at its position
      offset - the crypto stream offset of the first byte
      data - the data to send; its position moves past the bytes written
      budget - the most bytes the frame may take (also bounded by out.remaining())
      Returns:
      the data bytes written; 0 if data is empty, in which case nothing is written; -1 if not even one byte fits

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

    • offset

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