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, 82 insertions, 0 deletions

diff --git a/src/plugins/capabilities/CapabilityMessagingService.h b/src/plugins/capabilities/CapabilityMessagingService.h
new file mode 100644
index 0000000..79edfa8
--- /dev/null
+++ b/src/plugins/capabilities/CapabilityMessagingService.h
@@ -0,0 +1,82 @@
+/*
+ * 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_CAPABILITYMESSAGINGSERVICE_H_
+#define VSHL_CAPABILITIES_CAPABILITYMESSAGINGSERVICE_H_
+
+#include <memory>
+#include <string>
+#include <unordered_map>
+
+#include "capabilities/core/include/MessageChannel.h"
+#include "interfaces/afb/IAFBApi.h"
+#include "interfaces/capabilities/ICapability.h"
+#include "interfaces/utilities/logging/ILogger.h"
+
+using namespace std;
+
+namespace vshlcapabilities {
+namespace capabilities {
+/*
+ * This hosts service APIs that clients can use to subscribe and
+ * forward capability messages. Each capability has a name and
+ * direction (upstream/downstream). Upstream messages are from
+ * voiceagents to Apps and downstream messages are Apps to voiceagents.
+ * This class will use a factory to create publisher and subcribers for
+ * each capability and create assiociations between them.
+ */
+class CapabilityMessagingService {
+public:
+  // Create a CapabilityMessagingService.
+  static std::unique_ptr<CapabilityMessagingService>
+  create(shared_ptr<vshlcapabilities::common::interfaces::ILogger> logger,
+         shared_ptr<vshlcapabilities::common::interfaces::IAFBApi> afbApi);
+
+  // Subscribe to capability specific messages.
+  bool subscribe(vshlcapabilities::common::interfaces::IAFBRequest &request,
+                 shared_ptr<common::interfaces::ICapability> capability,
+                 const string action);
+
+  // Publish capability messages.
+  bool publish(shared_ptr<common::interfaces::ICapability> capability,
+               const string action, json_object* payload);
+
+  // Destructor
+  ~CapabilityMessagingService();
+
+private:
+  // Constructor
+  CapabilityMessagingService(
+      shared_ptr<vshlcapabilities::common::interfaces::ILogger> logger,
+      shared_ptr<vshlcapabilities::common::interfaces::IAFBApi> afbApi);
+
+  // Binding API reference
+  shared_ptr<vshlcapabilities::common::interfaces::IAFBApi> mAfbApi;
+
+  // Create a message channel for the capability.
+  shared_ptr<vshlcapabilities::capabilities::core::MessageChannel>
+  getMessageChannel(shared_ptr<common::interfaces::ICapability> capability);
+
+  // Map of capabilities to message channels.
+  unordered_map<string, shared_ptr<vshlcapabilities::capabilities::core::MessageChannel>>
+      mMessageChannelsMap;
+
+  // Logger
+  shared_ptr<vshlcapabilities::common::interfaces::ILogger> mLogger;
+};
+
+} // namespace capabilities
+} // namespace vshl
+
+#endif // VSHL_CAPABILITIES_CAPABILITYMESSAGINGSERVICE_H_