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::MetricSinkInterface Class Referenceabstract

#include <MetricSinkInterface.h>

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

Public Member Functions

virtual ~MetricSinkInterface ()=default
 
virtual void consumeMetric (std::shared_ptr< MetricEvent > metricEvent)=0
 

Detailed Description

This class provides an interface for metric sinks to consume metrics.

Note
implementations of MetricSinkInterface may not be thread-safe.

Constructor & Destructor Documentation

◆ ~MetricSinkInterface()

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

Destructor.

Member Function Documentation

◆ consumeMetric()

virtual void alexaClientSDK::avsCommon::utils::metrics::MetricSinkInterface::consumeMetric ( std::shared_ptr< MetricEvent metricEvent)
pure virtual

This function allows consumption of a MetricEvent.

Parameters
metricEventis the metricEvent object to be consumed
Returns
true if metric sink consumes metric event successfully false otherwise

Implemented in alexaClientSDK::metrics::implementations::SampleMetricSink, and alexaClientSDK::metrics::implementations::UplMetricSink.


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