Jpp  15.0.0
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
JLOGGER::JMessageLoggerThreadSafe Class Reference

Thread-safe message logger. More...

#include <JMessageLogger.hh>

Inheritance diagram for JLOGGER::JMessageLoggerThreadSafe:
JLOGGER::JMessageLogger JLOGGER::JLogger

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::JMutexmutex ()
 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< JLoggerlogger
 
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

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.

58  {
59  OFF = -1, //!< No logging of messages
60  ERROR = 0, //!< Error; always logged
61  STATUS = 0, //!< Status; always logged
62  WARNING = 1, //!< Warning
63  NOTICE = 2, //!< Notice
64  DEBUG = 3 //!< Debug
65  };
Status; always logged.
Error; always logged.
No logging of messages.

Constructor & Destructor Documentation

JLOGGER::JMessageLoggerThreadSafe::JMessageLoggerThreadSafe ( )
inline

Default constructor.

Definition at line 248 of file JMessageLogger.hh.

248  :
250  {}
JMessageLogger()
Default constructor.
JLOGGER::JMessageLoggerThreadSafe::JMessageLoggerThreadSafe ( JLogger __logger,
const std::string &  __name,
const int  __level = ERROR 
)
inline

Constructor.

Parameters
__loggerpointer to logger
__namename
__leveldebug level

Definition at line 260 of file JMessageLogger.hh.

262  :
263  JMessageLogger(__logger, __name, __level)
264  {}
JMessageLogger()
Default constructor.

Member Function Documentation

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

Report message.

Parameters
tagtag
messagemessage

Reimplemented from JLOGGER::JMessageLogger.

Definition at line 273 of file JMessageLogger.hh.

275  {
277  logger->typeout(tag, message);
278  }
JSharedPointer< JLogger > logger
void JLOGGER::JMessageLogger::reset ( JLogger __logger = NULL)
inlineinherited

Reset logger.

Parameters
__loggerpointer to logger

Definition at line 106 of file JMessageLogger.hh.

107  {
108  logger.reset(__logger);
109  }
JSharedPointer< JLogger > logger
JLevel_t JLOGGER::JMessageLogger::getLevel ( )
inlineinherited

Get debug level.

Returns
debug level

Definition at line 117 of file JMessageLogger.hh.

118  {
119  return level;
120  }
void JLOGGER::JMessageLogger::setLevel ( const int  __level)
inlineinherited

Set debug level.

Parameters
__leveldebug level

Definition at line 128 of file JMessageLogger.hh.

129  {
130  if (__level < 0)
131  level = OFF;
132  else if (__level == 0)
133  level = ERROR;
134  else if (__level == 1)
135  level = WARNING;
136  else if (__level == 2)
137  level = NOTICE;
138  else
139  level = DEBUG;
140  }
Error; always logged.
No logging of messages.
void JLOGGER::JMessageLogger::setLevel ( const JLevel_t  __level)
inlineinherited

Set debug level.

Parameters
__leveldebug level

Definition at line 148 of file JMessageLogger.hh.

149  {
150  level = __level;
151  }
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.

164  {
165  return logger.is_valid();
166  }
JSharedPointer< JLogger > logger
void JLOGGER::JMessageLogger::typeout ( const JLevel_t  __level,
const char *  __prefix,
const JMessage_t __message 
)
inlineprotectedinherited

Report message.

Parameters
__levellevel
__prefixprefix
__messagemessage

Definition at line 200 of file JMessageLogger.hh.

203  {
204  if (is_valid() && __level <= level && !__message.empty()) {
205 
206  JMessage_t message;
207 
208  message += getDateAndTime();
209 
210  message += " ";
211  message += host;
212 
213  message += " ";
214  message += name;
215 
216  message += " ";
217  message += __prefix;
218 
219  message += " ";
220  message += __message;
221 
222  typeout(MESSAGE_TAG, message);
223  }
224  }
static const std::string MESSAGE_TAG
Message logging tag.
static JDateAndTime getDateAndTime
Function object to get ASCII formatted date and time.
virtual void typeout(const std::string &tag, const std::string &message) override
Report message.
bool is_valid() const
Check validity of logger object.
void JLOGGER::JMessageLogger::debug ( const JMessage_t message)
inlineinherited

Definition at line 184 of file JMessageLogger.hh.

184 { TYPEOUT(DEBUG, message); }
#define TYPEOUT(LEVEL, MESSAGE)
void JLOGGER::JMessageLogger::warning ( const JMessage_t message)
inlineinherited

Definition at line 185 of file JMessageLogger.hh.

185 { TYPEOUT(WARNING, message); }
#define TYPEOUT(LEVEL, MESSAGE)
void JLOGGER::JMessageLogger::error ( const JMessage_t message)
inlineinherited

Definition at line 186 of file JMessageLogger.hh.

186 { TYPEOUT(ERROR, message); }
#define TYPEOUT(LEVEL, MESSAGE)
Error; always logged.
void JLOGGER::JMessageLogger::notice ( const JMessage_t message)
inlineinherited

Definition at line 187 of file JMessageLogger.hh.

187 { TYPEOUT(NOTICE, message); }
#define TYPEOUT(LEVEL, MESSAGE)
void JLOGGER::JMessageLogger::status ( const JMessage_t message)
inlineinherited

Definition at line 188 of file JMessageLogger.hh.

188 { TYPEOUT(STATUS, message); }
#define TYPEOUT(LEVEL, MESSAGE)
Status; always logged.
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.

45  {
46  return m_mutex;
47  }
JSYNCHRONIZATION::JMutex m_mutex
Definition: JLogger.hh:51

Member Data Documentation

JSharedPointer<JLogger> JLOGGER::JMessageLogger::logger
protectedinherited

Definition at line 227 of file JMessageLogger.hh.

std::string JLOGGER::JMessageLogger::host
protectedinherited

Definition at line 228 of file JMessageLogger.hh.

std::string JLOGGER::JMessageLogger::name
protectedinherited

Definition at line 229 of file JMessageLogger.hh.

JLevel_t JLOGGER::JMessageLogger::level
protectedinherited

Definition at line 230 of file JMessageLogger.hh.


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