A B C D E F G I L N P R S T U V W

A

AbstractBucket - Class in io.github.bucket4j

AbstractBucket() - Constructor for class io.github.bucket4j.AbstractBucket

addLimit(Bandwidth) - Method in class io.github.bucket4j.ConfigurationBuilder

Adds limited bandwidth for all buckets which will be constructed by this builder instance.

addLimit(long, Bandwidth) - Method in class io.github.bucket4j.ConfigurationBuilder

Adds limited bandwidth for all buckets which will be constructed by this builder instance.

addTokens(long) - Method in class io.github.bucket4j.AbstractBucket

addTokens(long) - Method in interface io.github.bucket4j.Bucket

Add tokensToAdd to each bandwidth of bucket.

addTokens(Bandwidth[], long) - Method in class io.github.bucket4j.BucketState

AddTokensCommand - Class in io.github.bucket4j.grid

AddTokensCommand(long) - Constructor for class io.github.bucket4j.grid.AddTokensCommand

addTokensImpl(long) - Method in class io.github.bucket4j.AbstractBucket

addTokensImpl(long) - Method in class io.github.bucket4j.grid.GridBucket

addTokensImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket

addTokensImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket

B

Bandwidth - Class in io.github.bucket4j

Anatomy of bandwidth:

BlockingStrategy - Interface in io.github.bucket4j

Specifies the way to block current thread to amount of time required to refill missed number of tokens in the bucket.

Bucket - Interface in io.github.bucket4j

Performs rate limiting using algorithm based on top of ideas of Token Bucket.

Bucket4j - Class in io.github.bucket4j

This is entry point for functionality provided bucket4j library.

BucketConfiguration - Class in io.github.bucket4j

BucketConfiguration(List<BandwidthDefinition>, TimeMeter) - Constructor for class io.github.bucket4j.BucketConfiguration

BucketExceptions - Class in io.github.bucket4j

bucketNotFound() - Static method in class io.github.bucket4j.grid.CommandResult

BucketNotFoundException - Exception in io.github.bucket4j.grid

Exception which thrown each time when GridBucket found that bucket state has been lost, and GridBucket is unable to repair bucket state or recovery strategy is RecoveryStrategy.THROW_BUCKET_NOT_FOUND_EXCEPTION.

BucketNotFoundException(Serializable) - Constructor for exception io.github.bucket4j.grid.BucketNotFoundException

BucketState - Class in io.github.bucket4j

BucketState(BucketConfiguration) - Constructor for class io.github.bucket4j.BucketState

build() - Method in class io.github.bucket4j.local.LocalBucketBuilder

Constructs the bucket using SynchronizationStrategy.LOCK_FREE synchronization strategy.

build(SynchronizationStrategy) - Method in class io.github.bucket4j.local.LocalBucketBuilder

Constructs the new instance of local bucket which concrete type depends on synchronizationStrategy

buildConfiguration() - Method in class io.github.bucket4j.ConfigurationBuilder

builder() - Static method in class io.github.bucket4j.Bucket4j

Creates the new builder of in-memory buckets.

builder() - Method in interface io.github.bucket4j.Extension

Creates new instance of builder specific for this particular extension.

C

classic(long, Refill) - Static method in class io.github.bucket4j.Bandwidth

Specifies limitation in classic interpretation of token-bucket algorithm.

CommandResult<T extends Serializable> - Class in io.github.bucket4j.grid

CommandResult(T, boolean) - Constructor for class io.github.bucket4j.grid.CommandResult

configurationBuilder() - Static method in class io.github.bucket4j.Bucket4j

Creates new instance of ConfigurationBuilder

ConfigurationBuilder<T extends ConfigurationBuilder> - Class in io.github.bucket4j

A builder for buckets.

ConfigurationBuilder() - Constructor for class io.github.bucket4j.ConfigurationBuilder

consume(long, BlockingStrategy) - Method in class io.github.bucket4j.AbstractBucket

consume(long, long, BlockingStrategy) - Method in class io.github.bucket4j.AbstractBucket

consume(long, long, BlockingStrategy) - Method in interface io.github.bucket4j.Bucket

Consumes a specified number of tokens from the bucket.

consume(long, BlockingStrategy) - Method in interface io.github.bucket4j.Bucket

Consumes numTokens from the bucket.

consume(Bandwidth[], long) - Method in class io.github.bucket4j.BucketState

