INTRODUCTION Overview Download and Install Documentation Publications REPOSITORY Libraries DEVELOPER Dev Guide Dashboard PEOPLE Contributors Users Project Download Mailing lists
|
status.h 46};
69 SubsystemStatus( SubsystemState s=SubsystemIdle, SubsystemHealth h=SubsystemOk, const std::string& msg="",
114};
130};
313 virtual void setSubsystemStatus( const std::string& subsystem, SubsystemState state, SubsystemHealth health, const std::string& message="" )=0;
virtual SubsystemStatus subsystemStatus(const std::string &subsystem)=0 virtual void setMaxHeartbeatInterval(const std::string &subsystem, double intervalSec)=0 virtual void addSubsystem(const std::string &subsystem, double maxHeartbeatIntervalSec=-1.0, SubsystemType type=SubsystemStandard)=0 virtual void removeSubsystem(const std::string &subsystem)=0 virtual void setSubsystemType(const std::string &subsystem, SubsystemType type)=0 Sets the subsystem type which describes the expected behavior of the subsystem. virtual void initialising(const std::string &subsystem)=0 virtual void working(const std::string &subsystem)=0 virtual ComponentStatus componentStatus()=0 Returns state of the component infrastructure. virtual std::vector< std::string > subsystems()=0 Returns a list of subsystem names. virtual void warning(const std::string &subsystem, const std::string &message)=0 virtual void process()=0 virtual void heartbeat(const std::string &subsystem)=0 virtual void finalising(const std::string &subsystem)=0 virtual void message(const std::string &subsystem, const std::string &message)=0 virtual void fault(const std::string &subsystem, const std::string &message)=0 virtual void critical(const std::string &subsystem, const std::string &message)=0 virtual void ok(const std::string &subsystem, const std::string &message="")=0 virtual void setSubsystemStatus(const std::string &subsystem, SubsystemState state, SubsystemHealth health, const std::string &message="")=0 @ SubsystemWarning Subsystem has encountered an abnormal but non-critical condition. Definition status.h:57 @ SubsystemCritical Subsystem has encountered a critical condition. Definition status.h:59 @ CompStarting Component is preparing to work, e.g. initialising its resources, etc. Definition status.h:123 @ CompOperational Component is fully initialised and is performing its work. Definition status.h:125 @ CompFault Component is in an unrecovarable faulty state. Definition status.h:129 @ CompStopping Component is preparing to shutdown, e.g. releasing its resources, etc. Definition status.h:127 ComponentHealth Possible values of component health. Definition status.h:137 @ CompCritical At least one of the component's subsystems has encountered a critical condition. Definition status.h:143 @ CompWarning At least one of the component's subsystems has encountered an abnormal but non-critical condition. Definition status.h:141 std::string toString(SubsystemState state) Returns string equivalent of state enumerator. Definition status.cpp:17 SubsystemType Subsystem type which describes common behavior models of a subsystem. Definition status.h:101 @ SubsystemStandard Standard model: subsystem's life cycle is equal to the life cycle of the component. Definition status.h:103 @ SubsystemWorking Subsystem is fully initialised and is performing its function. Definition status.h:39 @ SubsystemInitialising Subsystem is preparing to work, e.g. initialising its resources, etc. Definition status.h:37 @ SubsystemFinalising Subsystem is preparing to shutdown, e.g. releasing its resources, etc. Definition status.h:41 @ SubsystemIdle Subsystem has been created but has not started initialisation process. Definition status.h:35 @ SubsystemFault Subsystem is in an unrecovarable faulty state. Definition status.h:45 @ SubsystemShutdown Subsystem is not longer functioning. Definition status.h:43 SubsystemHealth health Subsystem's health. I.e. how is the subsystem doing? Definition status.h:81 SubsystemStatus(SubsystemState s=SubsystemIdle, SubsystemHealth h=SubsystemOk, const std::string &msg="", bool stall=false, double beat=0.0) Constructor. Definition status.h:69 std::string message Human-readable status description. Definition status.h:84 bool isStalled If true, the subsystem has not been heard from for an abnormally long time. Definition status.h:87 SubsystemState state Current state in the subsystem's state machine. I.e. what is the subsystem doing? Definition status.h:78 |