dpmService.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_dpm
 * @copyright (c) Copyright ESO 2022
 * All Rights Reserved
 * ESO (eso.org) is an Intergovernmental Organisation, and therefore special legal conditions apply.
 *
 * @brief daq::dpm::DpmService implements MAL services daqif::DpmControl and daqif::DpmDaqControl.
 */
#ifndef DAQ_DPM_DPMREPLIER_HPP
#define DAQ_DPM_DPMREPLIER_HPP
#include <daq/config.hpp>
 
#include <boost/asio/executor_work_guard.hpp>
#include <boost/asio/signal_set.hpp>
#include <log4cplus/logger.h>
#include <mal/Mal.hpp>
#include <rad/ioExecutor.hpp>
 
#include <Daqif.hpp>
 
#include <daq/dpm/scheduler.hpp>
#include <daq/dpm/workspace.hpp>
#include <daq/state.hpp>
 
namespace daq::dpm {
 
/**
 * daqif::DpmControl and DpmDaqControl implementation.
 *
 * It is mainly responsible for acting as gateway between CII and rest of application.
 *
 * Aspects to consider
 *
 * - "Requests" are method calls from foreign thread -> requires synchronization, typically by
 *   posting to main thread via io_context.
 * - Accept requests and transform CII arguments to application format.
 */
class DpmService : public ::daqif::AsyncDpmControl, public ::daqif::AsyncDpmDaqControl {
public:
    static constexpr char const* LOGGER_NAME = "dpm.replier";
 
    /**
     * Construct replier.
     *
     * @param executor Executor to use, including the native asio::io_context.
     */
    DpmService(rad::IoExecutor& executor,
               elt::mal::Mal& mal,
               Workspace& workspace,
               Scheduler& scheduler);
    /**
     * @name AsyncDpmControl
     */
    /// @{
    boost::future<std::shared_ptr<::daqif::StorageStatus>> QueryStorageStatus() override;
    /**
     * Cancels any started merges and terminates application.
     *
     * @returns future that is set only after all other active operations are cancelled.
     */
    boost::future<std::string> Exit() override;
 
    boost::future<std::string> GetVersion() override;
    /// @}
    /**
     * @name AsyncDpmDaqControl
     */
    /// @{
    boost::future<std::shared_ptr<::daqif::DaqReply>>
    QueueDaq(std::string const& status, std::string const& specification) override;
 
    boost::future<std::shared_ptr<::daqif::DaqReply>> AbortDaq(const std::string& id) override;
 
    boost::future<std::shared_ptr<::daqif::DaqStatus>> GetDaqStatus(const std::string& id) override;
 
    boost::future<std::vector<std::shared_ptr<::daqif::DaqStatus>>> GetActiveDaqs() override;
 
    boost::future<std::string> GetInternalDaqStatus(const std::string& id) override;
    /// @}
 
private:
    void InitiateSignalHandler();
    void HandleExit();
    /**
     * Should only be invoked from main thread.
     */
    std::shared_ptr<daqif::DaqStatus> GetDaqStatusSync(std::string const& id);
 
    rad::IoExecutor& m_executor;
    elt::mal::Mal& m_mal;
    /**
     * @name Must be accessed from main thread via exectuor
     */
    ///@{
    Workspace& m_workspace;
    Scheduler& m_scheduler;
    ///@}
    boost::asio::executor_work_guard<boost::asio::io_context::executor_type> m_work_guard;
    boost::asio::signal_set m_sigset;
    log4cplus::Logger m_logger;
};
 
}  // namespace daq::dpm
 
#endif  // #ifndef DAQ_DPM_DPMREPLIER_HPP