ConsumeAsMuchAsPossibleCommand - Class in io.github.bucket4j.grid

ConsumeAsMuchAsPossibleCommand(long) - Constructor for class io.github.bucket4j.grid.ConsumeAsMuchAsPossibleCommand

consumeAsMuchAsPossibleImpl(long) - Method in class io.github.bucket4j.AbstractBucket

consumeAsMuchAsPossibleImpl(long) - Method in class io.github.bucket4j.grid.GridBucket

consumeAsMuchAsPossibleImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket

consumeAsMuchAsPossibleImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket

consumed(long) - Static method in class io.github.bucket4j.ConsumptionProbe

consumeOrAwaitImpl(long, long, boolean, BlockingStrategy) - Method in class io.github.bucket4j.AbstractBucket

consumeOrAwaitImpl(long, long, boolean, BlockingStrategy) - Method in class io.github.bucket4j.grid.GridBucket

consumeOrAwaitImpl(long, long, boolean, BlockingStrategy) - Method in class io.github.bucket4j.local.LockFreeBucket

consumeOrAwaitImpl(long, long, boolean, BlockingStrategy) - Method in class io.github.bucket4j.local.SynchronizedBucket

consumeUninterruptibly(long, BlockingStrategy) - Method in class io.github.bucket4j.AbstractBucket

consumeUninterruptibly(long, long, BlockingStrategy) - Method in class io.github.bucket4j.AbstractBucket

consumeUninterruptibly(long, long, BlockingStrategy) - Method in interface io.github.bucket4j.Bucket

Consumes a specified number of tokens from the bucket.

consumeUninterruptibly(long, BlockingStrategy) - Method in interface io.github.bucket4j.Bucket

Consumes numTokens from the bucket.

ConsumptionProbe - Class in io.github.bucket4j

Describes both result of consumption and tokens remaining in the bucket after consumption.

copy() - Method in class io.github.bucket4j.BucketState

copyStateFrom(BucketState) - Method in class io.github.bucket4j.BucketState

createInitializedBucket(T, BucketConfiguration, GridProxy<T>, RecoveryStrategy) - Static method in class io.github.bucket4j.grid.GridBucket

createInitialState(BucketConfiguration) - Static method in class io.github.bucket4j.BucketState

createLazyBucket(T, Supplier<BucketConfiguration>, GridProxy<T>) - Static method in class io.github.bucket4j.grid.GridBucket

createSnapshot() - Method in interface io.github.bucket4j.Bucket

Creates the copy of internal state.

createSnapshot() - Method in class io.github.bucket4j.grid.GridBucket

createSnapshot() - Method in class io.github.bucket4j.local.LockFreeBucket

createSnapshot() - Method in class io.github.bucket4j.local.SynchronizedBucket

CreateSnapshotCommand - Class in io.github.bucket4j.grid

CreateSnapshotCommand() - Constructor for class io.github.bucket4j.grid.CreateSnapshotCommand

currentTimeNanos() - Method in interface io.github.bucket4j.TimeMeter

Returns current time in nanosecond precision, but not necessarily nanosecond resolution.

D

delayNanosAfterWillBePossibleToConsume(Bandwidth[], long) - Method in class io.github.bucket4j.BucketState

E

execute(GridBucketState) - Method in class io.github.bucket4j.grid.AddTokensCommand

execute(GridBucketState) - Method in class io.github.bucket4j.grid.ConsumeAsMuchAsPossibleCommand

execute(GridBucketState) - Method in class io.github.bucket4j.grid.CreateSnapshotCommand

execute(GridBucketState) - Method in class io.github.bucket4j.grid.GetAvailableTokensCommand

execute(GridBucketState) - Method in interface io.github.bucket4j.grid.GridCommand

execute(K, GridCommand<T>) - Method in interface io.github.bucket4j.grid.GridProxy

execute(GridBucketState) - Method in class io.github.bucket4j.grid.ReserveAndCalculateTimeToSleepCommand

execute(GridBucketState) - Method in class io.github.bucket4j.grid.TryConsumeAndReturnRemainingTokensCommand

execute(GridBucketState) - Method in class io.github.bucket4j.grid.TryConsumeCommand

extension(Class<E>) - Static method in class io.github.bucket4j.Bucket4j

Locates Bucket4j extension by class extensionClass.

Extension<T extends ConfigurationBuilder<T>> - Interface in io.github.bucket4j

