A generic endpoint for log messages. More...

#include <Journal.h>

Collaboration diagram for beast::Journal:

Classes
class	ScopedStream

class	Sink
	Abstraction for the underlying message destination. More...

class	Stream
	Provide a light-weight way to check active() before string formatting. More...

Public Member Functions
	Journal ()=delete
	Journal has no default constructor.

	Journal (Sink &sink)
	Create a journal that writes to the specified sink.

Sink &	sink () const
	Returns the Sink associated with this Journal.

Stream	stream (Severity level) const
	Returns a stream for this sink, with the specified severity level.

bool	active (Severity level) const
	Returns `true` if any message would be logged at this severity level.


Stream	trace () const
	Severity stream access functions.

Stream	debug () const

Stream	info () const

Stream	warn () const

Stream	error () const

Stream	fatal () const

Static Public Member Functions
static Sink &	getNullSink ()
	Returns a Sink which does nothing.

Private Types
using	Severity = severities::Severity

Private Attributes
Sink *	m_sink

Detailed Description

A generic endpoint for log messages.

The Journal has a few simple goals:

To be light-weight and copied by value. To allow logging statements to be left in source code. The logging is controlled at run-time based on a logging threshold.

It is advisable to check Journal::active(level) prior to formatting log text. Doing so sidesteps expensive text formatting when the results will not be sent to the log.

Definition at line 59 of file Journal.h.

Member Typedef Documentation

◆ Severity

using beast::Journal::Severity = severities::Severity

private

Definition at line 66 of file Journal.h.

Constructor & Destructor Documentation

◆ Journal() [1/2]

beast::Journal::Journal ( )

delete

Journal has no default constructor.

◆ Journal() [2/2]

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

explicit

Create a journal that writes to the specified sink.

Definition at line 291 of file Journal.h.

Member Function Documentation

◆ getNullSink()

Journal::Sink & beast::Journal::getNullSink ( )

static

Returns a Sink which does nothing.

Definition at line 82 of file beast_Journal.cpp.

◆ sink()

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

Returns the Sink associated with this Journal.

Definition at line 297 of file Journal.h.

◆ stream()

Stream beast::Journal::stream ( Severity level ) const

Returns a stream for this sink, with the specified severity level.

Definition at line 304 of file Journal.h.

◆ active()

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

Returns true if any message would be logged at this severity level.

For a message to be logged, the severity must be at or above the sink's severity threshold.

Definition at line 314 of file Journal.h.

◆ trace()

Stream beast::Journal::trace ( ) const

Severity stream access functions.

Definition at line 322 of file Journal.h.

◆ debug()

Stream beast::Journal::debug ( ) const

Definition at line 328 of file Journal.h.

◆ info()

Stream beast::Journal::info ( ) const

Definition at line 334 of file Journal.h.

◆ warn()

Stream beast::Journal::warn ( ) const

Definition at line 340 of file Journal.h.

◆ error()

Stream beast::Journal::error ( ) const

Definition at line 346 of file Journal.h.

◆ fatal()

Stream beast::Journal::fatal ( ) const

Definition at line 352 of file Journal.h.

Member Data Documentation

◆ m_sink

Sink* beast::Journal::m_sink