vshl-capabilities:

This API is responsible for brokering capbilities related
messages from voiceagents to apps and vice versa.

Verbs exposed are

navigation/publish
navigation/subscribe
phonecontrol/publish
phonecontrol/subscribe
playbackcontroller/publish
playbackcontroller/subscribe
guiMetadata/publish
guiMetadata/subscribe

This API exposes publish and subscribe methods for all
the speech framework domains/capabilities. For eg. navigation,
phonecontrol etc. This API is used by apps and low level voice
agent binding to subscribe and publish these capability messages
whenever applicable.
This specific commit is for vshl-capabilities API.

Change-Id: I822c2e8589e39574d707a7c199bea91a686dced7
Signed-off-by: Naveen Bobbili  <nbobbili@amazon.com>

1 files changed, 84 insertions, 0 deletions

diff --git a/src/plugins/capabilities/core/include/SubscriberForwarder.h b/src/plugins/capabilities/core/include/SubscriberForwarder.h
new file mode 100644
index 0000000..ac469b3
--- /dev/null
+++ b/src/plugins/capabilities/core/include/SubscriberForwarder.h
@@ -0,0 +1,84 @@
+/*
+ * 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_CAPABILITIES_CORE_SUBSCRIBERFORWARDER_H_
+#define VSHL_CAPABILITIES_CORE_SUBSCRIBERFORWARDER_H_
+
+#include <memory>
+#include <string>
+#include <unordered_map>
+
+#include "interfaces/afb/IAFBApi.h"
+#include "interfaces/capabilities/ICapability.h"
+#include "interfaces/utilities/logging/ILogger.h"
+
+using namespace std;
+
+namespace vshlcapabilities {
+namespace capabilities {
+namespace core {
+/*
+ * This class is responsible for forwarding the messages publishing
+ * to the actual clients using AFB.
+ */
+class SubscriberForwarder {
+public:
+  // Create a SubscriberForwarder.
+  static std::shared_ptr<SubscriberForwarder>
+  create(shared_ptr<vshlcapabilities::common::interfaces::ILogger> logger,
+         shared_ptr<vshlcapabilities::common::interfaces::IAFBApi> afbApi,
+         shared_ptr<vshlcapabilities::common::interfaces::ICapability> capability);
+
+  // Publish a capability message to the actual client.
+  bool forwardMessage(const string action, json_object* payload);
+
+  // Subscribe
+  bool subscribe(vshlcapabilities::common::interfaces::IAFBRequest &request,
+                 const string action);
+
+  // Destructor
+  ~SubscriberForwarder();
+
+private:
+  // Constructor
+  SubscriberForwarder(
+      shared_ptr<vshlcapabilities::common::interfaces::ILogger> logger,
+      shared_ptr<vshlcapabilities::common::interfaces::IAFBApi> afbApi,
+      shared_ptr<vshlcapabilities::common::interfaces::ICapability> capability);
+
+  // Creates both upstream and downstream events
+  void createEvents();
+
+  // Binding API reference
+  shared_ptr<vshlcapabilities::common::interfaces::IAFBApi> mAfbApi;
+
+  // Capability
+  shared_ptr<vshlcapabilities::common::interfaces::ICapability> mCapability;
+
+  // Maps of capability action events to its corresponding Event object.
+  // Event name maps to Action Name
+  unordered_map<string, shared_ptr<common::interfaces::IAFBApi::IAFBEvent>>
+      mUpstreamEventsMap;
+  unordered_map<string, shared_ptr<common::interfaces::IAFBApi::IAFBEvent>>
+      mDownstreamEventsMap;
+
+  // Logger
+  shared_ptr<vshlcapabilities::common::interfaces::ILogger> mLogger;
+};
+
+} // namespace core
+} // namespace capabilities
+} // namespace vshl
+
+#endif // VSHL_CAPABILITIES_CORE_SUBSCRIBERFORWARDER_H_