error.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_common_libdaq
 * @copyright 2022 ESO - European Southern Observatory
 *
 * @brief Contains error related declarations for DAQ
 */
#ifndef OCF_DAQ_ERROR_HPP_
#define OCF_DAQ_ERROR_HPP_
#include <iosfwd>
#include <stdexcept>
#include <string>
#include <variant>
#include <vector>
 
#include <fmt/ostream.h>
 
namespace daq {
 
/**
 * Error policy supported by certain operations.
 *
 * Fatal for any policy refers to the operation is aborted and reported as failed (typically using
 * exceptions).
 */
enum class ErrorPolicy {
    /**
     * Any error is considered fatal and may lead to the operation being aborted.
     */
    Strict = 0,
 
    /**
     * Errors that can be ignored with partial completion of a command will be tolerated and
     * is reported as successful.
     */
    Tolerant
};
 
std::ostream& operator<<(std::ostream& os, ErrorPolicy policy);
 
/**
 * Started operation was aborted.
 *
 * Typically used to communicate that asynchronous operation has been aborted.
 *
 * @ingroup daq_common_libdaq
 */
class DaqOperationAborted : public std::runtime_error {
public:
    using std::runtime_error::runtime_error;
};
 
/**
 * Started operation timed out
 *
 * @ingroup daq_common_libdaq
 */
class DaqOperationTimeout : public std::runtime_error {
public:
    using std::runtime_error::runtime_error;
};
 
/**
 * Represents error in single source
 *
 * @ingroup daq_common_libdaq
 */
class DaqSourceError : public virtual std::exception {
public:
    DaqSourceError(std::string request, std::string source, std::string message);
 
    char const* what() const noexcept override;  // NOLINT
 
    std::string m_request;
    std::string m_source;
    std::string m_message;
    std::string m_formatted;
};
 
/**
 * Exception thrown to carry reply errors
 *
 * @ingroup daq_common_libdaq
 */
class DaqSourceErrors : public virtual std::exception {
public:
    DaqSourceErrors(std::vector<std::exception_ptr> errors);
    DaqSourceErrors(std::vector<std::variant<DaqSourceError, std::exception_ptr>> errors);
 
    char const* what() const noexcept override;  // NOLINT
 
    auto
    Errors() const noexcept -> std::vector<std::variant<DaqSourceError, std::exception_ptr>> const&;
 
private:
    void Update();
 
    std::vector<std::variant<DaqSourceError, std::exception_ptr>> m_errors;
    std::string m_what;
};
 
}  // namespace daq
 
template <>
struct fmt::formatter<daq::ErrorPolicy> : ostream_formatter {};
 
#endif  // #ifndef OCF_DAQ_ERROR_HPP_