Abstract session telemetry base with a protected clock drawer.
More...
#include <StormByte/telemetry.hxx>
|
| | Telemetry () noexcept |
| | Construct an empty telemetry drawer.
|
| | Telemetry (const Telemetry &)=delete |
| | Copy constructor is deleted.
|
| | Telemetry (Telemetry &&other) noexcept |
| | Move constructor.
|
| Telemetry & | operator= (const Telemetry &)=delete |
| | Copy assignment is deleted.
|
| Telemetry & | operator= (Telemetry &&other) noexcept |
| | Move assignment.
|
| class Clock & | Clock (std::string_view name) |
| | Access or create a named clock in the drawer.
|
| class Clock::Sample | MeasureClock (std::string_view name) noexcept |
| | Start an independent sample on a named aggregate clock.
|
| const class Clock & | Clock (std::string_view name) const |
| | Read-only access to a named clock in the drawer.
|
Abstract session telemetry base with a protected clock drawer.
Modules derive and extend this class by adding their own domain counters or metrics. Time series and stopwatches are managed in a protected, named clock drawer. Use MeasureClock to obtain an independent concurrent sample; the returned token owns its own start time.
◆ ~Telemetry()
| virtual StormByte::Telemetry::~Telemetry |
( |
| ) |
|
|
virtualnoexcept |
Virtual destructor.
Defined out-of-line for DLL boundaries.
◆ Telemetry() [1/3]
| StormByte::Telemetry::Telemetry |
( |
| ) |
|
|
protectednoexcept |
Construct an empty telemetry drawer.
◆ Telemetry() [2/3]
| StormByte::Telemetry::Telemetry |
( |
const Telemetry & | | ) |
|
|
protecteddelete |
Copy constructor is deleted.
◆ Telemetry() [3/3]
| StormByte::Telemetry::Telemetry |
( |
Telemetry && | other | ) |
|
|
protectednoexcept |
Move constructor.
- Parameters
-
| other | Object to move from. |
◆ Clock() [1/2]
| class Clock & StormByte::Telemetry::Clock |
( |
std::string_view | name | ) |
|
|
protected |
Access or create a named clock in the drawer.
- Parameters
-
- Returns
- Reference to the requested aggregate clock. Use MeasureClock to time an operation.
- Exceptions
-
| StormByte::AllocationError | If a new name or clock cannot be allocated. |
| StormByte::OperationError | If clock creation fails for another reason. |
◆ Clock() [2/2]
| const class Clock & StormByte::Telemetry::Clock |
( |
std::string_view | name | ) |
const |
|
protected |
Read-only access to a named clock in the drawer.
- Parameters
-
- Returns
- Reference to the clock if found, or a static empty clock if missing.
◆ MeasureClock()
| class Clock::Sample StormByte::Telemetry::MeasureClock |
( |
std::string_view | name | ) |
|
|
protectednoexcept |
Start an independent sample on a named aggregate clock.
- Parameters
-
- Returns
- Active sample token; inactive during exception unwinding or if storage allocation fails.
- Note
- Best-effort and non-throwing so it can be used in no-throw instrumentation paths. Unwinding never creates telemetry storage or an additional allocation exception.
◆ operator Safe::String()
| virtual StormByte::Telemetry::operator Safe::String |
( |
| ) |
const |
|
pure virtual |
◆ operator std::string()
Flatten counters into a caller-owned standard string.
- Returns
- Formatted standard string allocated on caller heap.
◆ operator=() [1/2]
Copy assignment is deleted.
- Returns
- Reference to this telemetry object.
◆ operator=() [2/2]
Move assignment.
- Parameters
-
| other | Object to move from. |
- Returns
- Reference to this telemetry object.
The documentation for this class was generated from the following file: