Class DspsrPipelineMonitor

Class Documentation

class DspsrPipelineMonitor

a class to abstract out monitoring of DSPSR pipelines.

This class performs background monitoring of a DSPSR pipeline.

Instances of this should be created just after a pipeline is constructed and the start_monitoring method should be called just before the pipeline starts running.

Public Functions

DspsrPipelineMonitor(std::shared_ptr<::dsp::Pipeline> pipeline, uint64_t monitor_period_ms = 1000)

construct instance of monitor

Parameters

  • pipeline – the monitor instance to monitor

  • monitor_period_ms – the period of how often to get monitoring statistics in milliseconds, defaults to 1000ms

virtual ~DspsrPipelineMonitor()

Destructor.

inline dspsr_monitoring_stats_t get_current_stats() const

Get the current monitoring statistics.

void start_monitoring()

Start background monitoring.

void stop_monitoring()

Stop background monitoring.

inline bool is_monitoring() const

Check if the monitor is performing background monitoring.