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

Field Summary

Fields

Modifier and Type	Field and Description
int	count
long	last

Constructor Summary

Constructors

Constructor and Description
RateLimiterBucket() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

Field Detail

count

public int count

last

public long last

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