MOQ track handler for subscribed track. More...

#include <subscribe_track_handler.h>

Inheritance diagram for quicr::SubscribeTrackHandler:

Public Types
enum class	Error : uint8_t { kOk = 0 , kNotAuthorized , kNotSubscribed , kNoData }
	Receive status codes. More...

enum class	Status : uint8_t { kOk = 0 , kNotConnected , kError , kNotAuthorized , kNotSubscribed , kPendingResponse , kSendingUnsubscribe }
	Status codes for the subscribe track. More...

Public Member Functions
constexpr Status	GetStatus () const noexcept
	Get the status of the subscribe.

void	SetPriority (uint8_t priority) noexcept
	Set the priority of received data.

constexpr messages::ObjectPriority	GetPriority () const noexcept
	Get subscription priority.

constexpr messages::GroupOrder	GetGroupOrder () const noexcept
	Get subscription group order.

constexpr messages::FilterType	GetFilterType () const noexcept
	Get subscription filter type.

constexpr std::optional< messages::GroupId >	GetLatestGroupID () const noexcept

constexpr std::optional< messages::ObjectId >	GetLatestObjectID () const noexcept

constexpr void	SetLatestGroupID (messages::GroupId new_id) noexcept

constexpr void	SetLatestObjectID (messages::ObjectId new_id) noexcept

Callbacks
virtual void	ObjectReceived (const ObjectHeaders &object_headers, BytesSpan data)
	Notification of received [full] data object.

virtual void	StreamDataRecv (bool is_start, uint64_t stream_id, std::shared_ptr< const std::vector< uint8_t > > data)
	Notification of received stream data slice.

virtual void	DgramDataRecv (std::shared_ptr< const std::vector< uint8_t > > data)
	Notification of received datagram data.

virtual void	PartialObjectReceived (const ObjectHeaders &object_headers, BytesSpan data)
	Notification of a partial object received data object.

virtual void	StatusChanged (Status status)
	Notification of subscribe status.

virtual void	MetricsSampled (const SubscribeTrackMetrics &metrics)
	Notification callback to provide sampled metrics.

void	RequestNewGroup () noexcept

Static Public Member Functions
static std::shared_ptr< SubscribeTrackHandler >	Create (const FullTrackName &full_track_name, messages::ObjectPriority priority, messages::GroupOrder group_order=messages::GroupOrder::kAscending, messages::FilterType filter_type=messages::FilterType::kLatestObject)
	Create shared Subscribe track handler.

Public Attributes
SubscribeTrackMetrics	subscribe_track_metrics_
	Subscribe metrics for the track.

std::function< void(messages::SubscribeId, messages::TrackAlias)>	new_group_request_callback_

Protected Member Functions
	SubscribeTrackHandler (const FullTrackName &full_track_name, messages::ObjectPriority priority, messages::GroupOrder group_order, messages::FilterType filter_type)
	Subscribe track handler constructor.

void	SetStatus (Status status) noexcept
	Set the subscribe status.

Detailed Description

MOQ track handler for subscribed track.

MOQ subscribe track handler defines all track related callbacks and functions for subscribe. Track handler operates on a single track (namespace + name).

This extends the base track handler to add subscribe handling

Examples: client.cpp, and server.cpp.

Member Enumeration Documentation

◆ Error

enum class quicr::SubscribeTrackHandler::Error : uint8_t

strong

Receive status codes.

Enumerator
kOk
kNotAuthorized
kNotSubscribed
kNoData

◆ Status

enum class quicr::SubscribeTrackHandler::Status : uint8_t

strong

Status codes for the subscribe track.

Enumerator
kOk
kNotConnected
kError
kNotAuthorized
kNotSubscribed
kPendingResponse
kSendingUnsubscribe	In this state, callbacks will not be called.

Constructor & Destructor Documentation

◆ SubscribeTrackHandler()

quicr::SubscribeTrackHandler::SubscribeTrackHandler	(	const FullTrackName &	full_track_name,
		messages::ObjectPriority	priority,
		messages::GroupOrder	group_order,
		messages::FilterType	filter_type )

inlineprotected

Subscribe track handler constructor.

Parameters

full_track_name Full track name struct

Member Function Documentation

◆ Create()

static std::shared_ptr< SubscribeTrackHandler > quicr::SubscribeTrackHandler::Create	(	const FullTrackName &	full_track_name,
		messages::ObjectPriority	priority,
		messages::GroupOrder	group_order = messages::GroupOrder::kAscending,
		messages::FilterType	filter_type = messages::FilterType::kLatestObject )

inlinestatic

Create shared Subscribe track handler.

Parameters

full_track_name	Full track name struct
priority	Subscription priority, if omitted, publisher priority is considered
group_order	Order for group delivery

◆ DgramDataRecv()

virtual void quicr::SubscribeTrackHandler::DgramDataRecv ( std::shared_ptr< const std::vector< uint8_t > > data )

virtual

Notification of received datagram data.

Event notification to provide the caller the raw data received as a datagram

Parameters

data	Shared pointer to the data received

◆ GetFilterType()

messages::FilterType quicr::SubscribeTrackHandler::GetFilterType ( ) const

inlineconstexprnoexcept

