AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::capabilityAgents::system::test::MockConnection Class Reference
Inheritance diagram for alexaClientSDK::capabilityAgents::system::test::MockConnection:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::capabilityAgents::system::test::MockConnection:
Collaboration graph
[legend]

Public Member Functions

 MockConnection ()
 
 MOCK_METHOD0 (enable, void())
 
 MOCK_METHOD0 (disable, void())
 
 MOCK_METHOD0 (isEnabled, bool())
 
 MOCK_METHOD0 (reconnect, void())
 
 MOCK_METHOD0 (onWakeConnectionRetry, void())
 
 MOCK_METHOD0 (onWakeVerifyConnectivity, void())
 
 MOCK_METHOD1 (addMessageObserver, void(std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface > observer))
 
 MOCK_METHOD1 (removeMessageObserver, void(std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface > observer))
 
 MOCK_METHOD1 (sendMessage, void(std::shared_ptr< avsCommon::avs::MessageRequest > request))
 
 MOCK_METHOD1 (setAVSGateway, void(const std::string &avsGateway))
 
 MOCK_CONST_METHOD0 (getAVSGateway, std::string())
 
bool isConnected () const
 
void updateConnectionStatus (ConnectionStatusObserverInterface::Status status, ConnectionStatusObserverInterface::ChangedReason reason)
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::avs::AbstractAVSConnectionManager
 AbstractAVSConnectionManager (std::unordered_set< std::shared_ptr< ConnectionStatusObserverInterface >> observers=std::unordered_set< std::shared_ptr< ConnectionStatusObserverInterface >>())
 
virtual ~AbstractAVSConnectionManager ()=default
 
void addConnectionStatusObserver (std::shared_ptr< ConnectionStatusObserverInterface > observer) override
 
void removeConnectionStatusObserver (std::shared_ptr< ConnectionStatusObserverInterface > observer) override
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AVSConnectionManagerInterface
virtual ~AVSConnectionManagerInterface ()=default
 
virtual void enable ()=0
 
virtual void disable ()=0
 
virtual bool isEnabled ()=0
 
virtual void reconnect ()=0
 
virtual void onWakeConnectionRetry ()=0
 
virtual void addMessageObserver (std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface > observer)=0
 
virtual void removeMessageObserver (std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface > observer)=0
 
virtual void addConnectionStatusObserver (std::shared_ptr< ConnectionStatusObserverInterface > observer)=0
 
virtual void removeConnectionStatusObserver (std::shared_ptr< ConnectionStatusObserverInterface > observer)=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::MessageSenderInterface
virtual ~MessageSenderInterface ()=default
 Destructor. More...
 
virtual void sendMessage (std::shared_ptr< avs::MessageRequest > request)=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AVSGatewayAssignerInterface
virtual ~AVSGatewayAssignerInterface ()=default
 Destructor. More...
 
virtual void setAVSGateway (const std::string &avsGateway)=0
 
virtual std::string getAVSGateway () const =0
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::avsCommon::avs::AbstractAVSConnectionManager
using ConnectionStatusObserverInterface = avsCommon::sdkInterfaces::ConnectionStatusObserverInterface
 Type alias for brevity. More...
 
- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::AVSConnectionManagerInterface
using ConnectionStatusObserverInterface = avsCommon::sdkInterfaces::ConnectionStatusObserverInterface
 Type alias for brevity. More...
 
- Protected Member Functions inherited from alexaClientSDK::avsCommon::avs::AbstractAVSConnectionManager
void updateConnectionStatus (ConnectionStatusObserverInterface::Status status, const std::vector< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::EngineConnectionStatus > &engineConnectionStatuses)
 
void notifyObservers (bool avsConnectionStatusChanged)
 
void clearObservers ()
 
- Protected Attributes inherited from alexaClientSDK::avsCommon::avs::AbstractAVSConnectionManager
std::mutex m_mutex
 Mutex to protect access to data members. More...
 
ConnectionStatusObserverInterface::Status m_connectionStatus
 The current connection status. m_mutex must be acquired before access. More...
 
ConnectionStatusObserverInterface::Status m_avsConnectionStatus
 
std::vector< ConnectionStatusObserverInterface::EngineConnectionStatusm_engineConnectionStatuses
 The detailed connection statuses for each engine. More...
 
std::unordered_set< std::shared_ptr< ConnectionStatusObserverInterface > > m_connectionStatusObservers
 Set of observers to notify when the connection status changes. m_mutex must be acquired before access. More...
 

Detailed Description

Class with which to mock a connection ot AVS.

Constructor & Destructor Documentation

◆ MockConnection()

alexaClientSDK::capabilityAgents::system::test::MockConnection::MockConnection ( )

Member Function Documentation

◆ isConnected()

bool alexaClientSDK::capabilityAgents::system::test::MockConnection::isConnected ( ) const
virtual

Returns whether the AVS connection is established. If the connection is pending, false will be returned.

Returns
Whether the AVS connection is established.

Implements alexaClientSDK::avsCommon::sdkInterfaces::AVSConnectionManagerInterface.

◆ MOCK_CONST_METHOD0()

alexaClientSDK::capabilityAgents::system::test::MockConnection::MOCK_CONST_METHOD0 ( getAVSGateway  ,
std::string()   
)

◆ MOCK_METHOD0() [1/6]

alexaClientSDK::capabilityAgents::system::test::MockConnection::MOCK_METHOD0 ( enable  ,
void()   
)

◆ MOCK_METHOD0() [2/6]

alexaClientSDK::capabilityAgents::system::test::MockConnection::MOCK_METHOD0 ( disable  ,
void()   
)

◆ MOCK_METHOD0() [3/6]

alexaClientSDK::capabilityAgents::system::test::MockConnection::MOCK_METHOD0 ( isEnabled  ,
bool()   
)

◆ MOCK_METHOD0() [4/6]

alexaClientSDK::capabilityAgents::system::test::MockConnection::MOCK_METHOD0 ( reconnect  ,
void()   
)

◆ MOCK_METHOD0() [5/6]

alexaClientSDK::capabilityAgents::system::test::MockConnection::MOCK_METHOD0 ( onWakeConnectionRetry  ,
void()   
)

◆ MOCK_METHOD0() [6/6]

alexaClientSDK::capabilityAgents::system::test::MockConnection::MOCK_METHOD0 ( onWakeVerifyConnectivity  ,
void()   
)

◆ MOCK_METHOD1() [1/4]

alexaClientSDK::capabilityAgents::system::test::MockConnection::MOCK_METHOD1 ( addMessageObserver  ,
void(std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface > observer)   
)

◆ MOCK_METHOD1() [2/4]

alexaClientSDK::capabilityAgents::system::test::MockConnection::MOCK_METHOD1 ( removeMessageObserver  ,
void(std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface > observer)   
)

◆ MOCK_METHOD1() [3/4]

alexaClientSDK::capabilityAgents::system::test::MockConnection::MOCK_METHOD1 ( sendMessage  ,
void(std::shared_ptr< avsCommon::avs::MessageRequest > request)   
)

◆ MOCK_METHOD1() [4/4]

alexaClientSDK::capabilityAgents::system::test::MockConnection::MOCK_METHOD1 ( setAVSGateway  ,
void(const std::string &avsGateway)   
)

◆ updateConnectionStatus()

void alexaClientSDK::capabilityAgents::system::test::MockConnection::updateConnectionStatus ( ConnectionStatusObserverInterface::Status  status,
ConnectionStatusObserverInterface::ChangedReason  reason 
)

Update the connection status.

Parameters
statusThe Connection Status.
reasonThe reason the Connection Status changed.

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