Package io.github.mahmoudimus.http2

Record Class Frame.Headers

java.lang.Object
java.lang.Record
io.github.mahmoudimus.http2.Frame.Headers
Record Components:
streamId - the nonzero stream identifier
fieldBlock - the HPACK-encoded field block bytes, retained without copying
endStream - whether this frame ends the stream
endHeaders - whether this fragment completes the field block
priority - the deprecated priority signal, or null when absent
padding - padding octets including the Pad Length octet, or 0 for no padding
All Implemented Interfaces:
Frame
Enclosing interface:
Frame
public static record Frame.Headers(int streamId, byte[] fieldBlock, boolean endStream, boolean endHeaders, Frame.PrioritySpec priority, int padding) extends Record implements Frame
HEADERS (§6.2). Frames returned by FrameReader always carry the complete field block, already joined with its CONTINUATION frames, so endHeaders is true. The (deprecated) priority signal is parsed into priority, which is null when absent; it has no other effect.

  • Constructor Details

    • Headers

      public Headers(int streamId, byte[] fieldBlock, boolean endStream, boolean endHeaders, Frame.PrioritySpec priority, int padding)
      Creates HEADERS with a nonzero stream and valid padding.
      Parameters:
      streamId - the nonzero stream identifier
      fieldBlock - the HPACK-encoded field block bytes, retained without copying
      endStream - whether this frame ends the stream
      endHeaders - whether this fragment completes the field block
      priority - the deprecated priority signal, or null when absent
      padding - padding octets including the Pad Length octet, or 0 for no padding

    • Headers

      public Headers(int streamId, byte[] fieldBlock, boolean endStream)
      A complete, unpadded field block without priority.
      Parameters:
      streamId - the nonzero stream identifier
      fieldBlock - the HPACK-encoded field block bytes, retained without copying
      endStream - whether this frame ends the stream

  • Method Details

    • type

      public int type()
      Description copied from interface: Frame
      The frame type code, one of the FrameType constants (or any value for Frame.Unknown).
      Specified by:
      type in interface Frame
      Returns:
      the unsigned frame type code

    • 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 int streamId()
      Returns the value of the streamId record component.
      Specified by:
      streamId in interface Frame
      Returns:
      the value of the streamId record component

    • fieldBlock

      public byte[] fieldBlock()
      Returns the value of the fieldBlock record component.
      Returns:
      the value of the fieldBlock record component

    • endStream

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

    • endHeaders

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

    • priority

      public Frame.PrioritySpec priority()
      Returns the value of the priority record component.
      Returns:
      the value of the priority record component

    • padding

      public int padding()
      Returns the value of the padding record component.
      Returns:
      the value of the padding record component