SatCat5
satcat5::net::TelemetrySink Class Referenceabstract

Detailed Description

User data sinks must inherit from the TelemetrySink class.

This class sends the encoded data to its destination(s).

See also
net_telemetry.h, net::TelemetrySource.

Definition at line 143 of file net_telemetry.h.

#include <net_telemetry.h>

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

Public Member Functions

virtual void telem_ready (u32 tier_id, unsigned nbytes, const void *data)=0
 This method is called for each outgoing telemetry message. More...
 

Protected Member Functions

 TelemetrySink (satcat5::net::TelemetryAggregator *tlm)
 Only children can safely access constructor/destructor.
 

Protected Attributes

satcat5::net::TelemetryAggregator *const m_tlm
 Pointer to the parent object.
 

Private Attributes

satcat5::net::TelemetrySinkm_next
 

Member Function Documentation

◆ telem_ready()

virtual void satcat5::net::TelemetrySink::telem_ready ( u32  tier_id,
unsigned  nbytes,
const void *  data 
)
pure virtual

This method is called for each outgoing telemetry message.

  • If the aggregator is in concatenate mode (default), all tiers are added to a single dictionary and the method is called once. (Placeholder tier_id = 0.)
  • If the aggregator is in per-tier mode, the method is called for each telemetry tier and sets the appropriate tier_id. Child class MUST override this method.

Implemented in satcat5::udp::Telemetry, satcat5::eth::Telemetry, and satcat5::net::TelemetryLoopback.


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