Message logger with time scheduler. More...

#include <JMessageScheduler.hh>

Inheritance diagram for JLOGGER::JMessageScheduler:

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
	JMessageScheduler ()
	Default constructor.

	JMessageScheduler (const JMessageLogger &logger, const JTimekeeper &timer)
	Constructor.

void	setCredit (const int credit)
	Set credit.

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

void	reset ()
	Reset.

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.

bool	is_valid () const
	Check validity of logger object.

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.

long long int	getInterval () const
	Get interval time.

long long int	getDelay () const
	Get total delay time.

void	setInterval (const long long int interval_us)
	Set interval time.

void	reset (const long long int t0)
	Reset time.

bool	operator() () const
	Check whether the number of time intervals has elapsed since the last call to the reset method.

void	wait () const
	Wait until the number of time intervals has elapsed since the last call to the reset method.

bool	wait (JFileDescriptorMask &mask) const
	Wait until the number of time intervals has elapsed since the last call to the reset method or input data have become available on one of the file descriptors in the given mask.

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

Protected Attributes
int	credit

JSharedPointer< JLogger >	logger

std::string	host

std::string	name

JLevel_t	level

long long int	interval
	interval time [us]

Private Attributes
JSYNCHRONIZATION::JMutex	m_mutex

long long int	t0
	t0 of elapsed time [us]

long long int	total_delay
	total delay time [us]

long long int	counter
	interval counter

Detailed Description

Message logger with time scheduler.

Messages will only be reported when the elapsed time since last message exceeds the specified time interval. The first message is always reported.

Definition at line 25 of file JMessageScheduler.hh.

Member Typedef Documentation

◆ JMessage_t

std::string JLOGGER::JMessageLogger::JMessage_t

inherited

Definition at line 67 of file JMessageLogger.hh.

Member Enumeration Documentation

◆ JLevel_t

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

◆ JMessageScheduler() [1/2]

JLOGGER::JMessageScheduler::JMessageScheduler ( )

inline

Default constructor.

Definition at line 33 of file JMessageScheduler.hh.

                        :
      JMessageLogger(),
      JTimekeeper   (),
      credit        (0)
    {}

◆ JMessageScheduler() [2/2]

JLOGGER::JMessageScheduler::JMessageScheduler	(	const JMessageLogger &	logger,
		const JTimekeeper &	timer )

inline

Constructor.

The time is reset so that the first message is sent any way.

Parameters

logger	logger
timer	timer

Definition at line 47 of file JMessageScheduler.hh.

                                                   :
      JMessageLogger(logger),
      JTimekeeper   (timer),
      credit        (1)
    {
      JTimekeeper::reset();
    }

Member Function Documentation

◆ setCredit()

void JLOGGER::JMessageScheduler::setCredit ( const int credit )

inline

Set credit.

Note that the maximal number of messages reported per interval time is equal to the credit which is set once at a time.

Parameters

credit credit

Definition at line 64 of file JMessageScheduler.hh.

    {
      this->credit = credit;
    }

◆ typeout() [1/2]

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

inlineoverridevirtual

Report message.

Parameters

tag	tag
message	message

Reimplemented from JLOGGER::JMessageLogger.

Definition at line 75 of file JMessageScheduler.hh.

    {
      if (JTimekeeper::operator()()) {
        reset();
      }
 
      if (credit != 0) {
 
        JMessageLogger::typeout(tag, message);
 
        --credit;
      }
    }

◆ reset() [1/3]

void JLOGGER::JMessageScheduler::reset ( )

inline

Reset.

Definition at line 94 of file JMessageScheduler.hh.

    {
      JTimekeeper::reset();
 
      credit = 1;
    }

◆ reset() [2/3]

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);
    }

◆ getLevel()

JLevel_t JLOGGER::JMessageLogger::getLevel ( )

inlineinherited

Get debug level.

Returns: debug level

Definition at line 117 of file JMessageLogger.hh.

    {
      return level;
    }

◆ setLevel() [1/2]

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;
    }

◆ setLevel() [2/2]

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;
    }

◆ is_valid()

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();
    }

◆ typeout() [2/2]

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);
      }
    }

◆ debug()

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

inlineinherited

Definition at line 184 of file JMessageLogger.hh.

184{ TYPEOUT(DEBUG, message); }

TYPEOUT

#define TYPEOUT(LEVEL, MESSAGE)

Definition JMessageLogger.hh:182

◆ warning()

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

inlineinherited

Definition at line 185 of file JMessageLogger.hh.

185{ TYPEOUT(WARNING, message); }

◆ error()

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

inlineinherited

Definition at line 186 of file JMessageLogger.hh.

186{ TYPEOUT(ERROR, message); }

◆ notice()

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

inlineinherited

Definition at line 187 of file JMessageLogger.hh.

187{ TYPEOUT(NOTICE, message); }

◆ status()

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

inlineinherited

Definition at line 188 of file JMessageLogger.hh.

