df/d39/Throttle_8h_source.html

 // -*- c++ -*-

 #ifndef __THROTTLE_H__

 #define __THROTTLE_H__


 // epics

 #include <epicsTime.h>


 // tools

 #include "tools/ToolsConfig.h"

 #include "tools/OrderedMutex.h"


 class Throttle

 {

 public:

     Throttle(const char *name, double seconds_between_messages);


     void reset();


     void fire();


     bool isPermitted(const epicsTime &when);


     bool isPermitted();


     double getThrottleThreshold()

     {

         return seconds;

     }


 private:

     PROHIBIT_DEFAULT_COPY(Throttle);

     OrderedMutex mutex;

     double seconds;

     epicsTime last;

 };


 #endif


Throttle::Throttle
Throttle(const char *name, double seconds_between_messages)
Create throttle with the given name and threshold.

OrderedMutex
A mutex with informational name and lock order.
Definition: OrderedMutex.h:34

Throttle::reset
void reset()
Reset the throttle so that isPermitted will return &#39;true&#39;.

Throttle
Timer for throttling messages, thread safe.
Definition: Throttle.h:19

Throttle::fire
void fire()
Fire the throttle so that isPermitted will return &#39;false&#39; until the threshold is exceeded.

Throttle::getThrottleThreshold
double getThrottleThreshold()
Definition: Throttle.h:40

Throttle::isPermitted
bool isPermitted()