Package io.github.mahmoudimus.quic.frame

Record Class Frame.Ack

java.lang.Object

java.lang.Record

io.github.mahmoudimus.quic.frame.Frame.Ack

Record Components:

ranges - the acknowledged ranges, largest first, at least one

ackDelay - the ACK Delay field, in units of 2^{ack_delay_exponent} microseconds

ecn - the ECN counts, or null for a type 0x02 frame

All Implemented Interfaces:

Frame

Enclosing interface:

Frame

public static record Frame.Ack(List<Frame.AckRange> ranges, long ackDelay, Frame.EcnCounts ecn)
extends Record
implements Frame

An ACK frame (types 0x02 and 0x03). Ranges run from the largest packet number down, and consecutive ranges are separated by at least one unacknowledged packet number, so they encode exactly as quinn's Ack::encode does.

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
Ack(List<Frame.AckRange> ranges, long ackDelay, Frame.EcnCounts ecn)	An ACK frame.

Method Summary

Modifier and Type	Method	Description
long	ackDelay()	Returns the value of the ackDelay record component.
boolean	contains(long packetNumber)	Whether the frame acknowledges a packet number.
Frame.EcnCounts	ecn()	Returns the value of the ecn record component.
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.
final int	hashCode()	Returns a hash code value for this object.
long	largest()	The largest acknowledged packet number.
static Frame.Ack	of(long ackDelay, Frame.EcnCounts ecn, long... packetNumbers)	An ACK frame for a set of packet numbers, in any order and with duplicates: they are sorted and merged into ranges.
List<Frame.AckRange>	ranges()	Returns the value of the ranges 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

Ack

public Ack(List<Frame.AckRange> ranges,
 long ackDelay,
 Frame.EcnCounts ecn)

An ACK frame.

Parameters:

ranges - the acknowledged ranges, largest first, separated by gaps

ackDelay - the encoded ACK delay

ecn - the ECN counts, or null

Method Details

of

public static Frame.Ack of(long ackDelay,
 Frame.EcnCounts ecn,
 long... packetNumbers)

An ACK frame for a set of packet numbers, in any order and with duplicates: they are sorted and merged into ranges.

Parameters:

ackDelay - the encoded ACK delay

ecn - the ECN counts, or null

packetNumbers - the acknowledged packet numbers, at least one

Returns:

the frame

largest

public long largest()

The largest acknowledged packet number.

Returns:

the first range's largest packet number

contains

public boolean contains(long packetNumber)

Whether the frame acknowledges a packet number.

Parameters:

packetNumber - the packet number

Returns:

true if a range contains it

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. 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.

ranges

public List<Frame.AckRange> ranges()

Returns the value of the ranges record component.

Returns:

the value of the ranges record component

ackDelay

public long ackDelay()

Returns the value of the ackDelay record component.

Returns:

the value of the ackDelay record component

ecn

public Frame.EcnCounts ecn()

Returns the value of the ecn record component.

Returns:

the value of the ecn record component