Class McpTokenBucketConfig

java.lang.Object

com.soklet.McpTokenBucketConfig

@ThreadSafe
public final class McpTokenBucketConfig
extends Object

Immutable finite configuration for Soklet's built-in in-memory token-bucket rate limiter. Capacity, refill quantity, and refill interval must all be explicitly configured. This type has no unlimited or disabled form.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	McpTokenBucketConfig.Builder	Single-threaded builder for immutable token-bucket configurations.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object other)
@NonNull Long	getCapacity()	Returns the maximum number of tokens held by one bucket.
@NonNull Duration	getRefillInterval()	Returns the refill interval.
@NonNull Long	getRefillTokens()	Returns the number of tokens replenished during one refill interval.
int	hashCode()
static @NonNull McpTokenBucketConfig.Builder	withCapacity(@NonNull Long capacity)	Vends a builder primed with the bucket's maximum token capacity.

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

withCapacity

public static @NonNull McpTokenBucketConfig.Builder withCapacity(@NonNull Long capacity)

Vends a builder primed with the bucket's maximum token capacity.

Parameters:

capacity - positive maximum number of tokens

Returns:

token-bucket configuration builder

Throws:

NullPointerException - if capacity is null

getCapacity

public @NonNull Long getCapacity()

Returns the maximum number of tokens held by one bucket.

Returns:

positive token capacity

getRefillTokens

public @NonNull Long getRefillTokens()

Returns the number of tokens replenished during one refill interval.

Returns:

positive refill quantity

getRefillInterval

public @NonNull Duration getRefillInterval()

Returns the refill interval.

Returns:

positive refill interval

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

Returns:

whether every token-bucket setting is equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

structural token-bucket configuration hash code