stop.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_common_libdaq
 * @copyright 2022 ESO - European Southern Observatory
 *
 * @brief Contains declaration for the StopAsync operation
 */
#ifndef OCM_DAQ_OP_STOP_HPP_
#define OCM_DAQ_OP_STOP_HPP_
#include <daq/config.hpp>
 
#include <boost/thread/future.hpp>
 
#include <daq/dpPart.hpp>
#include <daq/error.hpp>
#include <daq/op/asyncOpParams.hpp>
#include <daq/utility.hpp>
 
namespace daq::op {
 
/**
 * A composite async operation that starts DAQ
 *
 * @ingroup daq_common_libdaq
 */
struct StopAsync {
public:
    explicit StopAsync(ErrorPolicy policy, AsyncOpParams params) noexcept;
    /**
     * Initiates operation that stop metadata acquisition.
     *
     * @note Caller is responsible for keeping object alive until
     * result is set.
     *
     * @todo: Return a move-only type containing only the data?
     */
    [[nodiscard]] boost::future<Result<DpParts>> Initiate();
 
private:
    [[nodiscard]] boost::future<void> StopMeta();
    [[nodiscard]] boost::future<void> StopPrim();
 
    ErrorPolicy m_policy;
    AsyncOpParams m_params;
    bool m_error;
    std::vector<DpPart> m_parts;
    std::string m_keywords;
};
 
}  // namespace daq::op
#endif  // #ifndef OCM_DAQ_OP_STOP_HPP_