AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterface Class Referenceabstract

#include <ProtocolTracerInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterface:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterface:
Collaboration graph
[legend]

Public Member Functions

virtual ~ProtocolTracerInterface ()=default
 Destructor. More...
 
virtual unsigned int getMaxMessages ()=0
 
virtual bool setMaxMessages (unsigned int limit)=0
 
virtual void setProtocolTraceFlag (bool enabled)=0
 
virtual std::string getProtocolTrace ()=0
 
virtual void clearTracedMessages ()=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::MessageObserverInterface
virtual ~MessageObserverInterface ()=default
 
virtual void receive (const std::string &contextId, const std::string &message)=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::EventTracerInterface
virtual ~EventTracerInterface ()=default
 
virtual void traceEvent (const std::string &messageContent)=0
 

Constructor & Destructor Documentation

◆ ~ProtocolTracerInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterface::~ProtocolTracerInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ clearTracedMessages()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterface::clearTracedMessages ( )
pure virtual

This method acquires a mutex and clears the trace messages that are recorded.

Implemented in alexaClientSDK::diagnostics::DeviceProtocolTracer.

◆ getMaxMessages()

virtual unsigned int alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterface::getMaxMessages ( )
pure virtual

◆ getProtocolTrace()

virtual std::string alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterface::getProtocolTrace ( )
pure virtual

Returns the recorded protocol trace string. Sample output: { "trace" : [ <Directive 1>, <Directive 2>, <Event 1>, <Directive 3> ] }

Returns
the protocol trace as a string.

Implemented in alexaClientSDK::diagnostics::DeviceProtocolTracer.

◆ setMaxMessages()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterface::setMaxMessages ( unsigned int  limit)
pure virtual

Change the max messages that can be stored. If limit is lower than the number of currently stored messages, then this function should fail and leave the limit unchanged.

Parameters
limitThe maximum number of messages that will be stored.
Returns
Whether this function succeeded in changing the limit.

Implemented in alexaClientSDK::diagnostics::DeviceProtocolTracer.

◆ setProtocolTraceFlag()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterface::setProtocolTraceFlag ( bool  enabled)
pure virtual

Set the protocol trace flag.

Parameters
enabledindicating if the flag should be true/false.

Implemented in alexaClientSDK::diagnostics::DeviceProtocolTracer.


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

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