abort.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_common_libdaq
 * @copyright 2022 ESO - European Southern Observatory
 *
 * @brief Contains declaration for the AbortAsync operation
 */
#ifndef OCM_DAQ_OP_ABORT_HPP_
#define OCM_DAQ_OP_ABORT_HPP_
#include <daq/config.hpp>
 
#include <boost/thread/future.hpp>
 
#include <daq/error.hpp>
#include <daq/op/asyncOpParams.hpp>
#include <daq/utility.hpp>
 
namespace daq::op {
 
/**
 * A composite async operation that aborts a DAQ
 *
 * @ingroup daq_common_libdaq
 */
struct AbortAsync {
public:
    using ResultType = Result<void>;
 
    explicit AbortAsync(ErrorPolicy policy, AsyncOpParams params) noexcept;
    /**
     * Initiates operation that stats metadata acquisition.
     *
     * @returns future that is Set on failure or when also primary data acquisition has started.
     * the value is Set after starting all (or failed).
     *
     * If tolerant policy is used exceptions from AbortMeta() or AbortPrim() are ignored.
     */
    [[nodiscard]] boost::future<ResultType> Initiate();
 
private:
    /**
     * @throws std::exception derived exception if aborting failed.a
     */
    [[nodiscard]] boost::future<void> AbortMeta();
    /**
     * @throws std::exception derived exception if aborting failed.a
     */
    [[nodiscard]] boost::future<void> AbortPrim();
 
    ErrorPolicy m_policy;
    bool m_error;
    AsyncOpParams m_params;
};
 
}  // namespace daq::op
#endif  // #ifndef OCM_DAQ_OP_ABORT_HPP_