io.github.bucket4j.distributed

Interface BucketProxy

All Superinterfaces:

Bucket

All Known Implementing Classes:

DefaultBucketProxy

public interface BucketProxy
extends Bucket

Method Summary

Modifier and Type	Method and Description
void	syncByCondition(long unsynchronizedTokens, Duration timeSinceLastSync)
default void	syncImmediately() TODO javadocs
BucketProxy	toListenable(BucketListener listener) Returns new copy of this bucket instance decorated by listener.

Methods inherited from interface io.github.bucket4j.Bucket

addTokens, asBlocking, asScheduler, asVerbose, builder, consumeIgnoringRateLimits, createSnapshot, estimateAbilityToConsume, getAvailableTokens, replaceConfiguration, tryConsume, tryConsumeAndReturnRemaining, tryConsumeAsMuchAsPossible, tryConsumeAsMuchAsPossible

Method Detail

toListenable

BucketProxy toListenable(BucketListener listener)

Description copied from interface: Bucket

Returns new copy of this bucket instance decorated by listener. The created bucket will share same tokens with source bucket and vice versa. See javadocs for BucketListener in order to understand semantic of listener.

Specified by:

toListenable in interface Bucket

Parameters:

listener - the listener of bucket events.

Returns:

new bucket instance decorated by listener

syncImmediately

default void syncImmediately()

TODO javadocs

syncByCondition

void syncByCondition(long unsynchronizedTokens,
                     Duration timeSinceLastSync)

Parameters:

unsynchronizedTokens -

timeSinceLastSync -