ELoggerSink Class Reference

Represents a logger output sink. More...

#include <elogger.h>

Inheritance diagram for ELoggerSink:

Public Types
enum	SinkType {   eSyslog, eStdout, eStderr, eBasicFile,   eRotatingFile, eDailyFile, eRingBuffer }
	Defines the type of output sinks. More...

Public Member Functions
virtual	~ELoggerSink ()
	Class destructor. More...
SinkType	getSinkType ()
	Retrieves the sink type. More...
ELogger::LogLevel	getLogLevel ()
	Retrieves the log level for this sink. More...
EString	getLogLevelName () const
	Retrieve the name of the currently assigned log level. More...
EString &	getPattern ()
	Retrieves the log message formatting pattern. More...
ELogger::LogLevel	setLogLevel (ELogger::LogLevel loglevel)
	Assigns the sink log level. More...
ELogger::LogLevel	setLogLevel (cpStr lvl_name)
	Assign a log level for this sink from a log level name. More...
EString &	setPattern (cpStr pattern)
	Assigns the log message formatting pattern. More...
spdlog::sink_ptr	getSinkPtr ()
	Retrieves the underlying spdlog sink pointer. More...

Static Public Member Functions
static EString &	getDefaultPattern ()
	Retrieves the default log message formatting pattern. More...

Protected Member Functions
	ELoggerSink (SinkType sinktype, ELogger::LogLevel loglevel, cpStr pattern)
	The base class constructor. More...
spdlog::sink_ptr	setSinkPtr (spdlog::sink_ptr &sinkptr)
	Assigns the spdlog pointer value. More...

Detailed Description

Represents a logger output sink.

Member Enumeration Documentation

enum ELoggerSink::SinkType

Defines the type of output sinks.

Enumerator
eSyslog	syslog
eStdout	standard output
eStderr	standard error
eBasicFile	a simple file
eRotatingFile	a rotating set of files
eDailyFile	a file that rolls over each day at a specified time
eRingBuffer	a ring buffer that contains n items

Constructor & Destructor Documentation

virtual ELoggerSink::~ELoggerSink ( )

inlinevirtual

Class destructor.

ELoggerSink::ELoggerSink ( SinkType  sinktype, ELogger::LogLevel  loglevel, cpStr  pattern  )

inlineprotected

The base class constructor.

Parameters

sinktype	the sink type.
loglevel	the log level for this sink.
pattern	the log message formatting pattern.

Member Function Documentation

static EString& ELoggerSink::getDefaultPattern ( )

inlinestatic

Retrieves the default log message formatting pattern.

Returns

the default log message formatting pattern.

ELogger::LogLevel ELoggerSink::getLogLevel ( )

inline

Retrieves the log level for this sink.

Returns

the sink log level.

EString ELoggerSink::getLogLevelName

(

)

const

Retrieve the name of the currently assigned log level.

Returns

the current log level name.

EString& ELoggerSink::getPattern ( )

inline

Retrieves the log message formatting pattern.

Returns

the log message formatting pattern.

spdlog::sink_ptr ELoggerSink::getSinkPtr ( )

inline

Retrieves the underlying spdlog sink pointer.

Returns

the underlying spdlog sink pointer.

SinkType ELoggerSink::getSinkType ( )

inline

Retrieves the sink type.

Returns

the sink type.

ELogger::LogLevel ELoggerSink::setLogLevel ( ELogger::LogLevel  loglevel )

inline

Assigns the sink log level.

Parameters

loglevel

the new sink log level.

Returns

the assigned sink log level.

ELogger::LogLevel ELoggerSink::setLogLevel ( cpStr  lvl_name )

inline

Assign a log level for this sink from a log level name.

Parameters

lvl_name

the log level name to assign.

EString& ELoggerSink::setPattern ( cpStr  pattern )

inline

Assigns the log message formatting pattern.

Parameters

pattern

the log message formatting pattern.

Returns

the log message formatting pattern.

spdlog::sink_ptr ELoggerSink::setSinkPtr ( spdlog::sink_ptr &  sinkptr )

inlineprotected

Assigns the spdlog pointer value.

Parameters

sinkptr

the spdlog pointer value.

Returns

the spdlog pointer value.

---

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

• /home/vagrant/share/code/epctoolsbw2/include/epc/elogger.h
• /home/vagrant/share/code/epctoolsbw2/src/elogger.cpp