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

#include <TransportObserverInterface.h>

Inheritance diagram for alexaClientSDK::acl::TransportObserverInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~TransportObserverInterface ()=default
 
virtual void onConnected (std::shared_ptr< TransportInterface > transport)=0
 
virtual void onDisconnected (std::shared_ptr< TransportInterface > transport, avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::ChangedReason reason)=0
 
virtual void onServerSideDisconnect (std::shared_ptr< TransportInterface > transport)=0
 

Detailed Description

An interface class which allows a derived class to observe a Transport implementation.

Constructor & Destructor Documentation

◆ ~TransportObserverInterface()

virtual alexaClientSDK::acl::TransportObserverInterface::~TransportObserverInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ onConnected()

virtual void alexaClientSDK::acl::TransportObserverInterface::onConnected ( std::shared_ptr< TransportInterface transport)
pure virtual

Called when a connection to AVS is established.

Parameters
transportThe transport that has connected.

Implemented in alexaClientSDK::acl::MessageRouter.

◆ onDisconnected()

virtual void alexaClientSDK::acl::TransportObserverInterface::onDisconnected ( std::shared_ptr< TransportInterface transport,
avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::ChangedReason  reason 
)
pure virtual

Called when we disconnect from AVS.

Parameters
transportThe transport that is no longer connected (or attempting to connect).
reasonThe reason that we disconnected.

Implemented in alexaClientSDK::acl::MessageRouter.

◆ onServerSideDisconnect()

virtual void alexaClientSDK::acl::TransportObserverInterface::onServerSideDisconnect ( std::shared_ptr< TransportInterface transport)
pure virtual

Called when the server asks the client to reconnect

Parameters
transportThe transport that has received the disconnect request.

Implemented in alexaClientSDK::acl::MessageRouter.


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