io.engineblock.activityapi.rates

Interface RateLimiter

All Superinterfaces:

Startable

All Known Subinterfaces:

TestableRateLimiter

All Known Implementing Classes:

AverageRateLimiter

public interface RateLimiter
extends Startable

Method Summary

Modifier and Type	Method and Description
long	acquire() Block until it is time for the next operation, according to the nanoseconds per op as set by setRate(double)
long	acquire(long nanos) Block until it is time for the next operation, according to number of nanoseconds allotted to this individual op.
long	getOpNanos() Get the number of nanoseconds allotted to each operations.
double	getRate() Return the rate in ops/s.
RateSpec	getRateSpec() Get the rate spec that this rate limiter was created from.
long	getTotalSchedulingDelay() Return the total number of nanoseconds behind schedule that this rate limiter is, including the full history across all rates.
void	setRate(double rate) Set the rate in ops/s.
void	setRateSpec(RateSpec spec) Modify the rate of a running rate limiter.

Methods inherited from interface io.engineblock.activityapi.core.Startable

start

Method Detail

acquire

long acquire(long nanos)

Block until it is time for the next operation, according to number of nanoseconds allotted to this individual op.

Parameters:

nanos - Nanos to schedule for

Returns:

the number of nanos behind schedule when this method returns

acquire

long acquire()

Block until it is time for the next operation, according to the nanoseconds per op as set by setRate(double)

Returns:

the number of nanos behind schedule when this op returns

getTotalSchedulingDelay

long getTotalSchedulingDelay()

Return the total number of nanoseconds behind schedule that this rate limiter is, including the full history across all rates. When the rate is changed, this value is check-pointed to an accumulator and also included in any subsequent measurement.

Returns:

nanoseconds behind schedule since the rate limiter was started

setRate

void setRate(double rate)

Set the rate in ops/s. This is a friendly way to calculate the nanoseconds per op.

Parameters:

rate - The desired ops/s rate.

getRate

double getRate()

Return the rate in ops/s.

Returns:

ops/s

getOpNanos

long getOpNanos()

Get the number of nanoseconds allotted to each operations.

Returns:

nanosecond op length

setRateSpec

void setRateSpec(RateSpec spec)

Modify the rate of a running rate limiter.

Parameters:

spec - The rate and burstRatio specification

getRateSpec

RateSpec getRateSpec()

Get the rate spec that this rate limiter was created from.

Returns:

a RateSpec that describes this rate limiter