Issues.hpp

Go to the documentation of this file.

#ifndef CMDLIB_INCLUDE_CMDLIB_ISSUES_HPP_
#define CMDLIB_INCLUDE_CMDLIB_ISSUES_HPP_
 
#include "ers/Issue.hpp"
#include "logging/Logging.hpp" // NOTE: if ISSUES ARE DECLARED BEFORE include logging/Logging.hpp, TLOG_DEBUG<<issue wont work.
#include <string>
 
namespace dunedaq {

 
ERS_DECLARE_ISSUE(cmdlib,
                  MalformedUri,
                  "Malformed uri: " << error << " uri:" << uri,
                  ((std::string)error)((std::string)uri))
 
// Throw if a URI is given which is not supported by the code.
// Provide the erroneous URI as arg.
ERS_DECLARE_ISSUE(cmdlib, UnsupportedUri, "Unsupported URI: " << uri, ((std::string)uri))
 
// Throw if a file can not be opened.  Provide "mode" of "reading"
// or "writing" and provide erroneous filename as args.
// ERS_DECLARE_ISSUE(cmdlib, BadFile,
//                  "Can not open file for " << mode << ": " << filename,
//                  ((std::string)filename)
//                  ((std::string)mode))
 
// Throw if a stream of data is exhausted.  Use in methods that
// are given semantics that imply the stream is not expected to
// become exhausted.  Ie, GetNext() may throw but something like
// GetNext(return_if_exhausted) -> value must not.  Name the
// stream and describe the error in the args.
// ERS_DECLARE_ISSUE(cmdlib, StreamExhausted,
//                  "Stream exhausted: " << stream_name << " err: " << err,
//                  ((std::string)stream_name)
//                  ((std::string)err))
 
// Throw if a stream of data being consumed has values which are
// not expected.  Give the stream name and error message as args.
// ERS_DECLARE_ISSUE(cmdlib, StreamCorrupt,
//                  "Stream corrupt: " << stream_name << " err: " << err,
//                  ((std::string)stream_name)
//                  ((std::string)err))
 
// Throw if an operation is the result of logically inconsistent
// code.  Describe the error in the "what" arg.
// ERS_DECLARE_ISSUE(cmdlib, InternalError,
//                  "Internal error: " << what,
//                  ((std::string)what))
 
ERS_DECLARE_ISSUE(cmdlib, CannotParseCommand, "Failed to parse command: " << error, ((std::string)error))
 
ERS_DECLARE_ISSUE(cmdlib, CommandExecutionFailed, "Execution of command failed: " << error, ((std::string)error))
 
ERS_DECLARE_ISSUE(cmdlib,
                  CommandFacilityInitialization,
                  "Problem configuring the command facility: " << error,
                  ((std::string)error))
 
ERS_DECLARE_ISSUE(cmdlib,
                  CommandFacilityCreationFailed,
                  "Failed to create CommandFacility uri:" << uri,
                  ((std::string)uri))
 
ERS_DECLARE_ISSUE(cmdlib,
                  CompletionQueueIssue,
                  "Problem with command completion queue: " << error,
                  ((std::string)error))
 
ERS_DECLARE_ISSUE(cmdlib,
                  RunLoopTerminated,
                  "The main run loop for command reception was interrupted: " << error,
                  ((std::string)error))
 
} // namespace dunedaq
 
#endif // CMDLIB_INCLUDE_CMDLIB_ISSUES_HPP_