quicr::messages::DatagramHeaderProperties Struct Reference

#include <message_serialisation.h>

Public Member Functions
constexpr	DatagramHeaderProperties (const std::uint8_t type)
constexpr	DatagramHeaderProperties (const bool extensions, const bool end_of_group, const bool zero_object_id, const bool default_priority, const bool status) noexcept
constexpr std::uint8_t	GetType () const noexcept

Static Public Member Functions
static constexpr bool	IsValid (const std::uint8_t type) noexcept

Public Attributes
const bool	extensions
	Whether an extension block is present. More...
const bool	end_of_group
	Whether this payload object ends its group. More...
const bool	zero_object_id
	Whether object ID is implicitly zero and omitted. More...
const bool	default_priority
	Whether priority is inherited and omitted. More...
const bool	status
	Whether this is a status datagram rather than payload. More...

Static Public Attributes
static constexpr std::uint8_t	kExtensionsBit = 0x01
	Extensions-present bit. More...
static constexpr std::uint8_t	kEndOfGroupBit = 0x02
	End-of-group bit. More...
static constexpr std::uint8_t	kZeroObjectIdBit = 0x04
	Implicit-zero-object-ID bit. More...
static constexpr std::uint8_t	kDefaultPriorityBit = 0x08
	Inherited-priority bit. More...
static constexpr std::uint8_t	kStatusBit = 0x20
	Status-datagram bit. More...

Detailed Description

Describes the properties of a datagram header type.

Constructor & Destructor Documentation

DatagramHeaderProperties() [1/2]

constexpr quicr::messages::DatagramHeaderProperties::DatagramHeaderProperties ( const std::uint8_t  type )

inlineexplicitconstexpr

Parameters

type	Datagram header bitfield.

Exceptions

ProtocolViolationException

for reserved bits or status combined with end-of-group.

DatagramHeaderProperties() [2/2]

constexpr quicr::messages::DatagramHeaderProperties::DatagramHeaderProperties ( const bool  extensions, const bool  end_of_group, const bool  zero_object_id, const bool  default_priority, const bool  status  )

inlineconstexprnoexcept

Builds properties without validation.

Parameters

extensions	Whether extensions are present.
end_of_group	Whether this marks the group end.
zero_object_id	Whether object ID zero is omitted.
default_priority	Whether publisher priority is inherited.
status	Whether this is a status datagram.

Member Function Documentation

GetType()

constexpr std::uint8_t quicr::messages::DatagramHeaderProperties::GetType ( ) const

inlineconstexprnoexcept

Get the type of this datagram header based on its properties.

Returns

Encoded datagram-header type bitfield.

IsValid()

static constexpr bool quicr::messages::DatagramHeaderProperties::IsValid ( const std::uint8_t  type )

inlinestaticconstexprnoexcept

Checks if the given datagram type is a valid value.

Parameters

type	The type of the datagram message.

Returns

False if a protocol violation.

Member Data Documentation

default_priority

const bool quicr::messages::DatagramHeaderProperties::default_priority

Whether priority is inherited and omitted.

end_of_group

const bool quicr::messages::DatagramHeaderProperties::end_of_group

Whether this payload object ends its group.

extensions

const bool quicr::messages::DatagramHeaderProperties::extensions

Whether an extension block is present.

kDefaultPriorityBit

constexpr std::uint8_t quicr::messages::DatagramHeaderProperties::kDefaultPriorityBit = 0x08

staticconstexpr

Inherited-priority bit.

kEndOfGroupBit

constexpr std::uint8_t quicr::messages::DatagramHeaderProperties::kEndOfGroupBit = 0x02

staticconstexpr

End-of-group bit.

kExtensionsBit

constexpr std::uint8_t quicr::messages::DatagramHeaderProperties::kExtensionsBit = 0x01

staticconstexpr

Extensions-present bit.

kStatusBit

constexpr std::uint8_t quicr::messages::DatagramHeaderProperties::kStatusBit = 0x20

staticconstexpr

Status-datagram bit.

kZeroObjectIdBit

constexpr std::uint8_t quicr::messages::DatagramHeaderProperties::kZeroObjectIdBit = 0x04

staticconstexpr

Implicit-zero-object-ID bit.

status

const bool quicr::messages::DatagramHeaderProperties::status

Whether this is a status datagram rather than payload.

zero_object_id

const bool quicr::messages::DatagramHeaderProperties::zero_object_id

Whether object ID is implicitly zero and omitted.

---

The documentation for this struct was generated from the following file:

• include/quicr/messages/message_serialisation.h