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

A daily file sink. More...

#include <elogger.h>

Inheritance diagram for ELoggerSinkDailyFile:
ELoggerSink

Public Member Functions

 ELoggerSinkDailyFile (ELogger::LogLevel loglevel, cpStr pattern, cpStr filename, Bool truncate, Int rolloverhour, Int rolloverminute)
 Class constructor. More...
 
virtual ~ELoggerSinkDailyFile ()
 Class destructor. More...
 
EStringgetFilename ()
 Retrieves the log file name. More...
 
Bool getTruncate ()
 Retrieves the truncate flag. More...
 
Int getRolloverHour ()
 Retrieves the hour during the day when the rollover will occur. More...
 
Int getRolloverMinute ()
 Retrieves the minute within the hour when the rollover will occur. 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...
 
EStringgetPattern ()
 Retrieves the log message formatting pattern. More...
 
ELogger::LogLevel setLogLevel (ELogger::LogLevel loglevel)
 Assigns the sink log level. 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
}
 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 daily file sink.

Constructor & Destructor Documentation

◆ ELoggerSinkDailyFile()

ELoggerSinkDailyFile::ELoggerSinkDailyFile ( ELogger::LogLevel  loglevel,
cpStr  pattern,
cpStr  filename,
Bool  truncate,
Int  rolloverhour,
Int  rolloverminute 
)

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.
rolloverhourthe hour during the day when the rollover will occur.
rolloverminutethe minute within the hour when the rollover will occur.

◆ ~ELoggerSinkDailyFile()

virtual ELoggerSinkDailyFile::~ELoggerSinkDailyFile ( )
inlinevirtual

Class destructor.

Member Function Documentation

◆ getFilename()

EString& ELoggerSinkDailyFile::getFilename ( )
inline

Retrieves the log file name.

Returns
the log file name.

◆ getRolloverHour()

Int ELoggerSinkDailyFile::getRolloverHour ( )
inline

Retrieves the hour during the day when the rollover will occur.

Returns
the hour during the day when the rollover will occur.

◆ getRolloverMinute()

Int ELoggerSinkDailyFile::getRolloverMinute ( )
inline

Retrieves the minute within the hour when the rollover will occur.

Returns
the minute within the hour when the rollover will occur.

◆ getTruncate()

Bool ELoggerSinkDailyFile::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: