io.apiman.gateway.engine.rates

Class RateLimiterBucket

java.lang.Object

io.apiman.gateway.engine.rates.RateLimiterBucket

All Implemented Interfaces:

Serializable

public class RateLimiterBucket
extends Object
implements Serializable

May be used by IRateLimiterComponent implementations.

Author:

eric.wittmann@redhat.com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RateLimiterBucket() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
long	getCount()
long	getLast()
long	getResetMillis(RateBucketPeriod period) Returns the number of millis until the period resets.
void	resetIfNecessary(RateBucketPeriod period) Resets the count if the period boundary has been crossed.
void	setCount(long count)
void	setLast(long last)

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimiterBucket

public RateLimiterBucket()

Constructor.

Method Detail

resetIfNecessary

public void resetIfNecessary(RateBucketPeriod period)

Resets the count if the period boundary has been crossed.

Parameters:

period - the period

getResetMillis

public long getResetMillis(RateBucketPeriod period)

Returns the number of millis until the period resets.

Parameters:

period - the period

Returns:

millis until period resets

getCount

public long getCount()

Returns:

the count

setCount

public void setCount(long count)

Parameters:

count - the count to set

getLast

public long getLast()

Returns:

the last

setLast

public void setLast(long last)

Parameters:

last - the last to set