mm::node::Monitoring Struct Reference

A client-defined recording of a set of parameters streamed over time. More...

#include <monitoring.h>

Collaboration diagram for mm::node::Monitoring:

Public Attributes
std::string	topic
	URL-safe unique id; also the WebSocket pub/sub topic.
std::optional< std::string >	name
	Optional human-readable label (display only).
std::chrono::milliseconds	interval
	Flush cadence (bounded [5 ms, 2000 ms]).
std::vector< MonitoredParameter >	parameters
	Objects to sample, in positional order.

Detailed Description

A client-defined recording of a set of parameters streamed over time.

Created via POST /api/monitorings and streamed over the monitoring WebSocket under its topic. The stream is lossless: every process-data cycle recorded since the last flush is delivered. interval is the flush cadence (how often a batch is published), not a sample rate — the manager ships every cycle-row in one positional-array batch per flush (one inner array per cycle, in parameters order, prefixed by the cycle timestamp). This struct is the immutable client configuration; the runtime state (read cursor, per-parameter PDO/SDO classification) lives on the manager that owns the monitoring, not here.

Member Data Documentation

interval

std::chrono::milliseconds mm::node::Monitoring::interval

Flush cadence (bounded [5 ms, 2000 ms]).

name

std::optional<std::string> mm::node::Monitoring::name

Optional human-readable label (display only).

parameters

std::vector<MonitoredParameter> mm::node::Monitoring::parameters

Objects to sample, in positional order.

topic

std::string mm::node::Monitoring::topic

URL-safe unique id; also the WebSocket pub/sub topic.

---

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

• libs/node/monitoring.h