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

#include <MessageRouterObserverInterface.h>

Inheritance diagram for alexaClientSDK::acl::MessageRouterObserverInterface:
Inheritance graph

Public Member Functions

virtual ~MessageRouterObserverInterface ()=default
virtual void onConnectionStatusChanged (const avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::Status status, const std::vector< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::EngineConnectionStatus > &engineStatuses)=0
virtual void receive (const std::string &contextId, const std::string &message)=0

Detailed Description

This interface class allows notifications from a MessageRouter object (or any derived class), while not adding to the observer's public interface. This is achieved by a friend relationship. The MessageRouterObserverInterface will be notified when either the connection status changes, or when a message arrives from AVS.

Constructor & Destructor Documentation

◆ ~MessageRouterObserverInterface()

virtual alexaClientSDK::acl::MessageRouterObserverInterface::~MessageRouterObserverInterface ( )


Member Function Documentation

◆ onConnectionStatusChanged()

virtual void alexaClientSDK::acl::MessageRouterObserverInterface::onConnectionStatusChanged ( const avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::Status  status,
const std::vector< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::EngineConnectionStatus > &  engineStatuses 
pure virtual

This function will be called when the connection status changes.

statusThe current status of the connection.
engineStatusesstatus of observed engine(s)

◆ receive()

virtual void alexaClientSDK::acl::MessageRouterObserverInterface::receive ( const std::string &  contextId,
const std::string &  message 
pure virtual

This function will be called when a Message arrives from AVS.

contextIdThe contextId of the AVS message, which is used when acquiring attachments.
messageThe AVS message that has been received.

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

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