org.rnorth.ducttape.ratelimits

Class RateLimiterBuilder

java.lang.Object

org.rnorth.ducttape.ratelimits.RateLimiterBuilder

public class RateLimiterBuilder
extends Object

Builder for rate limiters.

Method Summary

Modifier and Type	Method and Description
RateLimiter	build() Build and obtain a configured rate limiter.
static RateLimiterBuilder	newBuilder() Obtain a new builder instance.
RateLimiterBuilder	withConstantThroughput() Configure the rate limiter to use a constant throughput strategy for rate limiting.
RateLimiterBuilder	withRate(int invocations, TimeUnit perTimeUnit) Set the maximum rate that the limiter should allow, expressed as the number of invocations allowed in a given time period.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static RateLimiterBuilder newBuilder()

Obtain a new builder instance.

Returns:

a new builder

withRate

public RateLimiterBuilder withRate(int invocations,
                                   TimeUnit perTimeUnit)

Set the maximum rate that the limiter should allow, expressed as the number of invocations allowed in a given time period.

Parameters:

invocations - number of invocations

perTimeUnit - the time period in which this number of invocations are allowed

Returns:

the builder

withConstantThroughput

public RateLimiterBuilder withConstantThroughput()

Configure the rate limiter to use a constant throughput strategy for rate limiting.

Returns:

the builder

build

public RateLimiter build()

Build and obtain a configured rate limiter. A rate and rate limiting strategy must have been selected.

Returns:

the configured rate limiter instance