default

fun default(capacity: Long, duration: Duration): BucketConfiguration(source)

Creates a BucketConfiguration with a simple Bandwidth of the specified capacity, and a greedy refill.

In other words, the tokens of the bucket will be progressively refilled over the duration, such as the entire bucket would have had been refilled when the duration has elapsed.

Example

For a bucket with 10 tokens and a duration of 10 seconds, 1 token will be added every second.

See also


@JvmName(name = "createDefault")
fun default(capacity: Long, duration: Duration): BucketConfiguration(source)

Creates a BucketConfiguration with a Bandwidth of the specified capacity, and a greedy refill.

In other words, the tokens of the bucket will be progressively refilled over the duration, such as the entire bucket would have been refilled when the duration has elapsed.

Example

For a bucket with 10 tokens and a duration of 10 seconds, 1 token will be added every second.

See also