AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::metrics::implementations::UplMetricSink Class Reference

#include <UplMetricSink.h>

Inheritance diagram for alexaClientSDK::metrics::implementations::UplMetricSink:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::metrics::implementations::UplMetricSink:
Collaboration graph
[legend]

Public Member Functions

 ~UplMetricSink ()=default
 
Overridden MetricSinkInterface method.
void consumeMetric (std::shared_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricEvent > metricEvent) override
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::utils::metrics::MetricSinkInterface
virtual ~MetricSinkInterface ()=default
 

Static Public Member Functions

static std::unique_ptr< avsCommon::utils::metrics::MetricSinkInterfacecreateMetricSinkInterface (std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder)
 

Detailed Description

This class implements a metric sink that inspects each incoming metric with SampleUplCalculator.

Constructor & Destructor Documentation

◆ ~UplMetricSink()

alexaClientSDK::metrics::implementations::UplMetricSink::~UplMetricSink ( )
default

Destructor

Member Function Documentation

◆ consumeMetric()

void alexaClientSDK::metrics::implementations::UplMetricSink::consumeMetric ( std::shared_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricEvent metricEvent)
overridevirtual

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

Implements alexaClientSDK::avsCommon::utils::metrics::MetricSinkInterface.

◆ createMetricSinkInterface()

static std::unique_ptr<avsCommon::utils::metrics::MetricSinkInterface> alexaClientSDK::metrics::implementations::UplMetricSink::createMetricSinkInterface ( std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface metricRecorder)
static

Create a UplMetricSink.

Parameters
metricRecorderis the MetricRecorder object to publish UPL metrics to.
Returns
A 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