alluxio.util

Class SimpleRateLimiter

java.lang.Object

alluxio.util.SimpleRateLimiter

All Implemented Interfaces:

RateLimiter

public class SimpleRateLimiter
extends Object
implements RateLimiter

A basic implementation of RateLimiter.

Constructor Summary

Constructors

Constructor and Description
SimpleRateLimiter(long permitsPerSecond, com.google.common.base.Ticker ticker) Creates a simple rate limiter for testing purpose.

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.util.RateLimiter

createRateLimiter

Constructor Detail

SimpleRateLimiter

public SimpleRateLimiter(long permitsPerSecond,
                         com.google.common.base.Ticker ticker)

Creates a simple rate limiter for testing purpose.

Parameters:

permitsPerSecond - permits per second

ticker - the ticker

Method Detail

getWaitTimeNanos

public long getWaitTimeNanos(long permit)

Description copied from interface: RateLimiter

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

Specified by:

getWaitTimeNanos in interface RateLimiter

Parameters:

permit - the permit returned by RateLimiter.acquire()

Returns:

the amount of time needed to wait in nanoseconds

acquire

public Optional<Long> acquire()

Description copied from interface: RateLimiter

Acquire a permit for the next operation.

Specified by:

acquire in interface RateLimiter

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 RateLimiter.getWaitTimeNanos(long) to see how long to wait for the operation to be ready.