Module io.github.bucket4j.core

Package io.github.bucket4j

Interface VerboseResult.Diagnostics

Enclosing class:

VerboseResult<T>

public static interface VerboseResult.Diagnostics

Describer of internal bucket state

Method Summary

Modifier and Type	Method	Description
long	calculateFullRefillingTime()	Returns time in nanoseconds that need to wait until bucket will be fully refilled to its maximum
long	getAvailableTokens()	Returns currently available tokens
long[]	getAvailableTokensPerEachBandwidth()	Returns currently available tokens per each bandwidth.

Method Details

calculateFullRefillingTime

long calculateFullRefillingTime()

Returns time in nanoseconds that need to wait until bucket will be fully refilled to its maximum

Returns:

time in nanoseconds that need to wait until bucket will be fully refilled to its maximum

getAvailableTokens

long getAvailableTokens()

Returns currently available tokens

Returns:

currently available tokens

getAvailableTokensPerEachBandwidth

long[] getAvailableTokensPerEachBandwidth()

Returns currently available tokens per each bandwidth. Element's order inside resulted array depends on from order in which bandwidth is specified inside BucketConfiguration.

Returns:

currently available tokens per each bandwidth