MetroCollect  2.3.4
MetroCollect::MetricsControllerDelegate Class Referenceabstract

Abstract delegate of MetricsController. More...

#include <MetricsController.h>

Inheritance diagram for MetroCollect::MetricsControllerDelegate:

Public Member Functions

virtual void metricsContollerCollectedMetricsValues (const MetricsController &metricsController, const MetricsDiffArray &metricsDiff, const MetricsDataArray &previousMetrics, const MetricsDataArray &currentMetrics)=0
 Function called every time the MetricsController has collected new values. More...
 
virtual void metricsContollerCollectedMetricsStats (const MetricsController &metricsController, const MetricsController::MetricsStats &metricsStats)=0
 Function called every time the MetricsController has computed statistics. More...
 
virtual bool metricsContollerShouldStopCollectingMetrics (const MetricsController &metricsController)=0
 Function called after each iteration to ask the delegate whether the controller should stop collecting metrics. More...
 

Detailed Description

Abstract delegate of MetricsController.

Each function is called when the MetricsController has done something of importance

Definition at line 270 of file MetricsController.h.

Member Function Documentation

◆ metricsContollerCollectedMetricsStats()

virtual void MetroCollect::MetricsControllerDelegate::metricsContollerCollectedMetricsStats ( const MetricsController metricsController,
const MetricsController::MetricsStats metricsStats 
)
pure virtual

Function called every time the MetricsController has computed statistics.

Parameters
metricsControllerthe calling MetricsController
metricsStatscomputed statistics

Implemented in SnapInterface::SnapStreamInterface, MetroCollectFile, and MetroCollectStats.

Here is the caller graph for this function:

◆ metricsContollerCollectedMetricsValues()

virtual void MetroCollect::MetricsControllerDelegate::metricsContollerCollectedMetricsValues ( const MetricsController metricsController,
const MetricsDiffArray metricsDiff,
const MetricsDataArray previousMetrics,
const MetricsDataArray currentMetrics 
)
pure virtual

Function called every time the MetricsController has collected new values.

Parameters
metricsControllerthe calling MetricsController
metricsDiffcomputed metrics differences
previousMetricsearlier collected metrics
currentMetricslatest collected metrics

Implemented in SnapInterface::SnapStreamInterface, MetroCollectFile, and MetroCollectStats.

Here is the caller graph for this function:

◆ metricsContollerShouldStopCollectingMetrics()

virtual bool MetroCollect::MetricsControllerDelegate::metricsContollerShouldStopCollectingMetrics ( const MetricsController metricsController)
pure virtual

Function called after each iteration to ask the delegate whether the controller should stop collecting metrics.

Parameters
metricsControllerthe calling MetricsController
Returns
true if the controller should stop
false otherwise

Implemented in SnapInterface::SnapStreamInterface, MetroCollectFile, and MetroCollectStats.

Here is the caller graph for this function:

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