HydroCouple  2.0.0-alpha.1
HydroCouple Interface Definitions
Loading...
Searching...
No Matches
HydroCouple::ErrorEntry Struct Reference

ErrorEntry is one diagnostic record in a component's error queue. More...

#include <hydrocouple.h>

Collaboration diagram for HydroCouple::ErrorEntry:

Public Types

enum class  Severity : uint8_t {
  Information = 0 ,
  Warning ,
  Error ,
  Fatal
}
 Severity of an ErrorEntry. More...
 

Public Attributes

Severity severity = Severity::Information
 Severity of this record.
 
int32_t code = 0
 Implementation-defined error code.
 
std::string source
 Id of the originating entity.
 
std::string message
 Human-readable description.
 

Detailed Description

ErrorEntry is one diagnostic record in a component's error queue.

The error queue is the normative failure channel for distributed and embedded execution, where exceptions cannot cross process, C-ABI, or language boundaries. Exceptions remain a local convenience.

Member Enumeration Documentation

◆ Severity

enum class HydroCouple::ErrorEntry::Severity : uint8_t
strong

Severity of an ErrorEntry.

Enumerator
Information 

Informational message.

Warning 

Recoverable anomaly.

Error 

Operation failed; component may continue.

Fatal 

Component is in the Failed state.

Member Data Documentation

◆ code

int32_t HydroCouple::ErrorEntry::code = 0

Implementation-defined error code.

◆ message

std::string HydroCouple::ErrorEntry::message

Human-readable description.

◆ severity

Severity HydroCouple::ErrorEntry::severity = Severity::Information

Severity of this record.

◆ source

std::string HydroCouple::ErrorEntry::source

Id of the originating entity.


The documentation for this struct was generated from the following file: