EpcTools
An event based multi-threaded C++ development framework.
Public Member Functions | List of all members
ELoggerSinkRingBuffer Class Reference

A ring buffer sink. More...

#include <elogger.h>

Inheritance diagram for ELoggerSinkRingBuffer:
ELoggerSink

Public Member Functions

 ELoggerSinkRingBuffer (ELogger::LogLevel loglevel, cpStr pattern, size_t nitems)
 Class constructor. More...
 
virtual ~ELoggerSinkRingBuffer ()
 Class destructor. More...
 
size_t getNumberItems ()
 Retrieves the number of items stored in the buffer. More...
 
std::vector< std::string > lastFormatted (size_t limit=0)
 Retrieves the last items stored in the buffer as formatted strings. More...
 
- Public Member Functions inherited from ELoggerSink
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...
 
EStringgetPattern ()
 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...
 
EStringsetPattern (cpStr pattern)
 Assigns the log message formatting pattern. More...
 
spdlog::sink_ptr getSinkPtr ()
 Retrieves the underlying spdlog sink pointer. More...
 

Additional Inherited Members

- Public Types inherited from ELoggerSink
enum  SinkType {
  eSyslog, eStdout, eStderr, eBasicFile,
  eRotatingFile, eDailyFile, eRingBuffer
}
 Defines the type of output sinks. More...
 
- Static Public Member Functions inherited from ELoggerSink
static EStringgetDefaultPattern ()
 Retrieves the default log message formatting pattern. More...
 
- Protected Member Functions inherited from ELoggerSink
 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

A ring buffer sink.

Constructor & Destructor Documentation

ELoggerSinkRingBuffer::ELoggerSinkRingBuffer ( ELogger::LogLevel  loglevel,
cpStr  pattern,
size_t  nitems 
)

Class constructor.

Parameters
loglevelthe sink log level.
patternthe log message formatting pattern.
nitemsthe number of items to store in the buffer.
virtual ELoggerSinkRingBuffer::~ELoggerSinkRingBuffer ( )
inlinevirtual

Class destructor.

Member Function Documentation

size_t ELoggerSinkRingBuffer::getNumberItems ( )
inline

Retrieves the number of items stored in the buffer.

Returns
the number of items.
std::vector< std::string > ELoggerSinkRingBuffer::lastFormatted ( size_t  limit = 0)

Retrieves the last items stored in the buffer as formatted strings.

Parameters
limitthe maximum number of items to retrieve.
Returns
A vector of strings of the last items stored in the buffer.

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