com.mesosphere.sdk.scheduler

Class TokenBucket

java.lang.Object

com.mesosphere.sdk.scheduler.TokenBucket

public class TokenBucket
extends java.lang.Object

This class implements a token bucket to limit the rate at which actions may be taken. The assumption is that clients will not take actions unless they receive a token via the tryAcquire() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenBucket.Builder This class is a builder for TokenBuckets.

Field Summary

Fields

Modifier and Type	Field and Description
static java.time.Duration	DEFAULT_ACQUIRE_INTEVAL
static int	DEFAULT_CAPACITY
static java.time.Duration	DEFAULT_INCREMENT_INTERVAL
static int	DEFAULT_INITIAL_COUNT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TokenBucket(int initial, int capacity, java.time.Duration incrementInterval, java.time.Duration acquireInterval) A TokenBucket acts as a rate limiting helper.

Method Summary

Modifier and Type	Method and Description
static TokenBucket.Builder	newBuilder()
protected long	now()
TokenBucket.Builder	toBuilder()
boolean	tryAcquire() This method returns true if a rate-limited action should be executed, and false if the action should not occur.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

See Also:

Constant Field Values

DEFAULT_INITIAL_COUNT

public static final int DEFAULT_INITIAL_COUNT

See Also:

Constant Field Values

DEFAULT_ACQUIRE_INTEVAL

public static final java.time.Duration DEFAULT_ACQUIRE_INTEVAL

DEFAULT_INCREMENT_INTERVAL

public static final java.time.Duration DEFAULT_INCREMENT_INTERVAL

Constructor Detail

TokenBucket

protected TokenBucket(int initial,
                      int capacity,
                      java.time.Duration incrementInterval,
                      java.time.Duration acquireInterval)

A TokenBucket acts as a rate limiting helper. Clients should not perform rate limited work without acquiring a token from the tryAcquire() method.

Parameters:

initial - The initial number of tokens available

capacity - The maximum number of tokens the bucket may hold

incrementInterval - The interval between adding new tokens to the bucket

acquireInterval - The minimum interval between allowing tokens to be acquired

Method Detail

newBuilder

public static TokenBucket.Builder newBuilder()

toBuilder

public TokenBucket.Builder toBuilder()

tryAcquire

public boolean tryAcquire()

This method returns true if a rate-limited action should be executed, and false if the action should not occur.

now

protected long now()