Jpp
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
JLOGGER::JMessageScheduler Class Reference

Message logger with time scheduler. More...

#include <JMessageScheduler.hh>

Inheritance diagram for JLOGGER::JMessageScheduler:
JLOGGER::JMessageLogger JEEP::JTimekeeper 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

 JMessageScheduler ()
 Default constructor. More...
 
 JMessageScheduler (const JMessageLogger &logger, const JTimekeeper &timer)
 Constructor. More...
 
void setCredit (const int credit)
 Set credit. More...
 
virtual void typeout (const std::string &tag, const std::string &message)
 Report message. More...
 
void reset ()
 Reset. 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...
 
long long int getInterval () const
 Get interval time. More...
 
long long int getDelay () const
 Get total delay time. More...
 
void setInterval (const long long int interval_us)
 Set interval time. More...
 
void reset (const long long int t0)
 Reset time. More...
 
bool operator() () const
 Check whether the number of time intervals has elapsed since the last call to the reset method. More...
 
void wait () const
 Wait until the number of time intervals has elapsed since the last call to the reset method. More...
 
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. More...
 

Protected Member Functions

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

Protected Attributes

int credit
 
JSharedPointer< JLoggerlogger
 
std::string host
 
std::string name
 
JLevel_t level
 
long long int interval
 interval time [us] More...
 

Private Attributes

JSYNCHRONIZATION::JMutex m_mutex
 
long long int t0
 t0 of elapsed time [us] More...
 
long long int total_delay
 total delay time [us] More...
 
long long int counter
 interval counter More...
 

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

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

Definition at line 67 of file JMessageLogger.hh.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

◆ JMessageScheduler() [1/2]

JLOGGER::JMessageScheduler::JMessageScheduler ( )
inline

Default constructor.

Definition at line 33 of file JMessageScheduler.hh.

33  :
35  JTimekeeper (),
36  credit (0)
37  {}

◆ 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
loggerlogger
timertimer

Definition at line 47 of file JMessageScheduler.hh.

48  :
50  JTimekeeper (timer),
51  credit (1)
52  {
54  }

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
creditcredit

Definition at line 64 of file JMessageScheduler.hh.

65  {
66  this->credit = credit;
67  }

◆ typeout() [1/2]

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

Report message.

Parameters
tagtag
messagemessage

Reimplemented from JLOGGER::JMessageLogger.

Definition at line 75 of file JMessageScheduler.hh.

77  {
78  if (JTimekeeper::operator()()) {
79  reset();
80  }
81 
82  if (credit != 0) {
83 
84  JMessageLogger::typeout(tag, message);
85 
86  --credit;
87  }
88  }

◆ reset() [1/3]

void JLOGGER::JMessageScheduler::reset ( )
inline

Reset.

Definition at line 94 of file JMessageScheduler.hh.

95  {
97 
98  credit = 1;
99  }

◆ reset() [2/3]

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  }

◆ getLevel()

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  }

◆ setLevel() [1/2]

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
137  level = DEBUG;
138  }

◆ setLevel() [2/2]

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

Set debug level.

Parameters
__leveldebug level

Definition at line 146 of file JMessageLogger.hh.

147  {
148  level = __level;
149  }

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

162  {
163  return logger.is_valid();
164  }

◆ typeout() [2/2]

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

201  {
202  if (is_valid() && __level <= level && !__message.empty()) {
203 
204  JMessage_t message;
205 
206  message += getDateAndTime();
207 
208  message += " ";
209  message += host;
210 
211  message += " ";
212  message += name;
213 
214  message += " ";
215  message += __prefix;
216 
217  message += " ";
218  message += __message;
219 
220  typeout(MESSAGE_TAG, message);
221  }
222  }

◆ debug()

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

Definition at line 182 of file JMessageLogger.hh.

182 { TYPEOUT(DEBUG, message); }

◆ warning()

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

Definition at line 183 of file JMessageLogger.hh.

183 { TYPEOUT(WARNING, message); }

◆ error()

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

Definition at line 184 of file JMessageLogger.hh.

184 { TYPEOUT(ERROR, message); }

◆ notice()

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

Definition at line 185 of file JMessageLogger.hh.

185 { TYPEOUT(NOTICE, message); }

◆ status()

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

Definition at line 186 of file JMessageLogger.hh.

