org.thales.punch.libraries.punchlang.operator

Class RateLimiterOperator

java.lang.Object

org.thales.punch.libraries.punchlang.operator.RateLimiterOperator

public class RateLimiterOperator
extends Object

The RateLimiterOperator helps you execute actions not too often. Here is how you use it.

 
 class MyPunchlet extends Punchlet {
   RateLimiterOperator rateLimiter = new RateLimiterOperator(TimeUnit.MINUTES, 5);
   public void execute(Tuple root) {
     ...
     if (rateLimiter.pass()) {
       // Do something, this will execute only once every 5 minutes.
     }
   }
 }
 
 

Constructor Summary

Constructors

Constructor and Description
RateLimiterOperator(TimeUnit unit, long value) Create a new operator with some delay

Method Summary

Modifier and Type	Method and Description
boolean	pass() Evaluate the operator.
boolean	run(Runnable runnable) Run the passed Runnable once in the operator interval.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RateLimiterOperator

public RateLimiterOperator(TimeUnit unit,
                           long value)

Create a new operator with some delay

Parameters:

unit - the TimeUnit in which the interval is defined

value - the interval value

Method Detail

pass

public boolean pass()

Evaluate the operator. If passes once in the operator interval. The first time you call it, it passes (i.e. returns true).

Returns:

true once in the operator time interval

run

public boolean run(Runnable runnable)

Run the passed Runnable once in the operator interval.

Parameters:

runnable - the runnable

Returns:

true if the runnable was executed, false otherwise