ActionInterface.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2024, EPFL/Blue Brain Project
 *
 * Responsible Author: Daniel.Nachbaur@epfl.ch
 *
 * This file is part of Blue Brain BioExplorer <https://github.com/BlueBrain/BioExplorer>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <platform/core/common/Types.h>
 
#include <functional>
#include <string>
 
namespace core
{
class ActionInterface
{
public:
    virtual ~ActionInterface() = default;
 
    virtual void registerNotification(const RpcDescription& desc, const std::function<void()>& action) = 0;
 
    virtual void registerNotification(const RpcParameterDescription& desc, const PropertyMap& input,
                                      const std::function<void(PropertyMap)>& action) = 0;
 
    virtual void registerRequest(const RpcParameterDescription& desc, const PropertyMap& input,
                                 const PropertyMap& output, const std::function<PropertyMap(PropertyMap)>& action) = 0;
 
    virtual void registerRequest(const RpcDescription& desc, const PropertyMap& output,
                                 const std::function<PropertyMap()>& action) = 0;
 
    void registerNotification(const std::string& name, const std::function<void()>& action)
    {
        _registerNotification(name, [action] { action(); });
    }
 
    template <typename Params>
    void registerNotification(const std::string& name, const std::function<void(Params)>& action)
    {
        _registerNotification(name, [action](const std::string& param) {
            Params params;
            if (!from_json(params, param))
                throw std::runtime_error("from_json failed");
            action(params);
        });
    }
 
    template <typename Params, typename RetVal>
    void registerRequest(const std::string& name, const std::function<RetVal(Params)>& action)
    {
        _registerRequest(name, [action](const std::string& param) {
            Params params;
            if (!from_json(params, param))
                throw std::runtime_error("from_json failed");
            return to_json(action(params));
        });
    }
 
    template <typename RetVal>
    void registerRequest(const std::string& name, const std::function<RetVal()>& action)
    {
        _registerRequest(name, [action] { return to_json(action()); });
    }
 
protected:
    using RetParamFunc = std::function<std::string(std::string)>;
    using RetFunc = std::function<std::string()>;
    using ParamFunc = std::function<void(std::string)>;
    using VoidFunc = std::function<void()>;
 
private:
    virtual void _registerRequest(const std::string&, const RetParamFunc&) {}
    virtual void _registerRequest(const std::string&, const RetFunc&) {}
    virtual void _registerNotification(const std::string&, const ParamFunc&) {}
    virtual void _registerNotification(const std::string&, const VoidFunc&) {}
};
} // namespace core