summaryrefslogtreecommitdiffstats
path: root/src/plugins/voiceagents/include/VoiceAgentEventsHandler.h
diff options
context:
space:
mode:
authorNaveen Bobbili <nbobbili@amazon.com>2018-11-12 16:12:38 -0800
committerNaveen Bobbili <nbobbili@amazon.com>2018-11-13 15:05:41 -0800
commitb6abca2edcb36c0c0848d1cd8dc291f23293aa80 (patch)
treea838812e0b66f0695cb6cf0f8bebfa38315ce8b8 /src/plugins/voiceagents/include/VoiceAgentEventsHandler.h
parentbe70712f89eacd20dca413bcce46e4aa26b5709e (diff)
SPEC-1924: AGL Speech Framework's Voice Service High Level 1.0 Release.
Details: 1) Control plugin implementation for VSHL 1.0 2) Exposed APIs that are documented in the confluence page https://confluence.automotivelinux.org/display/SPE/Speech+EG+Architecture 3) Implemented 39 unit tests based on GTest framework to test all the low level components of VSHL binding. 4) Implemented a HTML5 based VSHL API tester application to test VSHL APIs. API specification: https://confluence.automotivelinux.org/display/SPE/Speech+EG+Architecture#SpeechEGArchitecture-HighLevelVoiceService Test performed: 1) Tested AGL service running Alexa Auto SDK https://github.com/alexa/aac-sdk on Ubuntu 16.04 and Renesas R-Car M3 board. License: Apache 2.0 Developers/Owners: Naveen Bobbili (nbobbili@amazon.com) Prakash Buddhiraja (buddhip@amazon.com) Shotaro Uchida (shotaru@amazon.co.jp) Change-Id: I3370f4ad65aff030f24f4ad571fb02d525bbfbca Signed-off-by: Naveen Bobbili <nbobbili@amazon.com>
Diffstat (limited to 'src/plugins/voiceagents/include/VoiceAgentEventsHandler.h')
-rw-r--r--src/plugins/voiceagents/include/VoiceAgentEventsHandler.h95
1 files changed, 95 insertions, 0 deletions
diff --git a/src/plugins/voiceagents/include/VoiceAgentEventsHandler.h b/src/plugins/voiceagents/include/VoiceAgentEventsHandler.h
new file mode 100644
index 0000000..3c1ca6c
--- /dev/null
+++ b/src/plugins/voiceagents/include/VoiceAgentEventsHandler.h
@@ -0,0 +1,95 @@
+/*
+ * 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_VOICEAGENTSTATE_EVENT_HANDLER_H_
+#define VSHL_VOICEAGENTS_INCLUDE_VOICEAGENTSTATE_EVENT_HANDLER_H_
+
+#include <algorithm>
+#include <memory>
+#include <unordered_map>
+
+#include "interfaces/afb/IAFBApi.h"
+#include "interfaces/utilities/events/IEventFilter.h"
+#include "interfaces/utilities/logging/ILogger.h"
+#include "voiceagents/VoiceAgentEventNames.h"
+#include "voiceagents/include/VoiceAgent.h"
+
+using namespace std;
+
+namespace vshl {
+namespace voiceagents {
+/*
+ * This class is reponsible for handling agent specific events
+ * subscription and delivery on behalf of the high level voice service.
+ * This class also listen to the incoming events from voice agents
+ * and implements propagation to application layer.
+ */
+class VoiceAgentEventsHandler : public vshl::common::interfaces::IEventFilter {
+public:
+ // Create a VREventFilter.
+ static shared_ptr<VoiceAgentEventsHandler> create(
+ shared_ptr<vshl::common::interfaces::ILogger> logger,
+ shared_ptr<vshl::common::interfaces::IAFBApi> afbApi);
+
+ // Creates all the vshl events for a specific voiceagent id.
+ // For e.g if voiceagent is VA-001 then a new vshl event
+ // voice_authstate_event#VA-001 for auth state will be created.
+ // Please see VoiceAgentEventNames.h for all the event names.
+ void createVshlEventsForVoiceAgent(const string voiceAgentId);
+
+ // Removes the events from its bookkeeping.
+ void removeVshlEventsForVoiceAgent(const string voiceAgentId);
+
+ // Subscribe to a vshl event corresponding to a voiceagent.
+ bool subscribeToVshlEventFromVoiceAgent(
+ vshl::common::interfaces::IAFBRequest& request,
+ const string eventName,
+ const shared_ptr<VoiceAgent> voiceAgent);
+
+ ~VoiceAgentEventsHandler();
+
+protected:
+ string getName() override;
+
+ // IEventFilter override
+ bool onIncomingEvent(const string eventName, const string voiceAgentId, const string payload) override;
+
+private:
+ // Constructor
+ VoiceAgentEventsHandler(
+ shared_ptr<vshl::common::interfaces::ILogger> logger,
+ shared_ptr<vshl::common::interfaces::IAFBApi> afbApi);
+
+ // Helper method to generate the event name with voiceagent Id
+ // concatenated.
+ string createEventNameWithVAId(string eventName, string voiceAgentId);
+
+ // call subscribe verb on the voiceagent. True if subscription successful.
+ // False otherwise.
+ bool callSubscribeVerb(const shared_ptr<VoiceAgent> voiceAgent);
+
+ // Binding API reference
+ shared_ptr<vshl::common::interfaces::IAFBApi> mAfbApi;
+
+ // A map of VSHL event ID to its Event object
+ unordered_map<string, shared_ptr<common::interfaces::IAFBApi::IAFBEvent>> mEventsMap;
+
+ // Logger
+ shared_ptr<vshl::common::interfaces::ILogger> mLogger;
+};
+
+} // namespace voiceagents
+} // namespace vshl
+
+#endif // VSHL_VOICEAGENTS_INCLUDE_VOICEAGENTSTATE_EVENT_HANDLER_H_