StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::Pipeline::TopologySnapshot Struct Reference

Owned, coherent-per-queue view of the pipeline stages and queues. More...

#include <StormByte/multimedia/pipeline/telemetry.hxx>

Collaboration diagram for StormByte::Multimedia::Pipeline::TopologySnapshot:

Public Attributes

bool Available = false
 False before a run registered its topology.
bool RecorderFailed = false
 The latest run could not allocate its topology recorder: nothing was recorded, Available is false and Complete is false. The job itself is unaffected.
bool Complete = true
 False when telemetry bookkeeping could not allocate; stages, queues, producer links, budgets or pending lists may be missing. Never affects the job.
TopologySnapshotState State = TopologySnapshotState::Live
 Final once the run tore its stages down.
std::uint64_t Run = 0
 Run generation; increases on each registration reset.
StormByte::Safe::Vector< TopologyStage > Stages
 Stages in pipeline order, then registration order.
StormByte::Safe::Vector< TopologyQueue > Queues
 Unique queues.
StormByte::Safe::Vector< TopologyBudget > Budgets
 Unique budgets.

Detailed Description

Owned, coherent-per-queue view of the pipeline stages and queues.

Different queues are read one after another, not atomically as a group. Values are Buffer accounting: bytes are logical caller weights, not resident memory; a full queue is normal backpressure, not an error. Elements and bytes are independent units; no batch size or per-item average is implied.

Member Data Documentation

◆ Available

bool StormByte::Multimedia::Pipeline::TopologySnapshot::Available = false

False before a run registered its topology.

◆ Budgets

StormByte::Safe::Vector<TopologyBudget> StormByte::Multimedia::Pipeline::TopologySnapshot::Budgets

Unique budgets.

◆ Complete

bool StormByte::Multimedia::Pipeline::TopologySnapshot::Complete = true

False when telemetry bookkeeping could not allocate; stages, queues, producer links, budgets or pending lists may be missing. Never affects the job.

◆ Queues

StormByte::Safe::Vector<TopologyQueue> StormByte::Multimedia::Pipeline::TopologySnapshot::Queues

Unique queues.

◆ RecorderFailed

bool StormByte::Multimedia::Pipeline::TopologySnapshot::RecorderFailed = false

The latest run could not allocate its topology recorder: nothing was recorded, Available is false and Complete is false. The job itself is unaffected.

◆ Run

std::uint64_t StormByte::Multimedia::Pipeline::TopologySnapshot::Run = 0

Run generation; increases on each registration reset.

◆ Stages

StormByte::Safe::Vector<TopologyStage> StormByte::Multimedia::Pipeline::TopologySnapshot::Stages

Stages in pipeline order, then registration order.

◆ State

TopologySnapshotState StormByte::Multimedia::Pipeline::TopologySnapshot::State = TopologySnapshotState::Live

Final once the run tore its stages down.


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