alluxio.util

Interface RateLimiter

All Known Implementing Classes:

SimpleRateLimiter

public interface RateLimiter

Used to limit the rate of operations. This rate limiter is not thread safe and the operations are non-blocking. It is used by acquiring a permit for each operation, then checking how the operation should wait by calling getWaitTimeNanos(long).

Method Summary

Modifier and Type	Method and Description
Optional<Long>	acquire() Acquire a permit for the next operation.
static RateLimiter	createRateLimiter(long permitsPerSecond)
long	getWaitTimeNanos(long permit) Checks how long is needed to wait for this permit to be ready.

Method Detail

acquire

Optional<Long> acquire()

Acquire a permit for the next operation.

Returns:

Optional.empty() if no waiting is needed, otherwise the value contained in the returned optional is the permit, which can be used in calls to getWaitTimeNanos(long) to see how long to wait for the operation to be ready.

getWaitTimeNanos

long getWaitTimeNanos(long permit)

Checks how long is needed to wait for this permit to be ready.

Parameters:

permit - the permit returned by acquire()

Returns:

the amount of time needed to wait in nanoseconds

createRateLimiter

static RateLimiter createRateLimiter(long permitsPerSecond)

Parameters:

permitsPerSecond - permits per second

Returns:

a rate limiter