CDI SDK
SDK for transporting chunks of data reliably and with low latency using a polled mode network driver.
Loading...
Searching...
No Matches
MetricsGatherer Class Reference
Inheritance diagram for MetricsGatherer:
MetricsClass

Public Member Functions

 MetricsGatherer ()=delete
 
 MetricsGatherer (const MetricsGathererConfigData *config_ptr)
 
CdiReturnStatus Send (const CloudWatchTransferStats *stats_ptr) override
 
- Public Member Functions inherited from MetricsClass
virtual ~MetricsClass ()
 

Additional Inherited Members

- Static Protected Attributes inherited from MetricsClass
static AwsSdkState s_aws_sdk_state
 This static instance automatically initializes and shuts down the AWS SDK.
 

Detailed Description

Concrete class for publishing CDI SDK metrics to the CDI metrics gathering service.

Constructor & Destructor Documentation

◆ MetricsGatherer() [1/2]

MetricsGatherer::MetricsGatherer ( )
delete

Default constructor which is unavailable.

◆ MetricsGatherer() [2/2]

MetricsGatherer::MetricsGatherer ( const MetricsGathererConfigData * config_ptr)

Constructor.

Parameters
config_ptrPointer to a configuration structure containing the information required for initialization.

Member Function Documentation

◆ Send()

CdiReturnStatus MetricsGatherer::Send ( const CloudWatchTransferStats * stats_ptr)
overridevirtual

Sends the statistics set to the CDI metrics gathering service.

Parameters
stats_ptrAddress of the statistics structure to publish.
Returns
CdiReturnStatus kCdiStatusOk if the statistics were successfully published, kCdiStatusCloudWatchThrottling if the service requires the publication rate to be reduced, or possibly some other value from CdiReturnStatus.

Implements MetricsClass.


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