Package io.github.mahmoudimus.http2

Record Class Frame.PushPromise

java.lang.Object

java.lang.Record

io.github.mahmoudimus.http2.Frame.PushPromise

Record Components:

streamId - the nonzero stream identifier

promisedStreamId - the nonzero identifier reserved for the promised stream

fieldBlock - the HPACK-encoded field block bytes, retained without copying

endHeaders - whether this fragment completes the field block

padding - padding octets including the Pad Length octet, or 0 for no padding

All Implemented Interfaces:

Frame

Enclosing interface:

Frame

public static record Frame.PushPromise(int streamId, int promisedStreamId, byte[] fieldBlock, boolean endHeaders, int padding)
extends Record
implements Frame

PUSH_PROMISE (§6.6), with its complete field block. A server never accepts one, and a client that sent SETTINGS_ENABLE_PUSH = 0 must treat one as a connection error of type PROTOCOL_ERROR (§8.4). The reader still returns it, with the field block (which must be decoded to keep HPACK state in step if the connection is to continue), and leaves the decision to the caller.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.mahmoudimus.http2.Frame

Frame.Continuation, Frame.Data, Frame.GoAway, Frame.Headers, Frame.Ping, Frame.Priority, Frame.PrioritySpec, Frame.PushPromise, Frame.RstStream, Frame.Settings, Frame.Unknown, Frame.WindowUpdate

Field Summary

Fields inherited from interface io.github.mahmoudimus.http2.Frame

MAX_STREAM_ID

Constructor Summary

Constructors

Constructor	Description
PushPromise(int streamId, int promisedStreamId, byte[] fieldBlock, boolean endHeaders, int padding)	Creates PUSH_PROMISE with nonzero stream identifiers and valid padding.

Method Summary

Modifier and Type	Method	Description
boolean	endHeaders()	Returns the value of the endHeaders record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
byte[]	fieldBlock()	Returns the value of the fieldBlock record component.
final int	hashCode()	Returns a hash code value for this object.
int	padding()	Returns the value of the padding record component.
int	promisedStreamId()	Returns the value of the promisedStreamId record component.
int	streamId()	Returns the value of the streamId record component.
final String	toString()	Returns a string representation of this record class.
int	type()	The frame type code, one of the FrameType constants (or any value for Frame.Unknown).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PushPromise

public PushPromise(int streamId,
 int promisedStreamId,
 byte[] fieldBlock,
 boolean endHeaders,
 int padding)

Creates PUSH_PROMISE with nonzero stream identifiers and valid padding.

Parameters:

streamId - the nonzero stream identifier

promisedStreamId - the nonzero identifier reserved for the promised stream

fieldBlock - the HPACK-encoded field block bytes, retained without copying

endHeaders - whether this fragment completes the field block

padding - padding octets including the Pad Length octet, or 0 for no padding

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

promisedStreamId

public int promisedStreamId()

Returns the value of the promisedStreamId record component.

Returns:

the value of the promisedStreamId record component

fieldBlock

public byte[] fieldBlock()

Returns the value of the fieldBlock record component.

Returns:

the value of the fieldBlock record component

endHeaders

public boolean endHeaders()

Returns the value of the endHeaders record component.

Returns:

the value of the endHeaders record component

padding

public int padding()

Returns the value of the padding record component.

Returns:

the value of the padding record component