Package io.github.mahmoudimus.quic.frame

Record Class Frame.StopSending

java.lang.Object

java.lang.Record

io.github.mahmoudimus.quic.frame.Frame.StopSending

Record Components:

streamId - the stream ID

errorCode - the application error code

All Implemented Interfaces:

Frame

Enclosing interface:

Frame

public static record Frame.StopSending(long streamId, long errorCode)
extends Record
implements Frame

A STOP_SENDING frame (type 0x05).

Nested Class Summary

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

Frame.Ack, Frame.AckFrequency, Frame.AckRange, Frame.ApplicationClose, Frame.ConnectionClose, Frame.Crypto, Frame.DataBlocked, Frame.Datagram, Frame.EcnCounts, Frame.HandshakeDone, Frame.ImmediateAck, Frame.MaxData, Frame.MaxStreamData, Frame.MaxStreams, Frame.NewConnectionId, Frame.NewToken, Frame.Padding, Frame.PathChallenge, Frame.PathResponse, Frame.Ping, Frame.ResetStream, Frame.RetireConnectionId, Frame.StopSending, Frame.Stream, Frame.StreamDataBlocked, Frame.StreamsBlocked

Field Summary

Fields inherited from interface io.github.mahmoudimus.quic.frame.Frame

MAX_STREAM_COUNT

Constructor Summary

Constructors

Constructor	Description
StopSending(long streamId, long errorCode)	A STOP_SENDING frame.

Method Summary

Modifier and Type	Method	Description
void	encode(ByteBuffer out)	Writes the frame at the buffer's position.
int	encodedLength()	The encoded length.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	errorCode()	Returns the value of the errorCode record component.
final int	hashCode()	Returns a hash code value for this object.
long	streamId()	Returns the value of the streamId record component.
final String	toString()	Returns a string representation of this record class.
FrameType	type()	The frame type.
long	typeCode()	The exact type code this frame encodes with, flags included.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.mahmoudimus.quic.frame.Frame

isAckEliciting

Constructor Details

StopSending

public StopSending(long streamId,
 long errorCode)

A STOP_SENDING frame.

Parameters:

streamId - the stream ID

errorCode - the application error code

Method Details

type

public FrameType type()

Description copied from interface: Frame

The frame type.

Specified by:

type in interface Frame

Returns:

the type

typeCode

public long typeCode()

Description copied from interface: Frame

The exact type code this frame encodes with, flags included.

Specified by:

typeCode in interface Frame

Returns:

the type code

encodedLength

public int encodedLength()

Description copied from interface: Frame

The encoded length.

Specified by:

encodedLength in interface Frame

Returns:

the bytes Frame.encode(java.nio.ByteBuffer) writes

encode

public void encode(ByteBuffer out)

Description copied from interface: Frame

Writes the frame at the buffer's position.

Specified by:

encode in interface Frame

Parameters:

out - the buffer

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.

streamId

public long streamId()

Returns the value of the streamId record component.

Returns:

the value of the streamId record component

errorCode

public long errorCode()

Returns the value of the errorCode record component.

Returns:

the value of the errorCode record component