AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface Class Referenceabstract

#include <MetricRecorderInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~MetricRecorderInterface ()=default
 
virtual void recordMetric (std::shared_ptr< MetricEvent > metricEvent)=0
 

Detailed Description

This class provides an interface for the SDK to record metrics to send to sinks.

Constructor & Destructor Documentation

◆ ~MetricRecorderInterface()

virtual alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface::~MetricRecorderInterface ( )
virtualdefault

Destructor

Member Function Documentation

◆ recordMetric()

virtual void alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface::recordMetric ( std::shared_ptr< MetricEvent metricEvent)
pure virtual

This function is responsible for making sure that metrics is sent to a sink implementation for their consumption of MetricEvent.

Note
implementations of this function should be non-blocking
Parameters
metricEventis the metric event to be recorded

Implemented in alexaClientSDK::metrics::implementations::MetricRecorder, and test::MetricRecorderTest.


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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0