Module io.helidon.http.http2

Package io.helidon.http.http2

Record Class Http2RstStream

java.lang.Object

java.lang.Record

io.helidon.http.http2.Http2RstStream

Record Components:

errorCode - error code of this frame

All Implemented Interfaces:

Http2Frame<Http2Flag.NoFlags>

public record Http2RstStream(Http2ErrorCode errorCode)
extends Record
implements Http2Frame<Http2Flag.NoFlags>

RST Stream frame.

Constructor Summary

Constructors

Constructor	Description
Http2RstStream(Http2ErrorCode errorCode)	Creates an instance of a Http2RstStream record class.

Method Summary

Modifier and Type	Method	Description
static Http2RstStream	create(BufferData bufferData)	Create a RST stream from frame data.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Http2ErrorCode	errorCode()	Returns the value of the errorCode record component.
Http2FrameType	frameType()	Frame type enum.
Http2FrameTypes<Http2Flag.NoFlags>	frameTypes()	Frame types.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Frame name.
Http2FrameData	toFrameData(Http2Settings settings, int streamId, Http2Flag.NoFlags flags)	Not implemented in headers, data, as these may use continuations.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Http2RstStream

public Http2RstStream(Http2ErrorCode errorCode)

Creates an instance of a Http2RstStream record class.

Parameters:

errorCode - the value for the errorCode record component

Method Details

create

public static Http2RstStream create(BufferData bufferData)

Create a RST stream from frame data.

Parameters:

bufferData - frame data

Returns:

RST stream frame

toFrameData

public Http2FrameData toFrameData(Http2Settings settings,
 int streamId,
 Http2Flag.NoFlags flags)

Description copied from interface: Http2Frame

Not implemented in headers, data, as these may use continuations.

Specified by:

toFrameData in interface Http2Frame<Http2Flag.NoFlags>

Parameters:

settings - settings

streamId - stream id of this frame

flags - to use

Returns:

frame data

name

public String name()

Description copied from interface: Http2Frame

Frame name.

Specified by:

name in interface Http2Frame<Http2Flag.NoFlags>

Returns:

frame type name

frameType

public Http2FrameType frameType()

Description copied from interface: Http2Frame

Frame type enum.

Specified by:

frameType in interface Http2Frame<Http2Flag.NoFlags>

Returns:

type of this frame

frameTypes

public Http2FrameTypes<Http2Flag.NoFlags> frameTypes()

Description copied from interface: Http2Frame

Frame types.

Specified by:

frameTypes in interface Http2Frame<Http2Flag.NoFlags>

Returns:

frame types

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 Objects::equals(Object,Object).

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.

errorCode

public Http2ErrorCode errorCode()

Returns the value of the errorCode record component.

Returns:

the value of the errorCode record component