AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
AbstractAVSConnectionManager.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 #ifndef ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_ABSTRACTAVSCONNECTIONMANAGER_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_ABSTRACTAVSCONNECTIONMANAGER_H_
18 
19 #include <memory>
20 #include <mutex>
21 #include <unordered_set>
22 
25 
26 namespace alexaClientSDK {
27 namespace avsCommon {
28 namespace avs {
29 
34 public:
37 
42  std::unordered_set<std::shared_ptr<ConnectionStatusObserverInterface>> observers =
43  std::unordered_set<std::shared_ptr<ConnectionStatusObserverInterface>>());
44 
48  virtual ~AbstractAVSConnectionManager() = default;
49 
52  void addConnectionStatusObserver(std::shared_ptr<ConnectionStatusObserverInterface> observer) override;
53  void removeConnectionStatusObserver(std::shared_ptr<ConnectionStatusObserverInterface> observer) override;
55 
56 protected:
65  const std::vector<avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::EngineConnectionStatus>&
66  engineConnectionStatuses);
67 
72  void notifyObservers(bool avsConnectionStatusChanged);
73 
77  void clearObservers();
78 
80  std::mutex m_mutex;
81 
84 
88 
90  std::vector<ConnectionStatusObserverInterface::EngineConnectionStatus> m_engineConnectionStatuses;
91 
93  std::unordered_set<std::shared_ptr<ConnectionStatusObserverInterface>> m_connectionStatusObservers;
94 };
95 
96 } // namespace avs
97 } // namespace avsCommon
98 } // namespace alexaClientSDK
99 
100 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_ABSTRACTAVSCONNECTIONMANAGER_H_
AbstractAVSConnectionManager(std::unordered_set< std::shared_ptr< ConnectionStatusObserverInterface >> observers=std::unordered_set< std::shared_ptr< ConnectionStatusObserverInterface >>())
Definition: AbstractAVSConnectionManager.cpp:42
void notifyObservers(bool avsConnectionStatusChanged)
Definition: AbstractAVSConnectionManager.cpp:117
Definition: ConnectionStatusObserverInterface.h:31
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...
Definition: AbstractAVSConnectionManager.h:93
Definition: AbstractAVSConnectionManager.h:33
void removeConnectionStatusObserver(std::shared_ptr< ConnectionStatusObserverInterface > observer) override
Definition: AbstractAVSConnectionManager.cpp:86
ConnectionStatusObserverInterface::Status m_avsConnectionStatus
Definition: AbstractAVSConnectionManager.h:87
std::vector< ConnectionStatusObserverInterface::EngineConnectionStatus > m_engineConnectionStatuses
The detailed connection statuses for each engine.
Definition: AbstractAVSConnectionManager.h:90
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
void addConnectionStatusObserver(std::shared_ptr< ConnectionStatusObserverInterface > observer) override
Definition: AbstractAVSConnectionManager.cpp:53
ConnectionStatusObserverInterface::Status m_connectionStatus
The current connection status. m_mutex must be acquired before access.
Definition: AbstractAVSConnectionManager.h:83
std::mutex m_mutex
Mutex to protect access to data members.
Definition: AbstractAVSConnectionManager.h:80
void updateConnectionStatus(ConnectionStatusObserverInterface::Status status, const std::vector< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::EngineConnectionStatus > &engineConnectionStatuses)
Definition: AbstractAVSConnectionManager.cpp:97
void clearObservers()
Definition: AbstractAVSConnectionManager.cpp:147
Status
Definition: ConnectionStatusObserverInterface.h:36

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