188{ TYPEOUT(STATUS, 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;
    }

◆ getInterval()

long long int JEEP::JTimekeeper::getInterval ( ) const

inlineinherited

Get interval time.

Returns: interval time [us]

Definition at line 67 of file JTimekeeper.hh.

    {
      return interval;
    }

◆ getDelay()

long long int JEEP::JTimekeeper::getDelay ( ) const

inlineinherited

Get total delay time.

Returns: delay time [us]

Definition at line 78 of file JTimekeeper.hh.

    {
      return total_delay;
    }

◆ setInterval()

void JEEP::JTimekeeper::setInterval ( const long long int interval_us )

inlineinherited

Set interval time.

Parameters

interval_us interval time [us]

Definition at line 89 of file JTimekeeper.hh.

    {
      interval = interval_us;
    }

◆ reset() [3/3]

void JEEP::JTimekeeper::reset ( const long long int t0 )

inlineinherited

Reset time.

Parameters

t0 time [us]

Definition at line 100 of file JTimekeeper.hh.

    {
      this->t0          = t0;
      this->counter     = 0;
      this->total_delay = 0;
    }

◆ operator()()

bool JEEP::JTimekeeper::operator() ( ) const

inlineinherited

Check whether the number of time intervals has elapsed since the last call to the reset method.

The number of intervals is equal to the number of calls this method returned true since the last call to the reset method.

Returns: true if elapsed time exceeds interval time; else false

Definition at line 125 of file JTimekeeper.hh.

    {
      if (getLocalTime() >= t0 + (counter + 1) * interval) {
 
        ++counter;
 
        return true;
 
      } else
 
        return false;
    }

◆ wait() [1/2]

void JEEP::JTimekeeper::wait ( ) const

inlineinherited

Wait until the number of time intervals has elapsed since the last call to the reset method.

The number of intervals is equal to the number of calls to the method wait since the last call to the reset method.

Definition at line 145 of file JTimekeeper.hh.

    { 
      static const useconds_t MAXIMAL_SLEEP_TIME_US = std::numeric_limits<useconds_t>::max();
 
      long long int delay = t0  +  (counter + 1) * interval  -  getLocalTime();   // [us]
 
      while (delay > MAXIMAL_SLEEP_TIME_US && usleep(MAXIMAL_SLEEP_TIME_US) == 0) {
 
        total_delay += MAXIMAL_SLEEP_TIME_US;
        delay       -= MAXIMAL_SLEEP_TIME_US;
      }
 
      if (delay > 0 && usleep((useconds_t) delay) == 0) {
        total_delay += delay;
      }
 
      ++counter;
    }

◆ wait() [2/2]

bool JEEP::JTimekeeper::wait ( JFileDescriptorMask & mask ) const

inlineinherited

Wait until the number of time intervals has elapsed since the last call to the reset method or input data have become available on one of the file descriptors in the given mask.

The number of intervals is equal to the number of calls to the method wait since the last call to the reset method. Note that the mask is overwritten following a select call.

Parameters

mask	input mask

Returns: true if interrupted; else false

Definition at line 176 of file JTimekeeper.hh.

    { 
      long long int t1    = getLocalTime();  
      long long int delay = t0  +  (counter + 1) * interval  -  t1;   // [us]
 
      // ensure one select call for each call to this method.
 
      if (delay < 0) {
        delay = 0;
      }
 
      JTimeval timeout((int) (delay/1000000), (int) (delay%1000000));
 
      if (mask.in_avail(timeout)) {
 
        total_delay += getLocalTime() - t1;
        
        return true;
 
      } else {
 
        ++counter;
 
        total_delay += delay;
 
        return false;
      }
    }

Member Data Documentation

◆ credit

int JLOGGER::JMessageScheduler::credit

protected

Definition at line 102 of file JMessageScheduler.hh.

◆ logger

JSharedPointer<JLogger> JLOGGER::JMessageLogger::logger

protectedinherited

Definition at line 227 of file JMessageLogger.hh.

◆ host

std::string JLOGGER::JMessageLogger::host

protectedinherited

Definition at line 228 of file JMessageLogger.hh.

◆ name

std::string JLOGGER::JMessageLogger::name

protectedinherited

Definition at line 229 of file JMessageLogger.hh.

◆ level

JLevel_t JLOGGER::JMessageLogger::level

protectedinherited

Definition at line 230 of file JMessageLogger.hh.

◆ m_mutex

JSYNCHRONIZATION::JMutex JLOGGER::JLogger::m_mutex

privateinherited

Definition at line 51 of file JLogger.hh.

◆ interval

long long int JEEP::JTimekeeper::interval

protectedinherited

interval time [us]

Definition at line 207 of file JTimekeeper.hh.

◆ t0

long long int JEEP::JTimekeeper::t0

mutableprivateinherited

t0 of elapsed time [us]

Definition at line 210 of file JTimekeeper.hh.

◆ total_delay

long long int JEEP::JTimekeeper::total_delay

mutableprivateinherited

total delay time [us]

Definition at line 211 of file JTimekeeper.hh.

◆ counter

long long int JEEP::JTimekeeper::counter

mutableprivateinherited

interval counter

Definition at line 212 of file JTimekeeper.hh.

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

JMessageScheduler.hh

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ JMessage_t

Member Enumeration Documentation

◆ JLevel_t

Constructor & Destructor Documentation

◆ JMessageScheduler() [1/2]

◆ JMessageScheduler() [2/2]

Member Function Documentation

◆ setCredit()

◆ typeout() [1/2]

◆ reset() [1/3]

◆ reset() [2/3]

◆ getLevel()

◆ setLevel() [1/2]

◆ setLevel() [2/2]

◆ is_valid()

◆ typeout() [2/2]

◆ debug()

◆ warning()

◆ error()

◆ notice()

◆ status()

◆ mutex()

◆ getInterval()

◆ getDelay()

◆ setInterval()

◆ reset() [3/3]

◆ operator()()

◆ wait() [1/2]

◆ wait() [2/2]

Member Data Documentation

◆ credit

◆ logger

◆ host

◆ name

◆ level

◆ m_mutex

◆ interval

◆ t0

◆ total_delay

◆ counter