SatCat5
satcat5::net::TelemetryWatcher Class Referenceabstract

Detailed Description

Callback API for incoming telemetry items.

See also
net_telemetry.h, net::TelemetryRx.

Definition at line 259 of file net_telemetry.h.

#include <net_telemetry.h>

Inheritance diagram for satcat5::net::TelemetryWatcher:
[legend]
Collaboration diagram for satcat5::net::TelemetryWatcher:
[legend]

Public Member Functions

virtual void telem_rcvd (u32 key, const QCBORItem &item, QCBORDecodeContext *cbor)=0
 Callback for each received key/value pair. More...
 

Protected Member Functions

 TelemetryWatcher (satcat5::net::TelemetryRx *rx)
 Constructor and destructor are accessible to the child only.
 

Protected Attributes

satcat5::net::TelemetryRx *const m_rx
 Pointer to the receive-and-decode object.
 

Private Attributes

satcat5::net::TelemetryWatcherm_next
 

Member Function Documentation

◆ telem_rcvd()

virtual void satcat5::net::TelemetryWatcher::telem_rcvd ( u32  key,
const QCBORItem &  item,
QCBORDecodeContext *  cbor 
)
pure virtual

Callback for each received key/value pair.

The child object MUST override this callback method. Users with string keys should compare against the hash first, to ensure the matching process can iterate quickly.

Parameters
keyInteger key, or CRC32 hash of a string key.
itemValue associated with this key.
cborQCBOR decoder for reading complex data structures. This pointer is provided for maps and arrays, not for simple items. The callback MUST NOT call ExitArray or ExitMap.

Implemented in satcat5::net::TelemetryLogger.


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