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

One real queue and its Buffer accounting. More...

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

Collaboration diagram for StormByte::Multimedia::Pipeline::TopologyQueue:

Public Attributes

std::uint64_t Id = 0
 Stable queue id, unique in the process.
TopologyQueueKind Kind = TopologyQueueKind::Pipe
 Backing storage.
int Key = 0
 Hopper key in the consumer (track index for pending queues).
StormByte::Safe::Optional< std::uint64_t > Consumer
 Consumer stage id; for pending queues the owning demuxer.
StormByte::Safe::Vector< std::uint64_t > Producers
 Registered producer stage ids.
StormByte::Safe::Optional< std::uint64_t > Budget
 TopologyBudget::Id charged by this queue, if any.
bool BytesAccounted = true
 False when the queue never accounts bytes.
TopologySnapshotState State = TopologySnapshotState::Live
 Live or final reading.
StormByte::Safe::Optional< enum StormByte::Multimedia::Type > Media
 Media carried, when known.
StormByte::Buffer::QueueSnapshot Snapshot
 Limits, occupancy, peaks, pressure, waits, Closed and Exists.

Detailed Description

One real queue and its Buffer accounting.

Each queue appears once even when several producers share it. Snapshot.Exists == false marks a key known to the topology that is not (or no longer) wired. Unlimited bounds have Limits.ElementsLimited() / Limits.BytesLimited() false; an engaged bound equal to zero is a real zero cap.

Member Data Documentation

◆ Budget

StormByte::Safe::Optional<std::uint64_t> StormByte::Multimedia::Pipeline::TopologyQueue::Budget

TopologyBudget::Id charged by this queue, if any.

◆ BytesAccounted

bool StormByte::Multimedia::Pipeline::TopologyQueue::BytesAccounted = true

False when the queue never accounts bytes.

◆ Consumer

StormByte::Safe::Optional<std::uint64_t> StormByte::Multimedia::Pipeline::TopologyQueue::Consumer

Consumer stage id; for pending queues the owning demuxer.

◆ Id

std::uint64_t StormByte::Multimedia::Pipeline::TopologyQueue::Id = 0

Stable queue id, unique in the process.

◆ Key

int StormByte::Multimedia::Pipeline::TopologyQueue::Key = 0

Hopper key in the consumer (track index for pending queues).

◆ Kind

TopologyQueueKind StormByte::Multimedia::Pipeline::TopologyQueue::Kind = TopologyQueueKind::Pipe

Backing storage.

◆ Media

StormByte::Safe::Optional<enum StormByte::Multimedia::Type> StormByte::Multimedia::Pipeline::TopologyQueue::Media

Media carried, when known.

◆ Producers

StormByte::Safe::Vector<std::uint64_t> StormByte::Multimedia::Pipeline::TopologyQueue::Producers

Registered producer stage ids.

◆ Snapshot

StormByte::Buffer::QueueSnapshot StormByte::Multimedia::Pipeline::TopologyQueue::Snapshot

Limits, occupancy, peaks, pressure, waits, Closed and Exists.

◆ State

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

Live or final reading.


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