AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
IPCHandlerBase.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_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_IPC_IPCHANDLERBASE_H_
17 #define ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_IPC_IPCHANDLERBASE_H_
18 
19 #include <memory>
20 #include <string>
21 #include <unordered_map>
22 
24 
25 namespace alexaClientSDK {
26 namespace sampleApplications {
27 namespace ipcServerSampleApp {
28 namespace ipc {
29 
34 public:
40  void invokeMethod(const std::string& methodName, const std::string& message);
41 
43  using IPCMessageHandler = std::function<void(const std::string&)>;
44 
49 
50 protected:
58  const std::string& namespaceName,
59  std::shared_ptr<alexaClientSDK::avsCommon::utils::threading::Executor> executor);
60 
68  bool registerIPCMessageHandlerMethod(const std::string& methodName, IPCMessageHandler handlerFunction);
69 
76  bool deregisterIPCMessageHandlerMethod(const std::string& methodName);
77 
80 
82  std::unordered_map<std::string, IPCMessageHandler> m_messageHandlers;
83 
85  std::shared_ptr<alexaClientSDK::avsCommon::utils::threading::Executor> m_executor;
86 };
87 
88 } // namespace ipc
89 } // namespace ipcServerSampleApp
90 } // namespace sampleApplications
91 } // namespace alexaClientSDK
92 
93 #endif // ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_IPC_IPCHANDLERBASE_H_
std::shared_ptr< alexaClientSDK::avsCommon::utils::threading::Executor > m_executor
Executor context to support operations asynchronously.
Definition: IPCHandlerBase.h:85
std::unordered_map< std::string, IPCMessageHandler > m_messageHandlers
Dictionary to hold the IPC message handler methods.
Definition: IPCHandlerBase.h:82
void invokeMethod(const std::string &methodName, const std::string &message)
::std::string string
Definition: gtest-port.h:1097
std::function< void(const std::string &)> IPCMessageHandler
Alias for the message handler function.
Definition: IPCHandlerBase.h:43
bool registerIPCMessageHandlerMethod(const std::string &methodName, IPCMessageHandler handlerFunction)
IPCHandlerBase(const std::string &namespaceName, std::shared_ptr< alexaClientSDK::avsCommon::utils::threading::Executor > executor)
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
std::string m_namespaceName
Name of the namespace of the realized IPC handler class.
Definition: IPCHandlerBase.h:79
tuple message
Definition: gtest_output_test.py:331

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