xrpld
Loading...
Searching...
No Matches
xrpl::test::csf::BasicSink Class Reference

Sink that prepends simulation time to messages. More...

#include <Sim.h>

Inheritance diagram for xrpl::test::csf::BasicSink:
Collaboration diagram for xrpl::test::csf::BasicSink:

Public Member Functions

 BasicSink (Scheduler::clock_type const &clock)
void write (beast::Severity level, std::string const &text) override
 Write text to the sink at the specified severity.
void writeAlways (beast::Severity level, std::string const &text) override
 Bypass filter and write text to the sink at the specified severity.
virtual bool active (Severity level) const
 Returns true if text at the passed severity produces output.
virtual bool console () const
 Returns true if a message is also written to the Output Window (MSVC).
virtual void console (bool output)
 Set whether messages are also written to the Output Window (MSVC).
virtual Severity threshold () const
 Returns the minimum severity level this sink will report.
virtual void threshold (Severity thresh)
 Set the minimum severity this sink will report.

Private Attributes

Scheduler::clock_type const & clock_
Severity thresh_
bool console_

Detailed Description

Sink that prepends simulation time to messages.

Definition at line 19 of file Sim.h.

Constructor & Destructor Documentation

◆ BasicSink()

xrpl::test::csf::BasicSink::BasicSink ( Scheduler::clock_type const & clock)

Definition at line 24 of file Sim.h.

Member Function Documentation

◆ write()

void xrpl::test::csf::BasicSink::write ( beast::Severity level,
std::string const & text )
overridevirtual

Write text to the sink at the specified severity.

A conforming implementation will not write the text if the passed level is below the current threshold().

Implements beast::Journal::Sink.

Definition at line 30 of file Sim.h.

◆ writeAlways()

void xrpl::test::csf::BasicSink::writeAlways ( beast::Severity level,
std::string const & text )
overridevirtual

Bypass filter and write text to the sink at the specified severity.

Always write the message, but maintain the same formatting as if it passed through a level filter.

Parameters
levelLevel to display in message.
textText to write to sink.

Implements beast::Journal::Sink.

Definition at line 39 of file Sim.h.

◆ active()

bool beast::Journal::Sink::active ( Severity level) const
nodiscardvirtualinherited

Returns true if text at the passed severity produces output.

Reimplemented in beast::NullJournalSink, beast::WrappedSink, and xrpl::test::SuiteJournalSink.

Definition at line 78 of file beast_Journal.cpp.

◆ console() [1/2]

bool beast::Journal::Sink::console ( ) const
nodiscardvirtualinherited

Returns true if a message is also written to the Output Window (MSVC).

Reimplemented in beast::NullJournalSink, and beast::WrappedSink.

Definition at line 84 of file beast_Journal.cpp.

◆ console() [2/2]

void beast::Journal::Sink::console ( bool output)
virtualinherited

Set whether messages are also written to the Output Window (MSVC).

Reimplemented in beast::NullJournalSink, and beast::WrappedSink.

Definition at line 90 of file beast_Journal.cpp.

◆ threshold() [1/2]

Severity beast::Journal::Sink::threshold ( ) const
nodiscardvirtualinherited

Returns the minimum severity level this sink will report.

Reimplemented in beast::NullJournalSink, and beast::WrappedSink.

Definition at line 96 of file beast_Journal.cpp.

◆ threshold() [2/2]

void beast::Journal::Sink::threshold ( Severity thresh)
virtualinherited

Set the minimum severity this sink will report.

Reimplemented in beast::NullJournalSink, and beast::WrappedSink.

Definition at line 102 of file beast_Journal.cpp.

Member Data Documentation

◆ clock_

Scheduler::clock_type const& xrpl::test::csf::BasicSink::clock_
private

Definition at line 21 of file Sim.h.

◆ thresh_

Severity beast::Journal::Sink::thresh_
privateinherited

Definition at line 103 of file Journal.h.

◆ console_

bool beast::Journal::Sink::console_
privateinherited

Definition at line 104 of file Journal.h.