1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/*
* Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0/
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
#ifndef VSHL_VOICEAGENTS_INCLUDE_VOICEAGENTS_H_
#define VSHL_VOICEAGENTS_INCLUDE_VOICEAGENTS_H_
#include <memory>
#include <set>
#include <unordered_map>
#include <unordered_set>
#include "interfaces/afb/IAFBApi.h"
#include "interfaces/utilities/events/IEventFilter.h"
#include "interfaces/utilities/logging/ILogger.h"
#include "interfaces/voiceagents/IVoiceAgent.h"
#include "interfaces/voiceagents/IVoiceAgentsChangeObserver.h"
#include "voiceagents/include/VoiceAgent.h"
#include "voiceagents/include/VoiceAgentEventsHandler.h"
namespace vshlcore {
namespace voiceagents {
/*
* This class implements the data model for voiceagents.
* Supports add, remove and query operations on voiceagent data.
* Notifies the observers of the changes in the voiceagents data model.
*/
class VoiceAgentsDataManager {
public:
// Create a VoiceAgentsDataManager.
static std::unique_ptr<VoiceAgentsDataManager> create(
shared_ptr<vshlcore::common::interfaces::ILogger> logger,
shared_ptr<vshlcore::common::interfaces::IAFBApi> afbApi);
/**
* Activates the list of voiceagents.
*
* @return Number of activated agents
*/
uint32_t activateVoiceAgents(const unordered_set<string>& activeVoiceAgentIds);
/**
* Deactivates the list of voiceagents.
*
* @return Number of de-activated agents
*/
uint32_t deactivateVoiceAgents(const unordered_set<string>& inactiveVoiceAgentIds);
// Sets the default voiceagent.
bool setDefaultVoiceAgent(const string& voiceAgentId);
// Sets the default voiceagent.
std::string getDefaultVoiceAgent();
// Sets the active wakeword for the voiceagent.
bool setActiveWakeWord(const string& voiceAgentId, const string& wakeword);
// Adds a new voiceagent to the cache and also persists the information in a
// database.
// This call would notify all the observers about the new voiceagent addition.
bool addNewVoiceAgent(
const string& id,
const string& name,
const string& description,
const string& api,
const string& vendor,
const string& activeWakeword,
const bool isActive,
const shared_ptr<unordered_set<string>> wakewords);
// Removes the voiceagent from thecache and also from persistent database.
// This call would notify all the observers about the removal of the
// voiceagent.
bool removeVoiceAgent(const string& voiceAgentId);
// Returns the set of all voice agents in @c VoiceAgentsDataManger cache
std::set<std::shared_ptr<vshlcore::common::interfaces::IVoiceAgent>> getAllVoiceAgents();
// Returns the event filter that belongs to the core module.
shared_ptr<vshlcore::common::interfaces::IEventFilter> getEventFilter() const;
// Subscribe to an event coming from the voiceagent.
bool subscribeToVshlEventFromVoiceAgent(
vshlcore::common::interfaces::IAFBRequest& request,
const string eventName,
const string voiceagentId);
// Adds a new voiceagent change observer.
bool addVoiceAgentsChangeObserver(shared_ptr<vshlcore::common::interfaces::IVoiceAgentsChangeObserver> observer);
// Removes the voiceagent change observer from the list.
bool removeVoiceAgentsChangeObserver(shared_ptr<vshlcore::common::interfaces::IVoiceAgentsChangeObserver> observer);
// Destructor
~VoiceAgentsDataManager();
private:
// Constructor
VoiceAgentsDataManager(
shared_ptr<vshlcore::common::interfaces::ILogger> logger,
shared_ptr<vshlcore::common::interfaces::IAFBApi> afbApi);
// Sets the voiceagent ID
bool sendVoiceAgentIdToVA(const shared_ptr<VoiceAgent>& voiceAgent);
// Binding API reference
shared_ptr<vshlcore::common::interfaces::IAFBApi> mAfbApi;
// A list of all the voiceagent change observers
unordered_set<shared_ptr<vshlcore::common::interfaces::IVoiceAgentsChangeObserver>> mVoiceAgentChangeObservers;
// A map of voiceagents grouped by ID
unordered_map<string, shared_ptr<VoiceAgent>> mVoiceAgents;
// Voiceagent event handler.
shared_ptr<VoiceAgentEventsHandler> mVoiceAgentEventsHandler;
// Default voiceagent
string mDefaultVoiceAgentId;
// Logger
shared_ptr<vshlcore::common::interfaces::ILogger> mLogger;
bool mAlreadyPeformedSubscriptions;
};
} // namespace voiceagents
} // namespace vshl
#endif // VSHL_VOICEAGENTS_INCLUDE_VOICEAGENTS_H_
|
