Package org.comroid.restless.server

Interface Ratelimiter

All Superinterfaces:

java.util.function.BiFunction<RatelimitedEndpoint,REST.Request,java.util.concurrent.CompletableFuture<REST.Request>>

public interface Ratelimiter
extends java.util.function.BiFunction<RatelimitedEndpoint,REST.Request,java.util.concurrent.CompletableFuture<REST.Request>>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Ratelimiter.Support

Field Summary

Fields

Modifier and Type	Field	Description
static Ratelimiter	INSTANT
static com.google.common.flogger.FluentLogger	logger

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<REST.Request>	apply(RatelimitedEndpoint restEndpoint, REST.Request request)	Applies the provided request with the given endpoint to this ratelimiter and returns a CompletionStage that completes with the given request as soon as this ratelimiter allows its execution.
static int	calculateOffset(int rps, int size)
static Ratelimiter	ofPool(java.util.concurrent.ScheduledExecutorService executor, RatelimitedEndpoint... endpoints)

Methods inherited from interface java.util.function.BiFunction

andThen

Field Detail

logger

static final com.google.common.flogger.FluentLogger logger

INSTANT

static final Ratelimiter INSTANT

Method Detail

ofPool

static Ratelimiter ofPool(java.util.concurrent.ScheduledExecutorService executor,
                          RatelimitedEndpoint... endpoints)

calculateOffset

static int calculateOffset(int rps,
                           int size)

apply

java.util.concurrent.CompletableFuture<REST.Request> apply(RatelimitedEndpoint restEndpoint,
                                                           REST.Request request)

Applies the provided request with the given endpoint to this ratelimiter and returns a CompletionStage that completes with the given request as soon as this ratelimiter allows its execution.

Specified by:

apply in interface java.util.function.BiFunction<RatelimitedEndpoint,REST.Request,java.util.concurrent.CompletableFuture<REST.Request>>

Parameters:

restEndpoint - The endpoint that is gonna be accessed

request - The request that is yet to be executed

Returns:

A CompletableFuture that completes as soon as the ratelimiter allows execution of the request.