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

Public Member Functions

 UserMetrics ()=delete
 
 UserMetrics (const CdiCloudWatchConfigData *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 CloudWatch metrics service.

Constructor & Destructor Documentation

◆ UserMetrics() [1/2]

UserMetrics::UserMetrics ( )
delete

Default constructor which is unavailable.

◆ UserMetrics() [2/2]

UserMetrics::UserMetrics ( const CdiCloudWatchConfigData * config_ptr)

Constructor. This just creates an instance of the object.

Parameters
config_ptrPointer to configuration data.

Member Function Documentation

◆ Send()

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

Send the specified set of statistics to CloudWatch.

Parameters
stats_ptrPointer to statistics to send.
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: