IPCRouter.h

Go to the documentation of this file.

/*
 * Copyright 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 ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_IPC_IPCROUTER_H_
#define ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_IPC_IPCROUTER_H_

#include <memory>
#include <mutex>
#include <string>
#include <unordered_map>

#include <AVSCommon/Utils/Optional.h>
#include <AVSCommon/Utils/Threading/Executor.h>
#include <AVSCommon/Utils/RequiresShutdown.h>

#include <Communication/MessageListenerInterface.h>
#include <Communication/MessagingServerInterface.h>

#include "IPCServerSampleApp/IPC/IPCDispatcherInterface.h"
#include "IPCServerSampleApp/IPC/IPCHandlerRegistrationInterface.h"
#include "IPCServerSampleApp/IPC/IPCHandlerBase.h"
#include "IPCServerSampleApp/IPC/IPCVersionManager.h"

namespace alexaClientSDK {
namespace sampleApplications {
namespace ipcServerSampleApp {
namespace ipc {

class IPCRouter
        : public IPCHandlerRegistrationInterface
        , public alexaClientSDK::avsCommon::utils::RequiresShutdown {
public:
    static std::shared_ptr<IPCRouter> create(
        std::shared_ptr<communication::MessagingServerInterface> messagingServer,
        std::shared_ptr<IPCDispatcherInterface> ipcDispatcher,
        std::shared_ptr<IPCVersionManager> ipcVersionManager);

    void onMessage(const std::string& message);

    std::shared_ptr<IPCDispatcherInterface> registerHandler(
        const std::string& ipcNamespace,
        std::weak_ptr<IPCHandlerBase> handler) override;
    bool deregisterHandler(const std::string& ipcNamespace) override;

    void doShutdown() override;

private:
    struct HandlerInstance {
        const std::string& ipcNamespace;
        std::weak_ptr<IPCHandlerBase> handler;
    };

    IPCRouter(
        std::shared_ptr<communication::MessagingServerInterface> messagingServer,
        std::shared_ptr<IPCDispatcherInterface> ipcDispatcher,
        const std::shared_ptr<IPCVersionManager> ipcVersionManager);

    std::shared_ptr<IPCHandlerBase> getHandlerRegisteredLocked(const std::string& ipcNamespace);

    std::unordered_map<std::string, HandlerInstance> m_handlerMap;

    std::shared_ptr<communication::MessagingServerInterface> m_messagingServer;

    std::shared_ptr<communication::MessageListenerInterface> m_messageListener;

    std::shared_ptr<IPCVersionManager> m_ipcVersionManager;

    std::shared_ptr<IPCDispatcherInterface> m_ipcDispatcher;

    std::mutex m_mutex;
};

}  // namespace ipc
}  // namespace ipcServerSampleApp
}  // namespace sampleApplications
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_IPC_IPCROUTER_H_