GNU CommonC++
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
ost::AppLog Class Reference

Application logger is a class that implements a logger that can be used by applications to save log file somewhere on the system. More...

#include <applog.h>

Inheritance diagram for ost::AppLog:

Classes

class  Ident
 Ident class that represents module name. More...
 

Public Member Functions

 AppLog (const char *logFileName=NULL, bool logDirectly=false, bool usePipe=false)
 Constructor for a customized logger. More...
 
virtual ~AppLog ()
 Destructor. More...
 
void subscribe ()
 Subscribes the current thread to logger, it reserves thread safe buffer for it. More...
 
void unsubscribe ()
 Unsubscribes the current thread from logger. More...
 
void logFileName (const char *FileName, bool logDirectly=false, bool usePipe=false)
 Allows to set up ost::alog parameters. More...
 
void close (void)
 if logDirectly is set it closes the file. More...
 
void level (Slog::Level enable)
 Sets the log level. More...
 
void clogEnable (bool en=true)
 Enables clog output. More...
 
void slogEnable (bool en=true)
 Enables slog output for error level messages. More...
 
void identLevel (const char *ident, Slog::Level level)
 Sets the level for that ident. More...
 
void open (const char *ident)
 Opens the file if not already and sets ident. More...
 
virtual int overflow (int c)
 stream overflow() overload. More...
 
virtual int sync ()
 stream sync() overload More...
 
void emerg (const char *format,...)
 emerg level printf style method, provided for convenience. More...
 
void alert (const char *format,...)
 alert level printf style method, provided for convenience. More...
 
void critical (const char *format,...)
 critical level printf style method, provided for convenience. More...
 
void error (const char *format,...)
 error level printf style method, provided for convenience. More...
 
void warn (const char *format,...)
 warn level printf style method, provided for convenience. More...
 
void notice (const char *format,...)
 notice level printf style method, provided for convenience. More...
 
void info (const char *format,...)
 info level printf style method, provided for convenience. More...
 
void debug (const char *format,...)
 debug level printf style method, provided for convenience. More...
 
AppLogoperator() (const char *ident, Slog::Level level=Slog::levelError)
 operator to change ident and log level More...
 
AppLogoperator() (Ident &ident)
 operator to change ident More...
 
AppLogoperator() (Slog::Level level)
 operator to change logging level More...
 
AppLogoperator<< (AppLog &(*pfManipulator)(AppLog &))
 manipulator operator, to change print levels. More...
 
