Class RateLimiterConfig<R>

java.lang.Object

dev.failsafe.PolicyConfig<R>

dev.failsafe.RateLimiterConfig<R>

Type Parameters:

R - result type

public class RateLimiterConfig<R>
extends PolicyConfig<R>

Configuration for a RateLimiter.

Author:

Jonathan Halterman

Method Summary

Modifier and Type	Method	Description
long	getMaxPermits()	For bursty rate limiters, returns the max permitted executions per period, else null if the rate limiter is not bursty.
Duration	getMaxRate()	For smooth rate limiters, returns the max rate at which individual executions are permitted, else null if the rate limiter is not smooth.
Duration	getMaxWaitTime()	Returns the max time to wait for permits to be available.
Duration	getPeriod()	For bursty rate limiters, returns the period after which permits are reset to maxPermits, else null if the rate limiter is not bursty.

Methods inherited from class PolicyConfig

getFailureListener, getSuccessListener

Methods inherited from class Object

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

Method Details

getMaxRate

public Duration getMaxRate()

For smooth rate limiters, returns the max rate at which individual executions are permitted, else null if the rate limiter is not smooth.

See Also:

• RateLimiter.smoothBuilder(long, Duration)
• RateLimiter.smoothBuilder(Duration)

getMaxPermits

public long getMaxPermits()

For bursty rate limiters, returns the max permitted executions per period, else null if the rate limiter is not bursty.

See Also:

• RateLimiter.burstyBuilder(long, Duration)

getPeriod

public Duration getPeriod()

For bursty rate limiters, returns the period after which permits are reset to maxPermits, else null if the rate limiter is not bursty.

See Also:

• RateLimiter.burstyBuilder(long, Duration)

getMaxWaitTime

public Duration getMaxWaitTime()

Returns the max time to wait for permits to be available. If permits cannot be acquired before the max wait time is exceeded, then the rate limiter will throw RateLimitExceededException.

This setting only applies when the RateLimiter is used with the Failsafe class. It does not apply when the RateLimiter is used in a standalone way.

See Also:

• RateLimiterBuilder.withMaxWaitTime(Duration)