Package org.epics.archiverappliance.engine.model

Class Throttle

java.lang.Object

org.epics.archiverappliance.engine.model.Throttle

public class Throttle
extends Object

Throttle that only permits a certain number of events.

Author:

Kay Kasemir

Constructor Summary

Constructors

Constructor	Description
Throttle(double seconds_between_messages)	Construct throttle that only allows one event in every time slot.

Method Summary

Modifier and Type	Method	Description
double	getPeriod()
boolean	isPermitted()

Methods inherited from class java.lang.Object

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

Constructor Details

Throttle

public Throttle(double seconds_between_messages)

Construct throttle that only allows one event in every time slot.

Parameters:

seconds_between_messages -  

Method Details

getPeriod

public double getPeriod()

Returns:

Event period [seconds]

isPermitted

public boolean isPermitted()

Returns:

true if another event is permitted "right now"