AppLogoperator<< (ostream &(*pfManipulator)(ostream &))
 manipulator operator, to use ostream manipulators (i.e. More...
 
AppLogoperator<< (Ident &ident)
 operator << More...
 
AppLogwarn (void)
 warn level More...
 
AppLogerror (void)
 error level More...
 
AppLogdebug (void)
 debug level More...
 
AppLogemerg (void)
 emerg level More...
 
AppLogalert (void)
 alert level More...
 
AppLogcritical (void)
 critical level More...
 
AppLognotice (void)
 notice level More...
 
AppLoginfo (void)
 info level More...
 

Static Public Member Functions

static Slog::Level levelTranslate (string name)
 Translates level from string to Slog::Level, useful for configuration files for instance. More...
 

Protected Member Functions

void writeLog (bool endOfLine=true)
 

Protected Attributes

AppLogPrivate * d
 

Static Protected Attributes

static map< string, Slog::Level > * assoc
 

Friends

ostream & operator<< (ostream &out, AppLog &al)
 

Detailed Description

Application logger is a class that implements a logger that can be used by applications to save log file somewhere on the system.

It uses ost::slog to write to syslog and std::clog to write to standard output.

It provides either a stream oriented logger or a old printf style one.

It can be used to log directly on a file or in a spooler like way. Latter uses a ost::ThreadQueue to implement a thread safe access to logger.

It provides a global stream variable called ost::alog.

It provides an AppLog::Ident class that represents a module name for instance that can be used to tag logs. Logging levels are the same defined into ost::Slog: Slog::levelEmergency Slog::levelAlert Slog::levelCritical Slog::levelError Slog::levelWarning Slog::levelNotice Slog::levelInfo Slog::levelDebugfrom.

Example of usage: alog << mod_name << debug << "Hello world!" << std::endl;

Constructor & Destructor Documentation

◆ AppLog()

ost::AppLog::AppLog ( const char *  logFileName = NULL,
bool  logDirectly = false,
bool  usePipe = false 
)

Constructor for a customized logger.

Parameters
logFileNamelog file name.
logDirectlytrue to write directly to file, false to use a spooler like logger.
usePipetrue to use pipe instead of file, false otherwise

◆ ~AppLog()

virtual ost::AppLog::~AppLog ( )
virtual

Destructor.

Member Function Documentation

◆ alert() [1/2]

void ost::AppLog::alert ( const char *  format,
  ... 
)

alert level printf style method, provided for convenience.

Parameters
formatprintf format

◆ alert() [2/2]

AppLog& ost::AppLog::alert ( void  )
inline

alert level

Returns
application logger stream

◆ clogEnable()

void ost::AppLog::clogEnable ( bool  en = true)

Enables clog output.

Parameters
entrue to enable clog output.

◆ close()

void ost::AppLog::close ( void  )

if logDirectly is set it closes the file.

◆ critical() [1/2]

void ost::AppLog::critical ( const char *  format,
  ... 
)

critical level printf style method, provided for convenience.

Parameters
formatprintf format

◆ critical() [2/2]

AppLog& ost::AppLog::critical ( void  )
inline

critical level

Returns
application logger stream

◆ debug() [1/2]

void ost::AppLog::debug ( const char *  format,
  ... 
)

debug level printf style method, provided for convenience.

Parameters
formatprintf format

◆ debug() [2/2]

AppLog& ost::AppLog::debug ( void  )
inline

debug level

Returns
application logger stream

◆ emerg() [1/2]

void ost::AppLog::emerg ( const char *  format,
  ... 
)

emerg level printf style method, provided for convenience.

Parameters
formatprintf format

◆ emerg() [2/2]

AppLog& ost::AppLog::emerg ( void  )
inline

emerg level

Returns
application logger stream

◆ error() [1/2]

void ost::AppLog::error ( const char *  format,
  ... 
)

error level printf style method, provided for convenience.

Parameters
formatprintf format

◆ error() [2/2]

AppLog& ost::AppLog::error ( void  )
inline

error level

Returns
application logger stream

◆ identLevel()

void ost::AppLog::identLevel ( const char *  ident,
Slog::Level  level 
)

Sets the level for that ident.

Parameters
identident (module name for instance).
levellevel

◆ info() [1/2]

void ost::AppLog::info ( const char *  format,
  ... 
)

info level printf style method, provided for convenience.

Parameters
formatprintf format

◆ info() [2/2]

AppLog& ost::AppLog::info ( void  )
inline

info level

Returns
application logger stream

◆ level()

void ost::AppLog::level ( Slog::Level  enable)

Sets the log level.

Parameters
enablelog level.

◆ levelTranslate()

static Slog::Level ost::AppLog::levelTranslate ( string  name)
inlinestatic

Translates level from string to Slog::Level, useful for configuration files for instance.

Valid level names are: "emerg" for Slog::levelEmergency "alert" for Slog::levelAlert "critical" for Slog::levelCritical "error" for Slog::levelError "warn" for Slog::levelWarning "notice" for Slog::levelNotice "info" for Slog::levelInfo "debug" for Slog::levelDebug

Parameters
nameSlog Level name
Returns
Slog level value

◆ logFileName()

void ost::AppLog::logFileName ( const char *  FileName,
bool  logDirectly = false,
bool  usePipe = false 
)

Allows to set up ost::alog parameters.

Parameters
FileNamelog file name.
logDirectlytrue to write directly to file, false to use a spooler like logger.
usePipetrue to use pipe instead of file, false otherwise

◆ notice() [1/2]

void ost::AppLog::notice ( const char *  format,
  ... 
)

notice level printf style method, provided for convenience.

Parameters
formatprintf format

◆ notice() [2/2]

AppLog& ost::AppLog::notice ( void  )
inline

notice level

Returns
application logger stream

◆ open()

void ost::AppLog::open ( const char *  ident)

Opens the file if not already and sets ident.

Parameters
identmodule name for instance.

◆ operator()() [1/3]

AppLog& ost::AppLog::operator() ( const char *  ident,
Slog::Level  level = Slog::levelError 
)

operator to change ident and log level

Parameters
identident (module name for instance)
levelnew log level
Returns
application logger stream

◆ operator()() [2/3]

AppLog& ost::AppLog::operator() ( Ident ident)
inline

operator to change ident

Parameters
identident (module name for instance)
Returns
application logger stream

References ost::AppLog::Ident::c_str().

◆ operator()() [3/3]

AppLog& ost::AppLog::operator() ( Slog::Level  level)

operator to change logging level

Parameters
levelnew log level
Returns
application logger stream

◆ operator<<() [1/3]

AppLog& ost::AppLog::operator<< ( AppLog &(*)(AppLog &)  pfManipulator)

manipulator operator, to change print levels.

Parameters
(*pfManipulator)(AppLog &)
Returns
application logger stream

◆ operator<<() [2/3]

AppLog& ost::AppLog::operator<< ( Ident ident)
inline

operator <<

Parameters
identmodule name for instance.
Returns
application logger stream

References ost::AppLog::Ident::c_str().

◆ operator<<() [3/3]

AppLog& ost::AppLog::operator<< ( ostream &(*)(ostream &)  pfManipulator)

manipulator operator, to use ostream manipulators (i.e.

std::endl,...)

Parameters
(*pfManipulator)(AppLog &)
Returns
application logger stream

◆ overflow()

virtual int ost::AppLog::overflow ( int  c)
virtual

stream overflow() overload.

Parameters
ccharacter to be managed
Returns
c

◆ slogEnable()

void ost::AppLog::slogEnable ( bool  en = true)

Enables slog output for error level messages.

Parameters
entrue to enable slog output.

◆ subscribe()

void ost::AppLog::subscribe ( )

Subscribes the current thread to logger, it reserves thread safe buffer for it.

◆ sync()

virtual int ost::AppLog::sync ( )
virtual

stream sync() overload

◆ unsubscribe()

void ost::AppLog::unsubscribe ( )

Unsubscribes the current thread from logger.

◆ warn() [1/2]

void ost::AppLog::warn ( const char *  format,
  ... 
)

warn level printf style method, provided for convenience.

Parameters
formatprintf format

◆ warn() [2/2]

AppLog& ost::AppLog::warn ( void  )
inline

warn level

Returns
application logger stream

◆ writeLog()

void ost::AppLog::writeLog ( bool  endOfLine = true)
protected

Friends And Related Function Documentation

◆ operator<<

ostream& operator<< ( ostream &  out,
AppLog al 
)
friend

Member Data Documentation

◆ assoc

map<string, Slog::Level>* ost::AppLog::assoc
staticprotected

◆ d

AppLogPrivate* ost::AppLog::d
protected

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