Package org.microproxy.frames

Record Class Http2Frame.PushPromise

java.lang.Object

java.lang.Record

org.microproxy.frames.Http2Frame.PushPromise

Record Components:

streamId - the stream the promise is made on

promisedStreamId - the stream it reserves

fields - the promised request's header block

All Implemented Interfaces:

Http2Frame, HttpFrame

Enclosing interface:

Http2Frame

public static record Http2Frame.PushPromise(int streamId, int promisedStreamId, List<Field> fields)
extends Record
implements Http2Frame

PUSH_PROMISE (section 6.6). The proxy disables server push, so this record exists for completeness: interceptors are never shown one.

Nested Class Summary

Nested classes/interfaces inherited from interface org.microproxy.frames.Http2Frame

Http2Frame.Data, Http2Frame.GoAway, Http2Frame.Headers, Http2Frame.Ping, Http2Frame.Priority, Http2Frame.PushPromise, Http2Frame.RstStream, Http2Frame.Settings, Http2Frame.Unknown, Http2Frame.WindowUpdate

Field Summary

Fields inherited from interface org.microproxy.frames.Http2Frame

ERROR_NAMES, SETTING_NAMES, SETTINGS_ENABLE_CONNECT_PROTOCOL, SETTINGS_ENABLE_PUSH, SETTINGS_HEADER_TABLE_SIZE, SETTINGS_INITIAL_WINDOW_SIZE, SETTINGS_MAX_CONCURRENT_STREAMS, SETTINGS_MAX_FRAME_SIZE, SETTINGS_MAX_HEADER_LIST_SIZE, TYPE_CONTINUATION, TYPE_DATA, TYPE_GOAWAY, TYPE_HEADERS, TYPE_PING, TYPE_PRIORITY, TYPE_PUSH_PROMISE, TYPE_RST_STREAM, TYPE_SETTINGS, TYPE_WINDOW_UPDATE

Constructor Summary

Constructors

Constructor	Description
PushPromise(int streamId, int promisedStreamId, List<Field> fields)	Creates PUSH_PROMISE.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<Field>	fields()	Returns the value of the fields record component.
final int	hashCode()	Returns a hash code value for this object.
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.
long	typeCode()	The frame type's code on the wire.
String	typeName()	The frame type's name as the protocol's RFC spells it (DATA, HEADERS, SETTINGS, ...), or UNKNOWN for an extension or reserved type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.microproxy.frames.Http2Frame

protocol

Constructor Details

PushPromise

public PushPromise(int streamId,
 int promisedStreamId,
 List<Field> fields)

Creates PUSH_PROMISE.

Parameters:

streamId - the stream, 1 or more

promisedStreamId - the promised stream, 1 or more

fields - the header block, copied

Method Details

typeName

public String typeName()

Description copied from interface: HttpFrame

The frame type's name as the protocol's RFC spells it (DATA, HEADERS, SETTINGS, ...), or UNKNOWN for an extension or reserved type.

Specified by:

typeName in interface HttpFrame

Returns:

the frame type name

typeCode

public long typeCode()

Description copied from interface: HttpFrame

The frame type's code on the wire.

Specified by:

typeCode in interface HttpFrame

Returns:

the unsigned 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 Http2Frame

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

fields

public List<Field> fields()

Returns the value of the fields record component.

Returns:

the value of the fields record component