quicr::ObjectHeaders Struct Reference

Object headers struct. More...

#include <object.h>

Public Attributes
uint64_t	group_id
	Object group ID - Application defined order of generation. More...
uint64_t	object_id
	Object ID - Application defined order of generation. More...
uint64_t	subgroup_id { 0 }
	Subgroup ID - Starts at 0, monotonically increases by 1. More...
uint64_t	payload_length
	Length of payload of the object data. More...
ObjectStatus	status { ObjectStatus::kAvailable }
	Status of the object at the publisher. More...
std::optional< uint8_t >	priority
	Priority of the object, lower value is better. More...
std::optional< uint16_t >	ttl
	Object time to live in milliseconds. More...
std::optional< TrackMode >	track_mode
	Track Mode of how the object was received or mode to use when sending. More...
std::optional< Extensions >	extensions
	Mutable object extensions, preserving duplicate values per type. More...
std::optional< Extensions >	immutable_extensions
	Immutable object extensions decoded from the immutable extension container. More...

Detailed Description

Object headers struct.

Object headers are passed when sending and receiving an object. The object headers describe the object.

Examples

simple_publish/main.cpp, and simple_subscribe/main.cpp.

Member Data Documentation

extensions

std::optional<Extensions> quicr::ObjectHeaders::extensions

Mutable object extensions, preserving duplicate values per type.

group_id

uint64_t quicr::ObjectHeaders::group_id

Object group ID - Application defined order of generation.

immutable_extensions

std::optional<Extensions> quicr::ObjectHeaders::immutable_extensions

Immutable object extensions decoded from the immutable extension container.

object_id

uint64_t quicr::ObjectHeaders::object_id

Object ID - Application defined order of generation.

payload_length

uint64_t quicr::ObjectHeaders::payload_length

Length of payload of the object data.

priority

std::optional<uint8_t> quicr::ObjectHeaders::priority

Priority of the object, lower value is better.

status

ObjectStatus quicr::ObjectHeaders::status { ObjectStatus::kAvailable }

Status of the object at the publisher.

subgroup_id

uint64_t quicr::ObjectHeaders::subgroup_id { 0 }

Subgroup ID - Starts at 0, monotonically increases by 1.

track_mode

std::optional<TrackMode> quicr::ObjectHeaders::track_mode

Track Mode of how the object was received or mode to use when sending.

ttl

std::optional<uint16_t> quicr::ObjectHeaders::ttl

Object time to live in milliseconds.

---

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

• include/quicr/messages/object.h