Thread-safe message logger. More...

#include <JMessageLogger.hh>

Inheritance diagram for JLOGGER::JMessageLoggerThreadSafe:

Public Types
enum	JLevel_t { OFF = -1, ERROR = 0, STATUS = 0, WARNING = 1, NOTICE = 2, DEBUG = 3 }

typedef std::string	JMessage_t

Public Member Functions
	JMessageLoggerThreadSafe ()
	Default constructor. More...

	JMessageLoggerThreadSafe (JLogger *__logger, const std::string &__name, const int __level=ERROR)
	Constructor. More...

virtual void	typeout (const std::string &tag, const std::string &message) override
	Report message. More...

void	reset (JLogger *__logger=NULL)
	Reset logger. More...

JLevel_t	getLevel ()
	Get debug level. More...

void	setLevel (const int __level)
	Set debug level. More...

void	setLevel (const JLevel_t __level)
	Set debug level. More...

bool	is_valid () const
	Check validity of logger object. More...

void	debug (const JMessage_t &message)

void	warning (const JMessage_t &message)

void	error (const JMessage_t &message)

void	notice (const JMessage_t &message)

void	status (const JMessage_t &message)

JSYNCHRONIZATION::JMutex &	mutex ()
	Provides internal lock object. More...

Protected Member Functions
void	typeout (const JLevel_t __level, const char *__prefix, const JMessage_t &__message)
	Report message. More...

Protected Attributes
JSharedPointer< JLogger >	logger

std::string	host

std::string	name

JLevel_t	level

Detailed Description

Thread-safe message logger.

This class aims to provide a thread-safe alternative to the JMessageLogger class. Indeed it can transparently replace a JMessageLogger object to be used in multi-thread environment.

Definition at line 240 of file JMessageLogger.hh.

Member Typedef Documentation

typedef std::string JLOGGER::JMessageLogger::JMessage_t

inherited

Definition at line 67 of file JMessageLogger.hh.

Member Enumeration Documentation

enum JLOGGER::JMessageLogger::JLevel_t

inherited

Enumerator
OFF	No logging of messages.
ERROR	Error; always logged.
STATUS	Status; always logged.
WARNING	Warning.
NOTICE	Notice.
DEBUG	Debug.

Definition at line 58 of file JMessageLogger.hh.

                   {
       OFF     = -1,   //!< No logging of messages
       ERROR   = 0,    //!< Error;   always logged
       STATUS  = 0,    //!< Status;  always logged
       WARNING = 1,    //!< Warning
       NOTICE  = 2,    //!< Notice
       DEBUG   = 3     //!< Debug
     };

Constructor & Destructor Documentation

JLOGGER::JMessageLoggerThreadSafe::JMessageLoggerThreadSafe ( )

inline

Default constructor.

Definition at line 248 of file JMessageLogger.hh.

                                :
       JMessageLogger()
     {}

JLOGGER::JMessageLoggerThreadSafe::JMessageLoggerThreadSafe	(	JLogger *	__logger,
		const std::string &	__name,
		const int	__level = `ERROR`
	)

inline

Constructor.

Parameters

__logger	pointer to logger
__name	name
__level	debug level

Definition at line 260 of file JMessageLogger.hh.

                                                                  :
       JMessageLogger(__logger, __name, __level)
     {}

Member Function Documentation

virtual void JLOGGER::JMessageLoggerThreadSafe::typeout	(	const std::string &	tag,
		const std::string &	message
	)

inlineoverridevirtual

Report message.

Parameters

tag	tag
message	message

Reimplemented from JLOGGER::JMessageLogger.

Definition at line 273 of file JMessageLogger.hh.

     {
       JSYNCHRONIZATION::JMutex::JScopedLock lock(logger->mutex());
       logger->typeout(tag, message);
     }

void JLOGGER::JMessageLogger::reset ( JLogger * __logger = NULL )

inlineinherited

Reset logger.

Parameters

__logger pointer to logger

Definition at line 106 of file JMessageLogger.hh.

     {
       logger.reset(__logger);
     }

JLevel_t JLOGGER::JMessageLogger::getLevel ( )

inlineinherited

Get debug level.

Returns: debug level

Definition at line 117 of file JMessageLogger.hh.

     {
       return level;
     }

void JLOGGER::JMessageLogger::setLevel ( const int __level )

inlineinherited

Set debug level.

Parameters

__level debug level

Definition at line 128 of file JMessageLogger.hh.

     {
       if      (__level <  0)
         level = OFF;
       else if (__level == 0)
         level = ERROR;
       else if (__level == 1)
         level = WARNING;
       else if (__level == 2)
         level = NOTICE;
       else
         level = DEBUG;
     }

void JLOGGER::JMessageLogger::setLevel ( const JLevel_t __level )

inlineinherited

Set debug level.

Parameters

__level debug level

Definition at line 148 of file JMessageLogger.hh.

     {
       level = __level;
     }

bool JLOGGER::JMessageLogger::is_valid ( ) const

inlineinherited

Check validity of logger object.

This operator returns the state of the logger object. The object is valid if the logger object is ready for use, else the object is in-valid. In case the object is in-valid, no messages will be reported.

Returns: true if logger ready for use; else false

Definition at line 163 of file JMessageLogger.hh.

     {
       return logger.is_valid();
     }

void JLOGGER::JMessageLogger::typeout	(	const JLevel_t	__level,
		const char *	__prefix,
		const JMessage_t &	__message
	)

inlineprotectedinherited

Report message.

Parameters

__level	level
__prefix	prefix
__message	message

Definition at line 200 of file JMessageLogger.hh.

     {
       if (is_valid() && __level <= level && !__message.empty()) {
 
         JMessage_t message;
 
         message += getDateAndTime();
 
         message += " ";
         message += host;
 
         message += " ";
         message += name;
 
         message += " ";
         message += __prefix;
 
         message += " ";
         message += __message;
 
         typeout(MESSAGE_TAG, message);
       }
     }