EPICS ARCHIVER V4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups
Public Member Functions | List of all members
ThrottledMsgLogger Class Reference

A throttled MsgLogger. More...

#include <ThrottledMsgLogger.h>

Inheritance diagram for ThrottledMsgLogger:
Throttle

Public Member Functions

 ThrottledMsgLogger (const char *name, double seconds_between_messages)
 Create a throttled logger. More...
 
void fire ()
 Fire the throttle so that isPermitted will return 'false' until the threshold is exceeded.
 
void LOG_MSG (const char *format,...) __attribute__((format(printf
 Log a throttled message.
 
- Public Member Functions inherited from Throttle
 Throttle (const char *name, double seconds_between_messages)
 Create throttle with the given name and threshold. More...
 
void reset ()
 Reset the throttle so that isPermitted will return 'true'. More...
 
void fire ()
 Fire the throttle so that isPermitted will return 'false' until the threshold is exceeded.
 
bool isPermitted (const epicsTime &when)
 
bool isPermitted ()
 
double getThrottleThreshold ()
 

Detailed Description

A throttled MsgLogger.

Messages that arrive slower than seconds_between_messages threshold specifies are simply printed. When more messages arrive within the threshold time, only one indication "More ..." is printed.

Constructor & Destructor Documentation

ThrottledMsgLogger::ThrottledMsgLogger ( const char *  name,
double  seconds_between_messages 
)
inline

Create a throttled logger.

Parameters
nameThe name of the throttle, used for the suppression message.
seconds_between_messagesThe throttle delay.

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