RateLimiterStats

java.lang.Object
- dev.failsafe.internal.RateLimiterStats

Direct Known Subclasses:

BurstyRateLimiterStats, SmoothRateLimiterStats
```
abstract class RateLimiterStats
extends java.lang.Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

(package private) static class RateLimiterStats.Stopwatch

Field Summary

Fields
Modifier and Type Field Description

(package private) RateLimiterStats.Stopwatch stopwatch

Constructor Summary

Constructors
Constructor Description

RateLimiterStats(RateLimiterStats.Stopwatch stopwatch)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) abstract long`	`acquirePermits(long permits, java.time.Duration maxWaitTime)`	Eagerly acquires permits and returns the time in nanos that must be waited in order to use the permits, else returns `-1` if the wait time would exceed the `maxWaitTime`.
`(package private) boolean`	`exceedsMaxWaitTime(long waitNanos, java.time.Duration maxWaitTime)`	Returns whether the `waitNanos` would exceed the `maxWaitTime`, else `false` if `maxWaitTime` is null.
`(package private) java.time.Duration`	`getElapsed()`	Returns the elapsed time since the rate limiter began.
`(package private) abstract void`	`reset()`	Resets the rate limiter's internal stats.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - stopwatch
```
final RateLimiterStats.Stopwatch stopwatch
```
- Constructor Detail
  - RateLimiterStats
```
RateLimiterStats(RateLimiterStats.Stopwatch stopwatch)
```
- Method Detail
  - acquirePermits
```
abstract long acquirePermits(long permits,
                             java.time.Duration maxWaitTime)
```
    Eagerly acquires permits and returns the time in nanos that must be waited in order to use the permits, else returns -1 if the wait time would exceed the maxWaitTime.
    
    Parameters:
    
    permits - the number of requested permits
    
    maxWaitTime - the max time to wait for the requested permits, else null to wait indefinitely
  - exceedsMaxWaitTime
```
boolean exceedsMaxWaitTime(long waitNanos,
                           java.time.Duration maxWaitTime)
```
    Returns whether the waitNanos would exceed the maxWaitTime, else false if maxWaitTime is null.
  - getElapsed
```
java.time.Duration getElapsed()
```
    Returns the elapsed time since the rate limiter began.
  - reset
```
abstract void reset()
```
    Resets the rate limiter's internal stats.