Get subscription filter type.

Returns: FilterType value

◆ GetGroupOrder()

messages::GroupOrder quicr::SubscribeTrackHandler::GetGroupOrder ( ) const

inlineconstexprnoexcept

Get subscription group order.

Returns: GroupOrder value

◆ GetLatestGroupID()

std::optional< messages::GroupId > quicr::SubscribeTrackHandler::GetLatestGroupID ( ) const

inlineconstexprnoexcept

◆ GetLatestObjectID()

std::optional< messages::ObjectId > quicr::SubscribeTrackHandler::GetLatestObjectID ( ) const

inlineconstexprnoexcept

◆ GetPriority()

messages::ObjectPriority quicr::SubscribeTrackHandler::GetPriority ( ) const

inlineconstexprnoexcept

Get subscription priority.

Returns: Priority value

◆ GetStatus()

Status quicr::SubscribeTrackHandler::GetStatus ( ) const

inlineconstexprnoexcept

Get the status of the subscribe.

Returns: Status of the subscribe

◆ MetricsSampled()

virtual void quicr::SubscribeTrackHandler::MetricsSampled ( const SubscribeTrackMetrics & metrics )

inlinevirtual

Notification callback to provide sampled metrics.

Callback will be triggered on Config::metrics_sample_ms to provide the sampled data based on the sample period. After this callback, the period/sample based metrics will reset and start over for the new period.

Parameters

metrics Copy of the subscribed metrics for the sample period

◆ ObjectReceived()

virtual void quicr::SubscribeTrackHandler::ObjectReceived	(	const ObjectHeaders &	object_headers,
		BytesSpan	data )

virtual

Notification of received [full] data object.

Event notification to provide the caller the received full data object

Warning: This data will be invalided after return of this method

Parameters

object_headers	Object headers, must include group and object Ids
data	Object payload data received, MUST match ObjectHeaders::payload_length.

Examples: client.cpp, and server.cpp.

◆ PartialObjectReceived()

virtual void quicr::SubscribeTrackHandler::PartialObjectReceived	(	const ObjectHeaders &	object_headers,
		BytesSpan	data )

inlinevirtual

Notification of a partial object received data object.

Event notification to provide the caller the received data object

Warning: This data will be invalided after return of this method

Parameters

object_headers	Object headers, must include group and object Ids
data	Object payload data received, can be <= ObjectHeaders::payload_length

◆ RequestNewGroup()

void quicr::SubscribeTrackHandler::RequestNewGroup ( )

noexcept

◆ SetLatestGroupID()

void quicr::SubscribeTrackHandler::SetLatestGroupID ( messages::GroupId new_id )

inlineconstexprnoexcept

◆ SetLatestObjectID()

void quicr::SubscribeTrackHandler::SetLatestObjectID ( messages::ObjectId new_id )

inlineconstexprnoexcept

◆ SetPriority()

void quicr::SubscribeTrackHandler::SetPriority ( uint8_t priority )

inlinenoexcept

Set the priority of received data.

Parameters

priority Priority value of received data

◆ SetStatus()

void quicr::SubscribeTrackHandler::SetStatus ( Status status )

inlineprotectednoexcept

Set the subscribe status.

Parameters

status Status of the subscribe

◆ StatusChanged()

virtual void quicr::SubscribeTrackHandler::StatusChanged ( Status status )

inlinevirtual

Notification of subscribe status.

Notification of the subscribe status

Parameters

status Indicates status of the subscribe

Examples: client.cpp, and server.cpp.

◆ StreamDataRecv()

virtual void quicr::SubscribeTrackHandler::StreamDataRecv	(	bool	is_start,
		uint64_t	stream_id,
		std::shared_ptr< const std::vector< uint8_t > >	data )

virtual

Notification of received stream data slice.

Event notification to provide the caller the raw data received on a stream

Parameters

is_start	True to indicate if this data is the start of a new stream
stream_id	Stream ID data was received on
data	Shared pointer to the data received

Member Data Documentation

◆ new_group_request_callback_

std::function<void(messages::SubscribeId, messages::TrackAlias)> quicr::SubscribeTrackHandler::new_group_request_callback_

◆ subscribe_track_metrics_

SubscribeTrackMetrics quicr::SubscribeTrackHandler::subscribe_track_metrics_

Subscribe metrics for the track.

Subscribe metrics are updated real-time and transport quic metrics on metrics_sample_ms period.

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

include/quicr/subscribe_track_handler.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ Error

◆ Status

Constructor & Destructor Documentation

◆ SubscribeTrackHandler()

Member Function Documentation

◆ Create()

◆ DgramDataRecv()

◆ GetFilterType()

◆ GetGroupOrder()

◆ GetLatestGroupID()

◆ GetLatestObjectID()

◆ GetPriority()

◆ GetStatus()

◆ MetricsSampled()

◆ ObjectReceived()

◆ PartialObjectReceived()

◆ RequestNewGroup()

◆ SetLatestGroupID()

◆ SetLatestObjectID()

◆ SetPriority()

◆ SetStatus()

◆ StatusChanged()

◆ StreamDataRecv()

Member Data Documentation

◆ new_group_request_callback_

◆ subscribe_track_metrics_