#include <trace_config.h>

Inheritance diagram for phosphor::TracingStoppedCallback:

Public Member Functions
virtual void	operator() (TraceLog &, std::lock_guard< TraceLog > &)=0

Detailed Description

Functor type for a callback to be used when a TraceLog stops tracing. This can be given to a TraceConfig before tracing starts in order to detect when it ends.

The functor will receive a reference to the TraceLog and a reference to the external lock that was held when the functor was invoked which can be used to access restricted methods even while the TraceLog is locked.

Example Functor:

void(TraceLog& log, std::lock_guard<TraceLog>& lh) {
    for(const auto& event : *log.getBuffer(lh)) {
        std::cerr << event << "\n";
    }
    log.start(lh, TraceConfig(BufferMode::fixed, 2000000));
}

It is worth bearing in mind that this callback will be run in the thread that stopped tracing which could be a thread which was in the middle of tracing an event if the buffer became full.

Therefore it might be sensible to create a new thread to process the buffer (Which can take a comparatively long time) or to stash it somewhere that another thread can access.

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

include/phosphor/trace_config.h

Public Member Functions

Detailed Description