LogTxtStreamSink Class Reference

Simple log sink for writing to streams like cout or file It uses the SimpleFormatter for output. More...

#include <error/LogTxtStreamSink.h>

Inheritance diagram for LogTxtStreamSink:

Public Member Functions
	LogTxtStreamSink (std::ostream &stream)
	Constructor taking a stream that is used for output. More...
virtual void	consume (const LogRecord &record)
	Overwrite this in derived class. More...
void	aboutToConsume (const LogRecord &record)
	Is called by LogCore singleton whenever a new log record is written. More...
void	resetFilter ()
	Resets the log filter. More...
template<typename T >
LogFilterPtr	setFilter (const T &filter)
	Set the filter. More...
void	resetFormatter ()
	Resets the formatter. More...
template<typename T >
LogFormatterPtr	setFormatter (const T &formatter)
	Set the formatter. More...

Protected Attributes
std::ostream &	mStream
LogFormatterPtr	mFormatter
LogFilterPtr	mFilter

Detailed Description

Simple log sink for writing to streams like cout or file It uses the SimpleFormatter for output.

Constructor & Destructor Documentation

LogTxtStreamSink()

LogTxtStreamSink

(

std::ostream &

stream

)

Constructor taking a stream that is used for output.

Member Function Documentation

consume()

virtual void consume ( const LogRecord &  record )

virtual

Overwrite this in derived class.

Is called for each log entry that passes the filter (if any)

Parameters

record

The log entry.

Implements LogSink.

Reimplemented in LogConsoleSink.

aboutToConsume()

void aboutToConsume ( const LogRecord &  record )

inherited

Is called by LogCore singleton whenever a new log record is written.

Parameters

record

The log entry.

resetFilter()

void resetFilter ( )

inlineinherited

Resets the log filter.

No filter will be used to filter log entries.

setFilter()

LogFilterPtr setFilter ( const T &  filter )

inlineinherited

Set the filter.

The filter must be copy constructible since we are creating a copy and inherited from LogFilterBase.

Parameters

filter

The filter object

resetFormatter()

void resetFormatter ( )

inlineinherited

Resets the formatter.

No formatter will be used to format log entries.

setFormatter()

LogFormatterPtr setFormatter ( const T &  formatter )

inlineinherited

Set the formatter.

The formatter must be copy constructible since we are creating a copy and inherited from LogFormatterBase.

Parameters

formatter

The formatter object

Member Data Documentation

mStream

std::ostream& mStream

protected

mFormatter

LogFormatterPtr mFormatter

protectedinherited

mFilter

LogFilterPtr mFilter

protectedinherited

---

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

• base/include/error/LogTxtStreamSink.h