Represents an extension point of bucket4j library.

F

FakeLock - Class in io.github.bucket4j.local

This is lock implementation which actually lock nothing, is used for SynchronizationStrategy.NONE

G

get() - Method in class io.github.bucket4j.util.LazySupplier

getAvailableTokens() - Method in interface io.github.bucket4j.Bucket

Returns amount of available tokens in this bucket.

getAvailableTokens(Bandwidth[]) - Method in class io.github.bucket4j.BucketState

getAvailableTokens() - Method in class io.github.bucket4j.grid.GridBucket

getAvailableTokens() - Method in class io.github.bucket4j.local.LockFreeBucket

getAvailableTokens() - Method in class io.github.bucket4j.local.SynchronizedBucket

GetAvailableTokensCommand - Class in io.github.bucket4j.grid

GetAvailableTokensCommand() - Constructor for class io.github.bucket4j.grid.GetAvailableTokensCommand

getBandwidths() - Method in class io.github.bucket4j.BucketConfiguration

getBandwidthsInitialTokens() - Method in class io.github.bucket4j.BucketConfiguration

getBucketConfiguration() - Method in class io.github.bucket4j.grid.GridBucketState

getBucketId() - Method in exception io.github.bucket4j.grid.BucketNotFoundException

getBucketState() - Method in class io.github.bucket4j.grid.GridBucketState

getConfiguration() - Method in interface io.github.bucket4j.Bucket

Returns configuration of this bucket.

getConfiguration() - Method in class io.github.bucket4j.grid.GridBucket

getConfiguration() - Method in class io.github.bucket4j.local.LockFreeBucket

getConfiguration() - Method in class io.github.bucket4j.local.SynchronizedBucket

getData() - Method in class io.github.bucket4j.grid.CommandResult

getNanosToWaitForRefill() - Method in class io.github.bucket4j.ConsumptionProbe

Returns zero if ConsumptionProbe.isConsumed() returns true, else time in nanos which need to wait until requested amount of tokens will be refilled

getProxy(K, Supplier<BucketConfiguration>) - Method in interface io.github.bucket4j.grid.ProxyManager

Provides light-weight proxy to bucket which actually stored outside current JVM.

getRemainingTokens() - Method in class io.github.bucket4j.ConsumptionProbe

Return the tokens remaining in the bucket

getTimeMeter() - Method in class io.github.bucket4j.BucketConfiguration

GridBucket<K extends Serializable> - Class in io.github.bucket4j.grid

Represents the bucket which state actually stored outside current JVM.

GridBucketState - Class in io.github.bucket4j.grid

GridBucketState() - Constructor for class io.github.bucket4j.grid.GridBucketState

GridBucketState(BucketConfiguration, BucketState) - Constructor for class io.github.bucket4j.grid.GridBucketState

GridCommand<T extends Serializable> - Interface in io.github.bucket4j.grid

GridProxy<K extends Serializable> - Interface in io.github.bucket4j.grid

I

INITIAL_TOKENS_UNSPECIFIED - Static variable in class io.github.bucket4j.BucketConfiguration

INSTANCE - Static variable in class io.github.bucket4j.local.FakeLock

io.github.bucket4j - package io.github.bucket4j

io.github.bucket4j.grid - package io.github.bucket4j.grid

io.github.bucket4j.local - package io.github.bucket4j.local

io.github.bucket4j.util - package io.github.bucket4j.util

isBucketNotFound() - Method in class io.github.bucket4j.grid.CommandResult

isBucketStateModified() - Method in class io.github.bucket4j.grid.AddTokensCommand

isBucketStateModified() - Method in class io.github.bucket4j.grid.ConsumeAsMuchAsPossibleCommand

isBucketStateModified() - Method in class io.github.bucket4j.grid.CreateSnapshotCommand

isBucketStateModified() - Method in class io.github.bucket4j.grid.GetAvailableTokensCommand

isBucketStateModified() - Method in interface io.github.bucket4j.grid.GridCommand

isBucketStateModified() - Method in class io.github.bucket4j.grid.ReserveAndCalculateTimeToSleepCommand

isBucketStateModified() - Method in class io.github.bucket4j.grid.TryConsumeAndReturnRemainingTokensCommand

isBucketStateModified() - Method in class io.github.bucket4j.grid.TryConsumeCommand

isConsumed() - Method in class io.github.bucket4j.ConsumptionProbe

