org.isomorphism.util

Class TokenBuckets.Builder

java.lang.Object

org.isomorphism.util.TokenBuckets.Builder

Enclosing class:

TokenBuckets

public static class TokenBuckets.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TokenBucket	build() Build the token bucket.
TokenBuckets.Builder	withBusyWaitSleepStrategy() Use a sleep strategy that will not yield the CPU to other processes.
TokenBuckets.Builder	withCapacity(long numTokens) Specify the overall capacity of the token bucket.
TokenBuckets.Builder	withFixedIntervalRefillStrategy(long refillTokens, long period, TimeUnit unit) Refill tokens at a fixed interval.
TokenBuckets.Builder	withInitialTokens(long numTokens) Initialize the token bucket with a specific number of tokens.
TokenBuckets.Builder	withRefillStrategy(TokenBucket.RefillStrategy refillStrategy) Use a user defined refill strategy.
TokenBuckets.Builder	withSleepStrategy(TokenBucket.SleepStrategy sleepStrategy) Use a user defined sleep strategy.
TokenBuckets.Builder	withYieldingSleepStrategy() Use a sleep strategy that will always attempt to yield the CPU to other processes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withCapacity

public TokenBuckets.Builder withCapacity(long numTokens)

Specify the overall capacity of the token bucket.

withInitialTokens

public TokenBuckets.Builder withInitialTokens(long numTokens)

Initialize the token bucket with a specific number of tokens.

withFixedIntervalRefillStrategy

public TokenBuckets.Builder withFixedIntervalRefillStrategy(long refillTokens,
                                                            long period,
                                                            TimeUnit unit)

Refill tokens at a fixed interval.

withRefillStrategy

public TokenBuckets.Builder withRefillStrategy(TokenBucket.RefillStrategy refillStrategy)

Use a user defined refill strategy.

withYieldingSleepStrategy

public TokenBuckets.Builder withYieldingSleepStrategy()

Use a sleep strategy that will always attempt to yield the CPU to other processes.

withBusyWaitSleepStrategy

public TokenBuckets.Builder withBusyWaitSleepStrategy()

Use a sleep strategy that will not yield the CPU to other processes. It will busy wait until more tokens become available.

withSleepStrategy

public TokenBuckets.Builder withSleepStrategy(TokenBucket.SleepStrategy sleepStrategy)

Use a user defined sleep strategy.

build

public TokenBucket build()

Build the token bucket.