186 { 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.

45  {
46  return m_mutex;
47  }

◆ getInterval()

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

Get interval time.

Returns
interval time [us]

Definition at line 67 of file JTimekeeper.hh.

68  {
69  return interval;
70  }

◆ 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.

79  {
80  return total_delay;
81  }

◆ setInterval()

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

Set interval time.

Parameters
interval_usinterval time [us]

Definition at line 89 of file JTimekeeper.hh.

90  {
91  interval = interval_us;
92  }

◆ reset() [3/3]

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

Reset time.

Parameters
t0time [us]

Definition at line 100 of file JTimekeeper.hh.

101  {
102  this->t0 = t0;
103  this->counter = 0;
104  this->total_delay = 0;
105  }

◆ 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.

126  {
127  if (getLocalTime() >= t0 + (counter + 1) * interval) {
128 
129  ++counter;
130 
131  return true;
132 
133  } else
134 
135  return false;
136  }

◆ 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.

146  {
147  static const useconds_t MAXIMAL_SLEEP_TIME_US = std::numeric_limits<useconds_t>::max();
148 
149  long long int delay = t0 + (counter + 1) * interval - getLocalTime(); // [us]
150 
151  while (delay > MAXIMAL_SLEEP_TIME_US && usleep(MAXIMAL_SLEEP_TIME_US) == 0) {
152 
153  total_delay += MAXIMAL_SLEEP_TIME_US;
154  delay -= MAXIMAL_SLEEP_TIME_US;
155  }
156 
157  if (delay > 0 && usleep((useconds_t) delay) == 0) {
158  total_delay += delay;
159  }
160 
161  ++counter;
162  }

◆ 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
maskinput mask
Returns
true if interrupted; else false

Definition at line 176 of file JTimekeeper.hh.

177  {
178  long long int t1 = getLocalTime();
179  long long int delay = t0 + (counter + 1) * interval - t1; // [us]
180 
181  // ensure one select call for each call to this method.
182 
183  if (delay < 0) {
184  delay = 0;
185  }
186 
187  JTimeval timeout((int) (delay/1000000), (int) (delay%1000000));
188 
189  if (mask.in_avail(timeout)) {
190 
191  total_delay += getLocalTime() - t1;
192 
193  return true;
194 
195  } else {
196 
197  ++counter;
198 
199  total_delay += delay;
200 
201  return false;
202  }
203  }

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

◆ host

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

Definition at line 226 of file JMessageLogger.hh.

◆ name

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

Definition at line 227 of file JMessageLogger.hh.

◆ level

JLevel_t JLOGGER::JMessageLogger::level
protectedinherited

Definition at line 228 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:
JLOGGER::JLogger::m_mutex
JSYNCHRONIZATION::JMutex m_mutex
Definition: JLogger.hh:51
JEEP::JTimekeeper::counter
long long int counter
interval counter
Definition: JTimekeeper.hh:212
JLOGGER::JMessageScheduler::reset
void reset()
Reset.
Definition: JMessageScheduler.hh:94
JLOGGER::JMessageLogger::typeout
virtual void typeout(const std::string &tag, const std::string &message)
Report message.
Definition: JMessageLogger.hh:173
JEEP::JTimekeeper::reset
void reset()
Reset time.
Definition: JTimekeeper.hh:111
JLOGGER::JMessageLogger::WARNING
Warning.
Definition: JMessageLogger.hh:62
JSYSTEM::getDateAndTime
static JDateAndTime getDateAndTime
Function object to get ASCII formatted date and time.
Definition: JDate.hh:195
JLOGGER::MESSAGE_TAG
static const std::string MESSAGE_TAG
Message logging tag.
Definition: JMessageLogger.hh:30
JLOGGER::JMessageLogger::ERROR
Error; always logged.
Definition: JMessageLogger.hh:60
JLOGGER::JMessageLogger::OFF
No logging of messages.
Definition: JMessageLogger.hh:59
JLOGGER::JMessageLogger::level
JLevel_t level
Definition: JMessageLogger.hh:228
JLOGGER::JMessageLogger::NOTICE
Notice.
Definition: JMessageLogger.hh:63
JSYSTEM::getLocalTime
static const JLocalTime getLocalTime
Function object to get local time in micro seconds.
Definition: JSystem/JTime.hh:61
JEEP::JTimekeeper::JTimekeeper
JTimekeeper()
Default constructor.
Definition: JTimekeeper.hh:39
JEEP::JTimekeeper::interval
long long int interval
interval time [us]
Definition: JTimekeeper.hh:207
TYPEOUT
#define TYPEOUT(LEVEL, MESSAGE)
Definition: JMessageLogger.hh:180
JLOGGER::JMessageLogger::is_valid
bool is_valid() const
Check validity of logger object.
Definition: JMessageLogger.hh:161
JLOGGER::JMessageLogger::JMessageLogger
JMessageLogger()
Default constructor.
Definition: JMessageLogger.hh:73
JLOGGER::JMessageLogger::STATUS
Status; always logged.
Definition: JMessageLogger.hh:61
JEEP::JTimekeeper::t0
long long int t0
t0 of elapsed time [us]
Definition: JTimekeeper.hh:210
JEEP::JTimekeeper::total_delay
long long int total_delay
total delay time [us]
Definition: JTimekeeper.hh:211
JLOGGER::JMessageLogger::DEBUG
Debug.
Definition: JMessageLogger.hh:64
JLOGGER::JMessageScheduler::credit
int credit
Definition: JMessageScheduler.hh:102
JLOGGER::JMessageLogger::name
std::string name
Definition: JMessageLogger.hh:227
JLOGGER::JMessageLogger::host
std::string host
Definition: JMessageLogger.hh:226
JLOGGER::JMessageLogger::logger
JSharedPointer< JLogger > logger
Definition: JMessageLogger.hh:225
JLOGGER::JMessageLogger::JMessage_t
std::string JMessage_t
Definition: JMessageLogger.hh:67