Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::runtime::CaptureLogSink Class Reference

Keeps the most recent records in memory. More...

#include <log_sink.hpp>

Public Member Functions

 CaptureLogSink (std::size_t max_records=4096)
void write (LogLevel level, std::string_view category, std::string_view message) const
LogSink sink () const
 operator LogSink () const
std::vector< LogRecord > records () const
 Snapshot, oldest first.
std::vector< LogRecord > records_at_least (LogLevel min_level) const
 Snapshot of records at or above min_level.
std::vector< LogRecord > take ()
 Return the records and empty the list.
void clear ()
std::size_t size () const
std::uint64_t dropped_count () const
 Records discarded because the list was full.
bool contains (std::string_view needle) const
 True if any retained message contains needle.

Detailed Description

Keeps the most recent records in memory.

Meant for tests that assert on what was logged and for tooling (an MCP endpoint, an in-app console) that serves recent log lines. When full, the oldest record is discarded and counted.

Constructor & Destructor Documentation

◆ CaptureLogSink()

pulp::runtime::CaptureLogSink::CaptureLogSink ( std::size_t max_records = 4096)
explicit

Member Function Documentation

◆ clear()

void pulp::runtime::CaptureLogSink::clear ( )

◆ contains()

bool pulp::runtime::CaptureLogSink::contains ( std::string_view needle) const

True if any retained message contains needle.

◆ dropped_count()

std::uint64_t pulp::runtime::CaptureLogSink::dropped_count ( ) const

Records discarded because the list was full.

◆ operator LogSink()

pulp::runtime::CaptureLogSink::operator LogSink ( ) const
inline

◆ records()

std::vector< LogRecord > pulp::runtime::CaptureLogSink::records ( ) const

Snapshot, oldest first.

◆ records_at_least()

std::vector< LogRecord > pulp::runtime::CaptureLogSink::records_at_least ( LogLevel min_level) const

Snapshot of records at or above min_level.

◆ sink()

LogSink pulp::runtime::CaptureLogSink::sink ( ) const

◆ size()

std::size_t pulp::runtime::CaptureLogSink::size ( ) const

◆ take()

std::vector< LogRecord > pulp::runtime::CaptureLogSink::take ( )

Return the records and empty the list.

◆ write()

void pulp::runtime::CaptureLogSink::write ( LogLevel level,
std::string_view category,
std::string_view message ) const

The documentation for this class was generated from the following file:
  • /home/runner/work/pulp/pulp/core/runtime/include/pulp/runtime/log_sink.hpp