Module com.github.akurilov.concurrent

Package com.github.akurilov.concurrent

Class RateThrottle<X>

java.lang.Object

com.github.akurilov.concurrent.RateThrottle<X>

All Implemented Interfaces:

Throttle<X>

public final class RateThrottle<X>
extends java.lang.Object
implements Throttle<X>

A semaphore-like non-blocking throttle which permits at the given rate.

Constructor Summary

Constructors

Constructor	Description
RateThrottle(double rateLimit)

Method Summary

Modifier and Type	Method	Description
boolean	tryAcquire(X item)	Request a permit about a thing
int	tryAcquire(X item, int requiredCount)	Request permits about a set of things

Methods inherited from class java.lang.Object

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

Constructor Detail

RateThrottle

public RateThrottle(double rateLimit)

Parameters:

rateLimit - The rate (permits/sec) limit for the permits

Method Detail

tryAcquire

public final boolean tryAcquire(X item)

Description copied from interface: Throttle

Request a permit about a thing

Specified by:

tryAcquire in interface Throttle<X>

Parameters:

item - the subject of the permit

Returns:

true if the thing should be passed, false otherwise

tryAcquire

public final int tryAcquire(X item,
                            int requiredCount)

Description copied from interface: Throttle

Request permits about a set of things

Specified by:

tryAcquire in interface Throttle<X>

Parameters:

item - the subject of the permits

requiredCount - how many permits is requested

Returns:

how many permits are got