Package org.microproxy.frames

Record Class Http2Frame.Ping

java.lang.Object

java.lang.Record

org.microproxy.frames.Http2Frame.Ping

Record Components:

ack - whether this answers a PING

opaqueData - the opaque data

All Implemented Interfaces:

Http2Frame, HttpFrame

Enclosing interface:

Http2Frame

public static record Http2Frame.Ping(boolean ack, long opaqueData)
extends Record
implements Http2Frame

PING (section 6.7); its 8 opaque octets as a big-endian long.

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
Ping(boolean ack, long opaqueData)	Creates an instance of a Ping record class.

Method Summary

Modifier and Type	Method	Description
boolean	ack()	Returns the value of the ack record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
long	opaqueData()	Returns the value of the opaqueData record component.
int	streamId()	The stream the frame belongs to, or 0 for the connection.
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

Ping

public Ping(boolean ack,
 long opaqueData)

Creates an instance of a Ping record class.

Parameters:

ack - the value for the ack record component

opaqueData - the value for the opaqueData record component

Method Details

streamId

public int streamId()

Description copied from interface: Http2Frame

The stream the frame belongs to, or 0 for the connection.

Specified by:

streamId in interface Http2Frame

Returns:

the stream identifier

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. All components in this record class 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.

ack

public boolean ack()

Returns the value of the ack record component.

Returns:

the value of the ack record component

opaqueData

public long opaqueData()

Returns the value of the opaqueData record component.

Returns:

the value of the opaqueData record component