Flag describes result of consumption operation.

L

LazySupplier<T> - Class in io.github.bucket4j.util

LazySupplier(Supplier<T>) - Constructor for class io.github.bucket4j.util.LazySupplier

LocalBucketBuilder - Class in io.github.bucket4j.local

This builder creates in-memory buckets (LockFreeBucket).

LocalBucketBuilder() - Constructor for class io.github.bucket4j.local.LocalBucketBuilder

lock() - Method in class io.github.bucket4j.local.FakeLock

LockFreeBucket - Class in io.github.bucket4j.local

LockFreeBucket(BucketConfiguration) - Constructor for class io.github.bucket4j.local.LockFreeBucket

lockInterruptibly() - Method in class io.github.bucket4j.local.FakeLock

N

newCondition() - Method in class io.github.bucket4j.local.FakeLock

nonPositiveCapacity(long) - Static method in class io.github.bucket4j.BucketExceptions

nonPositiveInitialTokens(long) - Static method in class io.github.bucket4j.BucketExceptions

nonPositiveNanosToWait(long) - Static method in class io.github.bucket4j.BucketExceptions

nonPositivePeriod(long) - Static method in class io.github.bucket4j.BucketExceptions

nonPositivePeriodTokens(long) - Static method in class io.github.bucket4j.BucketExceptions

nonPositiveTokensToConsume(long) - Static method in class io.github.bucket4j.BucketExceptions

nullBandwidth() - Static method in class io.github.bucket4j.BucketExceptions

nullBandwidthRefill() - Static method in class io.github.bucket4j.BucketExceptions

nullPeriod() - Static method in class io.github.bucket4j.BucketExceptions

nullTimeMeter() - Static method in class io.github.bucket4j.BucketExceptions

P

park(long) - Method in interface io.github.bucket4j.BlockingStrategy

Park current thread to required duration of nanoseconds.

PARKING - Static variable in interface io.github.bucket4j.BlockingStrategy

parkUninterruptibly(long) - Method in interface io.github.bucket4j.BlockingStrategy

Parks current thread to required duration of nanoseconds ignoring all interrupts, if interrupt was happen then interruption flag will be restored on the current thread.

ProxyManager<K extends Serializable> - Interface in io.github.bucket4j.grid

Provides interface to instantiate an light-weight proxy to bucket which state actually stored in any external storage outside current JVM, like in-memory grid or relational database.

R

RecoveryStrategy - Enum in io.github.bucket4j.grid

Specifies the reaction which should be applied in case of previously saved state of bucket has been lost.

Refill - Class in io.github.bucket4j

Specifies the speed of tokens regeneration.

refillAllBandwidth(Bandwidth[], long) - Method in class io.github.bucket4j.BucketState

rejected(long, long) - Static method in class io.github.bucket4j.ConsumptionProbe

ReserveAndCalculateTimeToSleepCommand - Class in io.github.bucket4j.grid

ReserveAndCalculateTimeToSleepCommand(long, long) - Constructor for class io.github.bucket4j.grid.ReserveAndCalculateTimeToSleepCommand

restrictionsNotSpecified() - Static method in class io.github.bucket4j.BucketExceptions

S

setBucketNotFound(boolean) - Method in class io.github.bucket4j.grid.CommandResult

setData(T) - Method in class io.github.bucket4j.grid.CommandResult

setInitialState(K, GridBucketState) - Method in interface io.github.bucket4j.grid.GridProxy

simple(long, Duration) - Static method in class io.github.bucket4j.Bandwidth

Specifies simple limitation capacity tokens per period time window.

smooth(long, Duration) - Static method in class io.github.bucket4j.Refill

Creates refill which regenerates the tokens in greedy manner.

success(R) - Static method in class io.github.bucket4j.grid.CommandResult

SynchronizationStrategy - Enum in io.github.bucket4j.local

Defines the strategy of synchronization which need to be applied to prevent data-races in multithreading usage scenario.

SynchronizedBucket - Class in io.github.bucket4j.local

SynchronizedBucket(BucketConfiguration) - Constructor for class io.github.bucket4j.local.SynchronizedBucket

SynchronizedBucket(BucketConfiguration, Lock) - Constructor for class io.github.bucket4j.local.SynchronizedBucket

SYSTEM_MILLISECONDS - Static variable in interface io.github.bucket4j.TimeMeter

