Package io.github.mahmoudimus.quic.packet

Record Class PacketHeader.Initial

java.lang.Object

java.lang.Record

io.github.mahmoudimus.quic.packet.PacketHeader.Initial

Record Components:

version - the QUIC version

destinationId - the Destination Connection ID

sourceId - the Source Connection ID

token - the address validation token, empty if none

packetNumber - the full packet number

packetNumberLength - the packet number length on the wire, 1 to 4

All Implemented Interfaces:

PacketHeader, PacketHeader.Numbered

Enclosing interface:

PacketHeader

public static record PacketHeader.Initial(QuicVersion version, ConnectionId destinationId, ConnectionId sourceId, byte[] token, long packetNumber, int packetNumberLength)
extends Record
implements PacketHeader.Numbered

An Initial packet header (RFC 9000 section 17.2.2).

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.mahmoudimus.quic.packet.PacketHeader

PacketHeader.Handshake, PacketHeader.Initial, PacketHeader.Numbered, PacketHeader.Retry, PacketHeader.Short, PacketHeader.VersionNegotiation, PacketHeader.ZeroRtt

Field Summary

Fields inherited from interface io.github.mahmoudimus.quic.packet.PacketHeader

FIXED_BIT, KEY_PHASE_BIT, LONG_HEADER_FORM, LONG_RESERVED_BITS, SHORT_RESERVED_BITS, SPIN_BIT

Constructor Summary

Constructors

Constructor	Description
Initial(QuicVersion version, ConnectionId destinationId, ConnectionId sourceId, byte[] token, long packetNumber, int packetNumberLength)	An Initial header.

Method Summary

Modifier and Type	Method	Description
ConnectionId	destinationId()	Returns the value of the destinationId record component.
HeaderLayout	encode(ByteBuffer out)	Writes the header at the buffer's position.
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	hashCode()	Returns a hash code value for this object.
long	packetNumber()	Returns the value of the packetNumber record component.
int	packetNumberLength()	Returns the value of the packetNumberLength record component.
ConnectionId	sourceId()	Returns the value of the sourceId record component.
byte[]	token()	The token.
String	toString()	Returns a string representation of this record class.
PacketType	type()	The packet type.
QuicVersion	version()	Returns the value of the version record component.

Methods inherited from class java.lang.Object

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

Constructor Details

Initial

public Initial(QuicVersion version,
 ConnectionId destinationId,
 ConnectionId sourceId,
 byte[] token,
 long packetNumber,
 int packetNumberLength)

An Initial header.

Parameters:

version - the QUIC version

destinationId - the Destination Connection ID

sourceId - the Source Connection ID

token - the address validation token, empty if none

packetNumber - the full packet number

packetNumberLength - the packet number length on the wire, 1 to 4

Method Details

type

public PacketType type()

Description copied from interface: PacketHeader

The packet type.

Specified by:

type in interface PacketHeader

Returns:

the type

token

public byte[] token()

The token.

Returns:

a copy of the token bytes

encode

public HeaderLayout encode(ByteBuffer out)

Description copied from interface: PacketHeader

Writes the header at the buffer's position.

Specified by:

encode in interface PacketHeader

Parameters:

out - the buffer

Returns:

where the fields landed

equals

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

hashCode

public 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

toString

public 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

version

public QuicVersion version()

Returns the value of the version record component.

Returns:

the value of the version record component

destinationId

public ConnectionId destinationId()

Returns the value of the destinationId record component.

Specified by:

destinationId in interface PacketHeader

Returns:

the value of the destinationId record component

sourceId

public ConnectionId sourceId()

Returns the value of the sourceId record component.

Returns:

the value of the sourceId record component

packetNumber

public long packetNumber()

Returns the value of the packetNumber record component.

Specified by:

packetNumber in interface PacketHeader.Numbered

Returns:

the value of the packetNumber record component

packetNumberLength

public int packetNumberLength()

Returns the value of the packetNumberLength record component.

Specified by:

packetNumberLength in interface PacketHeader.Numbered

Returns:

the value of the packetNumberLength record component