Loading...
Searching...
No Matches
meshkit::Event Struct Reference

One job notification passed through an EventChannel. More...

#include <meshkit/events.hpp>

Collaboration diagram for meshkit::Event:

Public Attributes

std::uint64_t job = 0
 Id of the publishing channel (EventChannel::job()); set by publish().
 
std::uint64_t sequence = 0
 Per-channel number, from 1, set by publish().
 
std::int64_t elapsedMs = 0
 Milliseconds since the channel was constructed (steady clock); set by publish().
 
EventKind kind = EventKind::Diagnostic
 Kind of notification.
 
Severity severity = Severity::Info
 Severity of the notification.
 
RunStatus status = RunStatus::Running
 RunStatus::Running for intermediate events; the final status on a Completed event.
 
std::string stage
 Short stage name such as "triangulation" or "refinement"; publish() cuts longer text to at most 256 bytes plus "…".
 
std::string code
 Machine-readable code (the job's report code on Completed); publish() cuts longer text to at most 128 bytes plus "…".
 
std::string message
 Human-readable UTF-8 text; publish() cuts longer text to at most 8192 bytes plus "…".
 
Counts counts
 Counter snapshot when the event was produced.
 
int percent = -1
 Overall progress, 0 to 100, or negative (default -1) when not given.
 

Detailed Description

One job notification passed through an EventChannel.

The producer fills kind, severity, status, stage, code, message, counts and percent; EventChannel::publish() sets job, sequence and elapsedMs and bounds the strings.

Member Data Documentation

◆ code

std::string meshkit::Event::code

Machine-readable code (the job's report code on Completed); publish() cuts longer text to at most 128 bytes plus "…".

◆ counts

Counts meshkit::Event::counts

Counter snapshot when the event was produced.

◆ elapsedMs

std::int64_t meshkit::Event::elapsedMs = 0

Milliseconds since the channel was constructed (steady clock); set by publish().

◆ job

std::uint64_t meshkit::Event::job = 0

Id of the publishing channel (EventChannel::job()); set by publish().

◆ kind

EventKind meshkit::Event::kind = EventKind::Diagnostic

Kind of notification.

◆ message

std::string meshkit::Event::message

Human-readable UTF-8 text; publish() cuts longer text to at most 8192 bytes plus "…".

◆ percent

int meshkit::Event::percent = -1

Overall progress, 0 to 100, or negative (default -1) when not given.

publish() clamps a given value to 0..100 and never lets it fall below an earlier value of the channel.

◆ sequence

std::uint64_t meshkit::Event::sequence = 0

Per-channel number, from 1, set by publish().

Numbers of coalesced or evicted events are never drained, so drained sequences can have gaps.

◆ severity

Severity meshkit::Event::severity = Severity::Info

Severity of the notification.

◆ stage

std::string meshkit::Event::stage

Short stage name such as "triangulation" or "refinement"; publish() cuts longer text to at most 256 bytes plus "…".

◆ status

RunStatus meshkit::Event::status = RunStatus::Running

RunStatus::Running for intermediate events; the final status on a Completed event.


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