Death::Trace namespace

Runtime event tracing implementation, should be used along with Asserts.h.

Classes

class Logger
Logger enqueues trace items for processing.
class LoggerBackend
Logger backend processes trace items in the background.
struct TransitEvent
Transit event stores required information to be dispatched to sinks.

Functions

void AttachSink(ITraceSink* sink)
Registers the sink and initializes the event logger if no sink was attached before.
void DetachSink(ITraceSink* sink)
Unregisters the sink and uninitializes the event logger if no sink left.
void Flush()
Flushes and waits until all prior entries are written to all sinks.
void InitializeBacktrace(std::uint32_t maxCapacity, TraceLevel flushLevel = TraceLevel::Unknown)
Initializes backtrace storage for TraceLevel::Deferred.
void FlushBacktraceAsync()
Writes any stored deferred entries to all sinks asynchronously.

Function documentation

void Death::Trace::AttachSink(ITraceSink* sink)
#include <Core/ITraceSink.h>

Registers the sink and initializes the event logger if no sink was attached before.

void Death::Trace::DetachSink(ITraceSink* sink)
#include <Core/ITraceSink.h>

Unregisters the sink and uninitializes the event logger if no sink left.

void Death::Trace::Flush()
#include <Core/ITraceSink.h>

Flushes and waits until all prior entries are written to all sinks.

void Death::Trace::InitializeBacktrace(std::uint32_t maxCapacity, TraceLevel flushLevel = TraceLevel::Unknown)
#include <Core/ITraceSink.h>

Initializes backtrace storage for TraceLevel::Deferred.

If the backtrace storage is not initialized, all deferred entries are written immediately to all sinks. After initialization, deferred entries are stored in the backtrace storage and written to sinks only when the backtrace is flushed. Flush can be triggered by calling FlushBacktraceAsync() or automatically when an entry with a level higher than the flush level is enqueued.

void Death::Trace::FlushBacktraceAsync()
#include <Core/ITraceSink.h>

Writes any stored deferred entries to all sinks asynchronously.