Package com.github.twitch4j.common.util

Class BucketUtils

java.lang.Object

com.github.twitch4j.common.util.BucketUtils

public class BucketUtils
extends Object

Constructor Summary

Constructors

Constructor	Description
BucketUtils()

Method Summary

Modifier and Type	Method	Description
static @NotNull Bucket	createBucket(@NotNull Bandwidth limit)	Creates a bucket with the specified bandwidth.
static @NotNull Bucket	createBucket(@NotNull Bandwidth... limits)	Creates a bucket with the specified bandwidths.
static @NotNull Bucket	createBucket(@NotNull Iterable<Bandwidth> limits)	Creates a bucket with the specified bandwidths.
static @NotNull CompletableFuture<Void>	scheduleAgainstBucket(@NotNull Bucket bucket, @NotNull ScheduledExecutorService executor, @NotNull Runnable action)	Runs the action after a token has been consumed from the bucket using the executor.
static <T> @NotNull CompletableFuture<T>	scheduleAgainstBucket(@NotNull Bucket bucket, @NotNull ScheduledExecutorService executor, @NotNull Callable<T> call)	Performs the callable after a token has been consumed from the bucket using the executor.

Methods inherited from class java.lang.Object

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

Constructor Details

BucketUtils

public BucketUtils()

Method Details

createBucket

@NotNull
public static @NotNull Bucket createBucket(@NotNull
 @NotNull Bandwidth limit)

Creates a bucket with the specified bandwidth.

Parameters:

limit - the bandwidth

Returns:

the bucket

createBucket

@NotNull
public static @NotNull Bucket createBucket(@NotNull
 @NotNull Bandwidth... limits)

Creates a bucket with the specified bandwidths.

Parameters:

limits - the bandwidths

Returns:

the bucket

createBucket

@NotNull
public static @NotNull Bucket createBucket(@NotNull
 @NotNull Iterable<Bandwidth> limits)

Creates a bucket with the specified bandwidths.

Parameters:

limits - the bandwidths

Returns:

the bucket

scheduleAgainstBucket

@NotNull
public static <T> @NotNull CompletableFuture<T> scheduleAgainstBucket(@NotNull
 @NotNull Bucket bucket,
 @NotNull
 @NotNull ScheduledExecutorService executor,
 @NotNull
 @NotNull Callable<T> call)

Performs the callable after a token has been consumed from the bucket using the executor.

Note: ExecutionException should be inspected if the passed action can throw an exception.

Parameters:

bucket - rate limit bucket

executor - scheduled executor service for async calls

call - task that requires a bucket point

Returns:

the future result of the call

scheduleAgainstBucket

@NotNull
public static @NotNull CompletableFuture<Void> scheduleAgainstBucket(@NotNull
 @NotNull Bucket bucket,
 @NotNull
 @NotNull ScheduledExecutorService executor,
 @NotNull
 @NotNull Runnable action)

Runs the action after a token has been consumed from the bucket using the executor.

Note: while the executor is used to consume the bucket token, the action is performed on the fork-join common pool, by default.

Parameters:

bucket - rate limit bucket

executor - scheduled executor service for async calls

action - runnable that requires a bucket point

Returns:

a future to track completion progress