fr33m0nk.clj-bucket4j — net.clojars.fr33m0nk/clj-bucket4j 0.1.3

bucket-builder clj

(bucket-builder)

returns new builder instance for customizing Bucket

bucket-configuration-builder clj

(bucket-configuration-builder)

returns new Bucket Configuration Builder instance for customizing Bucket Configuration

classic-bandwidth clj

(classic-bandwidth capacity refill)

(classic-bandwidth capacity refill id)

(classic-bandwidth capacity refill id initial-token-count)

IBlockingBucket clj protocol

consume-blocking-bucket clj

(consume-blocking-bucket blocking-bucket token-quantity)

(consume-blocking-bucket blocking-bucket token-quantity blocking-strategy)

Consumes a specified number of tokens from the bucket

consume-blocking-bucket-uninterruptibly clj

(consume-blocking-bucket-uninterruptibly blocking-bucket
                                         token-quantity
                                         max-wait-time-ms)

(consume-blocking-bucket-uninterruptibly blocking-bucket
                                         token-quantity
                                         max-wait-time-ms
                                         uninterruptible-blocking-strategy)

Has same semantic with {@link #(consume-blocking-bucket token-quantity blocking-strategy)} but ignores interrupts(just restores interruption flag on exit)

try-consume-blocking-bucket clj

(try-consume-blocking-bucket blocking-bucket token-quantity max-wait-time-ms)

(try-consume-blocking-bucket blocking-or-scheduling-bucket
                             token-quantity
                             max-wait-time-ms
                             blocking-strategy)

Tries to consume a specified number of tokens from the bucket

try-consume-blocking-bucket-uninterruptibly clj

(try-consume-blocking-bucket-uninterruptibly blocking-bucket
                                             token-quantity
                                             max-wait-time-ms)

(try-consume-blocking-bucket-uninterruptibly blocking-bucket
                                             token-quantity
                                             max-wait-time-ms
                                             uninterruptible-blocking-strategy)

Has same semantic with {@link (try-consume-blocking-bucket token-quantity, max-wait-time-ms, blocking-strategy)} but ignores interrupts(just restores interruption flag on exit)

IBucket clj protocol

consume-ignoring-rate-limits clj

(consume-ignoring-rate-limits bucket token-quantity)

Consumes {@code token-quantity} from bucket ignoring all limits

as-blocking clj

(as-blocking bucket)

Returns the blocking API for this bucket, that provides operations which are able to block caller thread in case of lack of tokens

estimate-ability-to-consume clj

(estimate-ability-to-consume bucket token-quantity)

Estimates ability to consume a specified number of tokens

as-scheduler clj

(as-scheduler bucket)

Returns the Scheduler API for this bucket

try-consume clj

(try-consume bucket token-quantity)

Tries to consume a specified number of tokens from this bucket

try-consuming-and-return-remaining clj

(try-consuming-and-return-remaining bucket token-quantity)

Tries to consume a specified number of tokens from this bucket

force-add-tokens clj

(force-add-tokens bucket token-quantity)

Add <tt>token-quantity</tt> to bucket. In opposite to {@link #(add-tokens long)} usage of this method can lead to overflow bucket capacity.

try-consume-as-much-as-possible clj

(try-consume-as-much-as-possible bucket)

(try-consume-as-much-as-possible bucket token-quantity)

Tries to consume as many tokens from this bucket as available at the moment of invocation Returns number of tokens which have been consumed, or zero if nothing was consumed

reset clj

(reset bucket)

Reset all tokens up to maximum capacity

get-available-token-count clj

(get-available-token-count bucket)

Returns the amount of available tokens in this bucket

block-and-consume clj

(block-and-consume bucket token-quantity)

Tries to consume a specified number using blocking API

as-verbose clj

(as-verbose bucket)

Returns the Verbose API for this bucket

add-tokens clj

(add-tokens bucket token-quantity)

Add <tt>token-quantity</tt> to bucket.

IBucketBuilder clj protocol

add-limit clj

(add-limit bucket-builder bandwidth)

Adds limit to Builder object of LocalBucketBuilder or ConfigurationBuilder

with-custom-time-precision clj

(with-custom-time-precision bucket-builder custom-time-meter)

Sets custom time precision for Builder object of LocalBucketBuilder using supplied TimeMeter object

with-milli-second-precision clj

(with-milli-second-precision bucket-builder)

Sets millisecond precision for Builder object of LocalBucketBuilder

with-nano-second-precision clj

(with-nano-second-precision bucket-builder)

Sets nanosecond precision for Builder object of LocalBucketBuilder

with-synchronization-strategy clj

(with-synchronization-strategy bucket-builder synchronization-strategy)

Sets Synchronization for Builder object of LocalBucketBuilder using supplied SynchronizationStrategy object

IBuilder clj protocol

build clj

(build bucket-builder)

(build remote-bucket-builder key bucket-configuration)

Builds builder instance to concrete object

ICompareAndSwapBasedProxyManager clj protocol

get-proxy-configuration clj

(get-proxy-configuration proxy-manager bucket-key)

Returns BucketConfiguration for provided key from AbstractCompareAndSwapBasedProxyManager

get-remote-bucket-builder clj

(get-remote-bucket-builder proxy-manager)

Returns RemoteBucketBuilder instance from AbstractCompareAndSwapBasedProxyManager

IConsumptionProbe clj protocol

consumed? clj

(consumed? consumption-probe)

Returns Boolean from ConsumptionProbe indicating whether consumption was a success

get-nanos-to-wait-for-refill clj

(get-nanos-to-wait-for-refill consumption-probe)

Returns Nano seconds to wait from ConsumptionProbe for a complete refill

get-nanos-to-wait-for-reset clj

(get-nanos-to-wait-for-reset consumption-probe)

Returns Nano seconds to wait from ConsumptionProbe for a complete reset

get-remaining-tokens clj

(get-remaining-tokens consumption-probe)

Returns remaining tokens from ConsumptionProbe after consumption

IRemoteBucketBuilder clj protocol

with-implicit-configuration-replacement clj

(with-implicit-configuration-replacement remote-bucket-builder
                                         desired-configuration-revision
                                         token-inheritance-strategy)

Configuration replacement strategy for RemoteBucketBuilder

with-optimization clj

(with-optimization remote-bucket-builder optimization)

Optimization strategy for RemoteBucketBuilder

with-recovery-strategy clj

(with-recovery-strategy remote-bucket-builder recovery-strategy)

Recovery strategy for RemoteBucketBuilder

ISchedulingBucket clj protocol

consume-scheduling-bucket clj

(consume-scheduling-bucket scheduling-bucket token-quantity scheduler)

Consumes the specified number of tokens from the bucket

try-consume-scheduling-bucket clj

(try-consume-scheduling-bucket scheduling-bucket
                               token-quantity
                               max-wait-time-ms
                               scheduler)

Tries to consume the specified number of tokens from the bucket

IVerboseResult clj protocol

get-configuration clj

(get-configuration verbose-result)

BucketConfiguration Object from VerboseResult

get-diagnostics clj

(get-diagnostics verbose-result)

Diagnostics map from VerboseResult

get-operation-time-nanos clj

(get-operation-time-nanos verbose-result)

Operation time from VerboseResult

get-state clj

(get-state verbose-result)

BucketState Object from VerboseResult

get-value clj

(get-value verbose-result)

Value from VerboseResult

get-verbose-result-map clj

(get-verbose-result-map verbose-result)

VerboseResult as a map

refill-greedy clj

(refill-greedy token-quantity interval-ms)

refill-intervally clj

(refill-intervally token-quantity interval-ms)

refill-intervally-aligned clj

(refill-intervally-aligned token-quantity
                           interval-ms
                           time-of-first-refill
                           use-adaptive-initial-tokens?)

simple-bandwidth clj

(simple-bandwidth capacity interval-ms)

(simple-bandwidth capacity interval-ms id)

(simple-bandwidth capacity interval-ms id initial-token-count)