ocmDaqService.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_ocm
 * @copyright 2022 ESO - European Southern Observatory
 *
 * @brief Declaration of OcmDaqService
 */
#ifndef DAQ_OCM_OCM_DAQ_SERVICE_HPP_
#define DAQ_OCM_OCM_DAQ_SERVICE_HPP_
#include <daq/config.hpp>
#include <rad/ioExecutor.hpp>
 
#include <Daqif.hpp>
 
#include <boost/asio/io_context.hpp>
#include <daq/daqContext.hpp>
#include <daq/eventLog.hpp>
#include <daq/eventLogObserver.hpp>
#include <daq/manager.hpp>
#include <log4cplus/logger.h>
#include <mal/Mal.hpp>
 
namespace mal = ::elt::mal;
 
struct ParsedSource {
    ParsedSource(std::string name, std::string rr_uri);
    ParsedSource() = default;
    ParsedSource(ParsedSource const&) = default;
    ParsedSource(ParsedSource&&) = default;
    ParsedSource& operator=(ParsedSource const& rhs) = default;
    ParsedSource& operator=(ParsedSource&& rhs) = default;
 
    bool operator==(ParsedSource const& rhs) const;
    std::string name;
    std::string rr_uri;
};
 
std::ostream& operator<<(std::ostream& os, ParsedSource const& s);
 
/**
 * Parse user provided string in the format
 * "<name>@<rr-uri>"
 *
 * @throw std::invalid_argument on errors.
 */
ParsedSource ParseSourceUri(std::string_view s);
 
/**
 * Parse user provided string in the format
 * "<name>@<rr-uri>[ <name>@...]"
 *
 * @throw std::invalid_argument on errors.
 */
std::vector<ParsedSource> ParseSourceUris(std::string_view s);
 
/**
 * Parse the JSON properties user provides with StartDaq
 *
 *  {"keywords": KEYWORDS,
 *   "awaitInterval": DURATION}
 *
 * @throws nlohmann::json::exception on parsing errors.
 * @throws std::invalid_argument on argument errors.
 */
daq::DaqContext ParseStartDaqContext(std::string const& properties);
 
/**
 * Parse JSON specification and returns corresponding DaqContext.
 *
 * @throws daq::json::StartDaqV2SpecError On schema error
 * @throws daq::json::SchemaError On schema error
 * @throws nlohmann::json::exception on parsing error
 * @throws std::invalid_argument on argument errors.
 * @throws std::exception-derived exception on other errors.
 */
daq::DaqContext ParseStartDaqV2(std::string const& specification);
 
/**
 * Implements the MAL interface daqif::OcmDaq (async version).
 *
 * The server is only safe to use as a shared pointer, as weak pointers to this object is
 * stored in asynchronous continuations, apart from the initiating operation.
 * Provided boost::asio::io_context must outlive object and any pending operations.
 *
 * This object can be deleted while there are operations that have not complete yet.
 * In that case, when the operation finally completes, an exception is sent as reply, even if
 * the requested operation would have succeeded otherwise. The io_context must stay alive however,
 * as it will be used as an executor when asynchonous operation is continued.
 *
 * A note on thread safety:
 *
 * The public (asynchronous) interface will immediately defer the execution to the provided
 * executor, so depending on the executor this can provide thread safety.
 *
 *
 * @ingroup daq_ocm_server
 */
class OcmDaqService : public daqif::AsyncOcmDaqControl,
                      public std::enable_shared_from_this<OcmDaqService> {
public:
    static constexpr char const* LOGGER_NAME = "ocm.service.daq";
 
    /**
     *
     * @param io_ctx ASIO io context to use as an executor. This object must outlive OcmDaqService.
     * The io context will be progated to any created `daq::DaqController` instances as well.
     * @param mal The mal instance to use to create instances. This object must outlive
     * OcmDaqService.
     * @param mgr The data acquisition manager to use. This object must outlive OcmDaqService.
     */
    OcmDaqService(boost::asio::io_context& io_ctx,
                  mal::Mal& mal,
                  daq::Manager& mgr,
                  std::string proc_name,
                  std::string output_path,
                  std::shared_ptr<daq::ObservableEventLog> event_log);
    ~OcmDaqService();
 
    boost::future<std::shared_ptr<::daqif::DaqReply>>
    StartDaq(const std::string& id,
             const std::string& file_prefix,
             const std::string& primary_sources,
             const std::string& metadata_sources,
             const std::string& properties) override;
    boost::future<std::shared_ptr<::daqif::DaqReply>>
    StartDaqV2(const std::string& specification) override;
 
    boost::future<std::shared_ptr<::daqif::DaqReply>> StopDaq(const std::string& id) override;
 
    boost::future<std::shared_ptr<::daqif::DaqReply>> ForceStopDaq(const std::string& id) override;
 
    boost::future<std::shared_ptr<::daqif::DaqReply>> AbortDaq(const std::string& id) override;
 
    boost::future<std::shared_ptr<::daqif::DaqReply>> ForceAbortDaq(const std::string& id) override;
 
    boost::future<std::shared_ptr<::daqif::DaqReply>>
    UpdateKeywords(const std::string& id, const std::string& keywords) override;
 
    boost::future<std::shared_ptr<::daqif::AwaitDaqReply>>
    AwaitDaqState(const std::string& id,
                  daqif::DaqState state,
                  daqif::DaqSubState substate,
                  double timeout) override;
 
    boost::future<std::shared_ptr<::daqif::DaqStatus>> GetStatus(const std::string& id) override;
 
    boost::future<std::vector<std::shared_ptr<::daqif::DaqStatus>>> GetActiveList() override;
 
private:
    std::string MakeExceptionMessageWithStatus(std::string const& id,
                                               std::exception_ptr const& exception) const;
 
    /**
     * Common Start function for StartDaq and StartDaqV2.
     *
     * @param context DaqContext describing DAQ to start.
     * @param function Pointer to static string.
     */
    boost::future<std::shared_ptr<::daqif::DaqReply>>
    StartDaq(daq::DaqContext const& context, char const* function);
    boost::future<std::shared_ptr<::daqif::DaqReply>> StopDaq(const std::string& id, bool forced);
    boost::future<std::shared_ptr<::daqif::DaqReply>> AbortDaq(const std::string& id, bool forced);
 
    /**
     * @throws std::invalid_argument on validation errors.
     */
    void UpdateFrom(daq::DaqContext& context, daq::json::StartDaqV2Spec const& spec);
 
    boost::asio::io_context& m_io_ctx;
    rad::IoExecutor m_executor;
    mal::Mal& m_mal;
    daq::Manager& m_mgr;
    /**
     * Process name
     */
    std::string m_proc_name;
 
    /**
     * Directory in which FITS files are written
     */
    std::string m_output_path;
 
    std::shared_ptr<daq::ObservableEventLog> m_event_log;
    boost::signals2::connection m_log_observer_connection;
    /**
     * Observer for m_event_log.
     */
    daq::EventLogObserverLogger m_log_observer;
 
    log4cplus::Logger m_logger;
};
 
#endif  // #ifndef DAQ_OCM_OCM_DAQ_SERVICE_HPP_