com.github.akurilov.commons.concurrent

Interface Throttle<X>

All Known Implementing Classes:

RateThrottle

public interface Throttle<X>

Throttle can make a decision about the specified thing to pass or to wait. The throttle calls are not blocking so the caller should block if the throttle tells so.

Method Summary

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

Method Detail

tryAcquire

boolean tryAcquire(X thing)

Request a permit about a thing

Parameters:

thing - the subject of the permit

Returns:

true if the thing should be passed, false otherwise

tryAcquire

int tryAcquire(X thing,
               int times)

Request permits about a set of things

Parameters:

thing - the subject of the permits

times - how many permits is requested

Returns:

how many permits are got