The implementation of TimeMeter which works around System.currentTimeMillis()

SYSTEM_NANOTIME - Static variable in interface io.github.bucket4j.TimeMeter

The implementation of TimeMeter which works arround System.nanoTime()

T

TimeMeter - Interface in io.github.bucket4j

An abstraction over time measurement.

tooHighRefillRate(long, long) - Static method in class io.github.bucket4j.BucketExceptions

toString() - Method in class io.github.bucket4j.Bandwidth

toString() - Method in class io.github.bucket4j.BucketConfiguration

toString() - Method in class io.github.bucket4j.BucketState

toString() - Method in class io.github.bucket4j.ConfigurationBuilder

toString() - Method in class io.github.bucket4j.ConsumptionProbe

toString() - Method in class io.github.bucket4j.local.LockFreeBucket

toString() - Method in class io.github.bucket4j.local.SynchronizedBucket

toString() - Method in class io.github.bucket4j.Refill

tryConsume(long) - Method in class io.github.bucket4j.AbstractBucket

tryConsume(long) - Method in interface io.github.bucket4j.Bucket

Tries to consume a specified number of tokens from this bucket.

tryConsumeAndReturnRemaining(long) - Method in class io.github.bucket4j.AbstractBucket

tryConsumeAndReturnRemaining(long) - Method in interface io.github.bucket4j.Bucket

Tries to consume a specified number of tokens from this bucket.

TryConsumeAndReturnRemainingTokensCommand - Class in io.github.bucket4j.grid

Created by vladimir.bukhtoyarov on 15.05.2017.

TryConsumeAndReturnRemainingTokensCommand(long) - Constructor for class io.github.bucket4j.grid.TryConsumeAndReturnRemainingTokensCommand

tryConsumeAndReturnRemainingTokensImpl(long) - Method in class io.github.bucket4j.AbstractBucket

tryConsumeAndReturnRemainingTokensImpl(long) - Method in class io.github.bucket4j.grid.GridBucket

tryConsumeAndReturnRemainingTokensImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket

tryConsumeAndReturnRemainingTokensImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket

tryConsumeAsMuchAsPossible(long) - Method in class io.github.bucket4j.AbstractBucket

tryConsumeAsMuchAsPossible() - Method in class io.github.bucket4j.AbstractBucket

tryConsumeAsMuchAsPossible() - Method in interface io.github.bucket4j.Bucket

Tries to consume as much tokens from this bucket as available at the moment of invocation.

tryConsumeAsMuchAsPossible(long) - Method in interface io.github.bucket4j.Bucket

Tries to consume as much tokens from bucket as available in the bucket at the moment of invocation, but tokens which should be consumed is limited by than not more than limit.

TryConsumeCommand - Class in io.github.bucket4j.grid

TryConsumeCommand(long) - Constructor for class io.github.bucket4j.grid.TryConsumeCommand

tryConsumeImpl(long) - Method in class io.github.bucket4j.AbstractBucket

tryConsumeImpl(long) - Method in class io.github.bucket4j.grid.GridBucket

tryConsumeImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket

tryConsumeImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket

tryLock() - Method in class io.github.bucket4j.local.FakeLock

tryLock(long, TimeUnit) - Method in class io.github.bucket4j.local.FakeLock

U

unlock() - Method in class io.github.bucket4j.local.FakeLock

UNSPECIFIED_WAITING_LIMIT - Static variable in class io.github.bucket4j.AbstractBucket

V

valueOf(String) - Static method in enum io.github.bucket4j.grid.RecoveryStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.github.bucket4j.local.SynchronizationStrategy

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.github.bucket4j.grid.RecoveryStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.github.bucket4j.local.SynchronizationStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

W

withCustomTimePrecision(TimeMeter) - Method in class io.github.bucket4j.ConfigurationBuilder

Creates instance of ConfigurationBuilder which will create buckets with customTimeMeter as time meter.

withMillisecondPrecision() - Method in class io.github.bucket4j.ConfigurationBuilder

Creates instance of ConfigurationBuilder which will create buckets with TimeMeter.SYSTEM_MILLISECONDS as time meter.

withNanosecondPrecision() - Method in class io.github.bucket4j.ConfigurationBuilder

Creates instance of ConfigurationBuilder which will create buckets with TimeMeter.SYSTEM_NANOTIME as time meter.

A B C D E F G I L N P R S T U V W