|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.excalibur.event.impl.RateLimitingPredicate
public class RateLimitingPredicate
This enqueue predicate implements input rate policing.
Field Summary | |
---|---|
private int |
m_depth
The depth of the token bucket |
private long |
m_lastTime
|
private double |
m_regenTimeMs
|
private double |
m_targetRate
The rate to which the enqueuing should be limited |
private int |
m_tokenCount
|
private static long |
MIN_REGENERATION_TIME
Number of milliseconds between regenerations |
Constructor Summary | |
---|---|
RateLimitingPredicate(double targetRate,
int depth)
Create a new RateLimitingPredicate for the given sink, targetRate, and token bucket depth. |
|
RateLimitingPredicate(int depth)
Create a new RateLimitingPredicate for the given sink, bucket depth and no rate limit. |
Method Summary | |
---|---|
boolean |
accept(java.lang.Object[] elements,
org.apache.excalibur.event.Sink sink)
|
boolean |
accept(java.lang.Object element,
org.apache.excalibur.event.Sink sink)
|
int |
getBucketSize()
Returns the number of tokens currently in the bucket. |
int |
getDepth()
Returns the current depth. |
double |
getTargetRate()
Returns the current rate limit. |
void |
setDepth(int depth)
Allows to set the bucket depth. |
void |
setTargetRate(double targetRate)
Allows to set the rate limit. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private double m_targetRate
private int m_depth
private int m_tokenCount
private long m_lastTime
private double m_regenTimeMs
private static final long MIN_REGENERATION_TIME
Constructor Detail |
---|
public RateLimitingPredicate(int depth)
depth
- The token bucket depth.public RateLimitingPredicate(double targetRate, int depth)
targetRate
- The rate that is the target for this predicatedepth
- The token bucket depth.Method Detail |
---|
public boolean accept(java.lang.Object element, org.apache.excalibur.event.Sink sink)
accept
in interface org.apache.excalibur.event.EnqueuePredicate
EnqueuePredicate.accept(Object, Sink)
public boolean accept(java.lang.Object[] elements, org.apache.excalibur.event.Sink sink)
accept
in interface org.apache.excalibur.event.EnqueuePredicate
EnqueuePredicate.accept(Object, Sink)
public double getTargetRate()
public int getDepth()
public int getBucketSize()
public void setTargetRate(double targetRate)
targetRate
- the current rate limit.public void setDepth(int depth)
depth
- The bucket depth as an integer.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |