requestor.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_ocm_serverctl
 * @copyright ESO - European Southern Observatory
 *
 * @brief
 */
#ifndef OCF_OCM_SERVERCTL_REQUESTOR_HPP_
#define OCF_OCM_SERVERCTL_REQUESTOR_HPP_
 
#include <iostream>
#include <type_traits>
#include <unordered_map>
#include <vector>
 
#include <boost/asio/io_service.hpp>
#include <boost/program_options.hpp>
 
#include <Stdif.hpp>
#include <Ocmif.hpp>
#include <rad/logger.hpp>
 
std::ostream& operator<<(std::ostream& os, std::shared_ptr<ocmif::DaqStatus> const& s);
std::ostream& operator<<(std::ostream& os, std::shared_ptr<ocmif::DaqReply> const& s);
std::ostream& operator<<(std::ostream& os, std::vector<std::shared_ptr<ocmif::DaqStatus>> const& s);
std::ostream& operator<<(std::ostream& os, std::vector<std::shared_ptr<ocmif::AwaitDaqReply>> const& s);
 
template <class T>
struct JsonPrint {
    JsonPrint(T const& t_arg) : t(t_arg) {}
    T const& t;
};
 
std::ostream& operator<<(std::ostream& os, JsonPrint<std::shared_ptr<ocmif::DaqStatus>> const& s);
std::ostream& operator<<(std::ostream& os, JsonPrint<std::shared_ptr<ocmif::DaqReply>> const& s);
std::ostream& operator<<(std::ostream& os, JsonPrint<std::shared_ptr<ocmif::AwaitDaqReply>> const& s);
std::ostream& operator<<(std::ostream& os, JsonPrint<std::string> const& s);
std::ostream& operator<<(std::ostream& os, JsonPrint<std::vector<std::shared_ptr<ocmif::DaqStatus>>> const& s);
 
struct CommonArgs {
    bool json;
    unsigned timeout;
    std::string req_addr;
    std::string pub_addr;
    elt::mal::Mal* mal;
 
    CommonArgs() = default;
    CommonArgs(CommonArgs const&) = delete;
    CommonArgs& operator=(CommonArgs const&) = delete;
};
 
struct Requestor {
    explicit Requestor(CommonArgs& args);
    virtual ~Requestor() {
    }
    virtual std::string Synopsis();
    /**
     * Add arguments to command.
     */
    virtual void AddOptions(boost::program_options::options_description& descr);
    /**
     * Receives a parsed variables_map that include the options added with AddOptions.
     */
    virtual void Handle(::stdif::StdCmdsSync& std_cmds,
                        ::ocmif::OcmDaqSync& daq_cmds,
                        boost::program_options::variables_map& vm,
                        std::vector<std::string>& opts) = 0;
 
protected:
    CommonArgs& m_args;
};
 
struct SetLogLevelRequestor : Requestor {
    using Requestor::Requestor;
    virtual std::string Synopsis() override;
    virtual void Handle(::stdif::StdCmdsSync& std_cmds,
                        ::ocmif::OcmDaqSync& daq_cmds,
                        boost::program_options::variables_map& vm,
                        std::vector<std::string>& opts) override;
};
 
/**
 * Simple requestor for commands without argument
 *
 * @tparam Func is either a StdCmdsSync or OcmDaqSync member function pointer, taking no arguments
 * and returning a type that has an ostream << operator:
 * E.g.: `using Func = decltype(&ocmif::StdCmds::Enable)`;
 */
template <class Func>
struct SimpleRequestor : Requestor {
    SimpleRequestor(Func func, CommonArgs& args) : Requestor(args), m_func(func) {
    }
    void Handle(::stdif::StdCmdsSync& std_cmds,
                ::ocmif::OcmDaqSync& daq_cmds,
                boost::program_options::variables_map& vm,
                std::vector<std::string>& opts) override {
        if constexpr (std::is_invocable_v<Func, decltype(std_cmds)>) {
            auto reply = (std_cmds.*m_func)();
            if (m_args.json) {
                std::cout << JsonPrint(reply);
            } else {
                std::cout << "Reply: " << reply << std::endl;
            }
        } else if constexpr (std::is_invocable_v<Func, decltype(daq_cmds)>) {
            auto reply = (daq_cmds.*m_func)();
            if (m_args.json) {
                std::cout << JsonPrint(reply);
            } else {
                std::cout << "Reply: " << reply << std::endl;
            }
        } else {
        }
    }
 
    Func m_func;
};
 
/**
 * Simple Daq commands that accepts a single argument `id` and returns a shared_ptr type
 * that can be formatted with ostream<< operator when dereferenced.
 */
template <class Func>
struct SimpleDaqRequestor : Requestor {
    SimpleDaqRequestor(Func func, CommonArgs& args) : Requestor(args), m_func(func) {
    }
 
    std::string Synopsis() override {
        return "<id>";
    }
 
    void Handle(::stdif::StdCmdsSync& std_cmds,
                ::ocmif::OcmDaqSync& daq_cmds,
                boost::program_options::variables_map& vm,
                std::vector<std::string>& opts) override {
        if (opts.size() != 2) {
            throw std::invalid_argument("command requires the `id` argument");
        }
        auto reply = (daq_cmds.*m_func)(opts[1]);
        if (m_args.json) {
            std::cout << JsonPrint(reply);
        } else {
            std::cout << "Reply: " << reply << std::endl;
        }
    }
 
    Func m_func;
};
 
 
template <class Func>
struct NoArgRequestor : Requestor {
    NoArgRequestor(Func func, CommonArgs& args) : Requestor(args), m_func(func) {
    }
 
    void Handle(::stdif::StdCmdsSync& std_cmds,
                ::ocmif::OcmDaqSync& daq_cmds,
                boost::program_options::variables_map& vm,
                std::vector<std::string>& opts) override {
        auto reply = (daq_cmds.*m_func)();
        if (m_args.json) {
            std::cout << JsonPrint(reply);
        } else {
            std::cout << "Reply: " << reply << std::endl;
        }
    }
 
    Func m_func;
};
 
struct StartDaqRequestor : Requestor {
    std::string m_id;
    std::string m_prefix;
    std::string m_primary_sources;
    std::string m_metadata_sources;
    std::string m_properties;
 
    using Requestor::Requestor;
 
    std::string Synopsis() override;
    void AddOptions(boost::program_options::options_description& descr) override;
    void Handle(::stdif::StdCmdsSync& std_cmds,
                ::ocmif::OcmDaqSync& daq_cmds,
                boost::program_options::variables_map& vm,
                std::vector<std::string>& opts) override;
};
 
struct UpdateKeywordsRequestor : Requestor {
    using Requestor::Requestor;
 
    std::string Synopsis() override;
    void AddOptions(boost::program_options::options_description& descr) override;
    void Handle(::stdif::StdCmdsSync& std_cmds,
                ::ocmif::OcmDaqSync& daq_cmds,
                boost::program_options::variables_map& vm,
                std::vector<std::string>& opts) override;
};
 
struct AwaitStateRequestor : Requestor {
    using Requestor::Requestor;
 
    std::string Synopsis() override;
    void AddOptions(boost::program_options::options_description& descr) override;
    void Handle(::stdif::StdCmdsSync& std_cmds,
                ::ocmif::OcmDaqSync& daq_cmds,
                boost::program_options::variables_map& vm,
                std::vector<std::string>& opts) override;
};
 
#endif  // #ifndef OCF_OCM_SERVERCTL_REQUESTOR_HPP_