io.github.resilience4j.reactor.ratelimiter.operator

Class RateLimiterOperator<T>

java.lang.Object

io.github.resilience4j.reactor.ratelimiter.operator.RateLimiterOperator<T>

Type Parameters:

T - the value type

All Implemented Interfaces:

java.util.function.Function<org.reactivestreams.Publisher<T>,org.reactivestreams.Publisher<T>>, java.util.function.UnaryOperator<org.reactivestreams.Publisher<T>>

public class RateLimiterOperator<T>
extends java.lang.Object
implements java.util.function.UnaryOperator<org.reactivestreams.Publisher<T>>

A RateLimiter operator which checks if a downstream subscriber/observer can acquire a permission to subscribe to an upstream Publisher. Otherwise emits a RequestNotPermitted if the rate limit is exceeded.

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<T>	apply(org.reactivestreams.Publisher<T> publisher)
static <T> RateLimiterOperator<T>	of(io.github.resilience4j.ratelimiter.RateLimiter rateLimiter) Creates a RateLimiterOperator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.UnaryOperator

identity

Methods inherited from interface java.util.function.Function

andThen, compose

Method Detail

of

public static <T> RateLimiterOperator<T> of(io.github.resilience4j.ratelimiter.RateLimiter rateLimiter)

Creates a RateLimiterOperator.

Type Parameters:

T - the value type of the upstream and downstream

Parameters:

rateLimiter - the Rate limiter

Returns:

a RateLimiterOperator

apply

public org.reactivestreams.Publisher<T> apply(org.reactivestreams.Publisher<T> publisher)

Specified by:

apply in interface java.util.function.Function<org.reactivestreams.Publisher<T>,org.reactivestreams.Publisher<T>>