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

A basic file sink. More...

#include <elogger.h>

Inheritance diagram for ELoggerSinkBasicFile:
ELoggerSink

Public Member Functions

 ELoggerSinkBasicFile (ELogger::LogLevel loglevel, cpStr pattern, cpStr filename, Bool truncate)
 Class constructor. More...
 
virtual ~ELoggerSinkBasicFile ()
 Class destructor. More...
 
EStringgetFilename ()
 Retrieves the log file name. More...
 
Bool getTruncate ()
 Retrieves the truncate flag. 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 basic file sink.

Constructor & Destructor Documentation

ELoggerSinkBasicFile::ELoggerSinkBasicFile ( ELogger::LogLevel  loglevel,
cpStr  pattern,
cpStr  filename,
Bool  truncate 
)

Class constructor.

Parameters
loglevelthe sink log level.
patternthe log message formatting pattern.
filenamethe log file name.
truncateindicates if the log file should be truncated if it already exists.
virtual ELoggerSinkBasicFile::~ELoggerSinkBasicFile ( )
inlinevirtual

Class destructor.

Member Function Documentation

EString& ELoggerSinkBasicFile::getFilename ( )
inline

Retrieves the log file name.

Returns
the log file name.
Bool ELoggerSinkBasicFile::getTruncate ( )
inline

Retrieves the truncate flag.

Returns
True will cause the file to truncated when it is opened, otherwise False.

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