beast::Journal::Sink Class Reference

Abstraction for the underlying message destination. More...

#include <Journal.h>

Inheritance diagram for beast::Journal::Sink:

Public Member Functions
virtual	~Sink ()=0
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.
virtual void	write (Severity level, std::string const &text)=0
	Write text to the sink at the specified severity.
virtual void	writeAlways (Severity level, std::string const &text)=0
	Bypass filter and write text to the sink at the specified severity.

Protected Member Functions
	Sink ()=delete
	Sink (Sink const &sink)=default
	Sink (Severity thresh, bool console)
Sink &	operator= (Sink const &lhs)=delete

Private Attributes
Severity	thresh_
bool	m_console

Detailed Description

Abstraction for the underlying message destination.

Definition at line 75 of file Journal.h.

Constructor & Destructor Documentation

Sink() [1/3]

beast::Journal::Sink::Sink ( )

protecteddelete

Sink() [2/3]

beast::Journal::Sink::Sink ( Sink const &  sink )

explicitprotecteddefault

Sink() [3/3]

beast::Journal::Sink::Sink ( Severity  thresh, bool  console  )

protected

Definition at line 90 of file beast_Journal.cpp.

~Sink()

beast::Journal::Sink::~Sink ( )

pure virtualdefault

Member Function Documentation

operator=()

Sink & beast::Journal::Sink::operator= ( Sink const &  lhs )

protecteddelete

active()

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

virtual

Returns true if text at the passed severity produces output.

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

Definition at line 98 of file beast_Journal.cpp.

console() [1/2]

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

virtual

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

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

Definition at line 104 of file beast_Journal.cpp.

console() [2/2]

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

virtual

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

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

Definition at line 110 of file beast_Journal.cpp.

threshold() [1/2]

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

virtual

Returns the minimum severity level this sink will report.

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

Definition at line 116 of file beast_Journal.cpp.

threshold() [2/2]

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

virtual

Set the minimum severity this sink will report.

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

Definition at line 122 of file beast_Journal.cpp.

write()

virtual void beast::Journal::Sink::write ( Severity  level, std::string const &  text  )

pure virtual

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().

Implemented in ripple::Logs::Sink, beast::WrappedSink, ripple::test::csf::BasicSink, ripple::test::CaptureLogs::CaptureSink, ripple::test::CheckMessageLogs::CheckMessageSink, ripple::test::Server_test::TestSink, ripple::test::SuiteJournalSink, ripple::test::StreamSink, beast::Journal_test::TestSink, and beast::NullJournalSink.

writeAlways()

virtual void beast::Journal::Sink::writeAlways ( Severity  level, std::string const &  text  )

pure virtual

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

level	Level to display in message.
text	Text to write to sink.

Implemented in ripple::Logs::Sink, ripple::test::csf::BasicSink, ripple::test::CaptureLogs::CaptureSink, ripple::test::CheckMessageLogs::CheckMessageSink, ripple::test::Server_test::TestSink, ripple::test::SuiteJournalSink, ripple::test::StreamSink, beast::Journal_test::TestSink, beast::WrappedSink, and beast::NullJournalSink.

Member Data Documentation

thresh_

Severity beast::Journal::Sink::thresh_

private

Definition at line 127 of file Journal.h.

m_console

bool beast::Journal::Sink::m_console

private

Definition at line 128 of file Journal.h.