JLOGGER::JMessageLogger Class Reference

Message logger. More...

#include <JMessageLogger.hh>

Inheritance diagram for JLOGGER::JMessageLogger:

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
	JMessageLogger ()
	Default constructor.
	JMessageLogger (JLogger *__logger, const std::string &__name, const int __level=ERROR)
	Constructor.
void	reset (JLogger *__logger=NULL)
	Reset logger.
JLevel_t	getLevel ()
	Get debug level.
void	setLevel (const int __level)
	Set debug level.
void	setLevel (const JLevel_t __level)
	Set debug level.
	operator bool () const
	Check validity of logger object.
virtual void	typeout (const std::string &tag, const std::string &message) override
	Report message.
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.

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

Protected Attributes
std::shared_ptr< JLogger >	logger
std::string	host
std::string	name
JLevel_t	level

Private Attributes
JSYNCHRONIZATION::JMutex	m_mutex

Detailed Description

Message logger.

The class implements the following message functions:

• debug();
• warning();
• error();
• status();
• notice();

The argument of these messages is an STL string.
The message reported consists of <date time> <host name> <process name> <prefix> <message>
where the prefix is "DEBUG", "WARNING", "ERROR", "STATUS" or "NOTICE".
A debug level can be specified which is used to filter the message types for reporting.
The level OFF will cause the message logger to stop reporting any messages.

Note that the JXXXStreamer classes can be used for STL ostream compatible message logging (see JMessageStream.hh).

Definition at line 52 of file JMessageLogger.hh.

Member Typedef Documentation

JMessage_t

std::string JLOGGER::JMessageLogger::JMessage_t

Definition at line 66 of file JMessageLogger.hh.

Member Enumeration Documentation

JLevel_t

enum JLOGGER::JMessageLogger::JLevel_t

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

Definition at line 57 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

JMessageLogger() [1/2]

JLOGGER::JMessageLogger::JMessageLogger ( )

inline

Default constructor.

Definition at line 72 of file JMessageLogger.hh.

                     :
      logger(),
      host  (getIPaddress()),
      name  ("<unknown>")
    {
      setLevel(OFF);
    }

JMessageLogger() [2/2]

JLOGGER::JMessageLogger::JMessageLogger ( 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 88 of file JMessageLogger.hh.

                                                       :
      host  (getIPaddress()),
      name  (__name)
    {
      logger.reset(__logger);
 
      setLevel(__level);
    }

Member Function Documentation

reset()

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

inline

Reset logger.

Parameters

__logger

pointer to logger

Definition at line 105 of file JMessageLogger.hh.

    {
      logger.reset(__logger);
    }

getLevel()

JLevel_t JLOGGER::JMessageLogger::getLevel ( )

inline

Get debug level.

Returns

debug level

Definition at line 116 of file JMessageLogger.hh.

    {
      return level;
    }

setLevel() [1/2]

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

inline

Set debug level.

Parameters

__level

debug level

Definition at line 127 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;
    }

setLevel() [2/2]

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

inline

Set debug level.

Parameters

__level

debug level

Definition at line 147 of file JMessageLogger.hh.

    {
      level = __level;
    }

operator bool()

JLOGGER::JMessageLogger::operator bool ( ) const

inline

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 162 of file JMessageLogger.hh.

    {
      return (bool) logger;
    }

typeout() [1/2]

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

inlineoverridevirtual

Report message.

Parameters

tag	tag
message	message

Implements JLOGGER::JLogger.

Reimplemented in JLOGGER::JMessageLoggerThreadSafe, and JLOGGER::JMessageScheduler.

Definition at line 174 of file JMessageLogger.hh.

    {
      logger->typeout(tag, message);
    }

debug()

void JLOGGER::JMessageLogger::debug ( const JMessage_t & message )

inline

Definition at line 183 of file JMessageLogger.hh.

{ TYPEOUT(DEBUG,   message); }

warning()

void JLOGGER::JMessageLogger::warning ( const JMessage_t & message )

inline

Definition at line 184 of file JMessageLogger.hh.

{ TYPEOUT(WARNING, message); }

error()

void JLOGGER::JMessageLogger::error ( const JMessage_t & message )

inline

Definition at line 185 of file JMessageLogger.hh.

{ TYPEOUT(ERROR,   message); }

notice()

void JLOGGER::JMessageLogger::notice ( const JMessage_t & message )

inline

Definition at line 186 of file JMessageLogger.hh.

{ TYPEOUT(NOTICE,  message); }

status()

void JLOGGER::JMessageLogger::status ( const JMessage_t & message )

inline

Definition at line 187 of file JMessageLogger.hh.

{ TYPEOUT(STATUS,  message); }

typeout() [2/2]

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

inlineprotected

Report message.

Parameters

__level	level
__prefix	prefix
__message	message

Definition at line 199 of file JMessageLogger.hh.

    {
      if (logger && __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);
      }
    }

mutex()

JSYNCHRONIZATION::JMutex & JLOGGER::JLogger::mutex ( )

inlineinherited

Provides internal lock object.

Returns

reference to the internal mutex object.

Definition at line 44 of file JLogger.hh.

    {
      return m_mutex;
    }

Member Data Documentation

logger

std::shared_ptr<JLogger> JLOGGER::JMessageLogger::logger

protected

Definition at line 226 of file JMessageLogger.hh.

host

std::string JLOGGER::JMessageLogger::host

protected

Definition at line 227 of file JMessageLogger.hh.

name

std::string JLOGGER::JMessageLogger::name

protected

Definition at line 228 of file JMessageLogger.hh.

level

JLevel_t JLOGGER::JMessageLogger::level

protected

Definition at line 229 of file JMessageLogger.hh.

m_mutex

JSYNCHRONIZATION::JMutex JLOGGER::JLogger::m_mutex

privateinherited

Definition at line 51 of file JLogger.hh.

---

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

• JMessageLogger.hh