Class RateLimiterOperator<T>

java.lang.Object
io.github.resilience4j.rxjava3.ratelimiter.operator.RateLimiterOperator<T>
Type Parameters:
T - the value type
All Implemented Interfaces:
io.reactivex.rxjava3.core.CompletableTransformer, io.reactivex.rxjava3.core.FlowableTransformer<T,T>, io.reactivex.rxjava3.core.MaybeTransformer<T,T>, io.reactivex.rxjava3.core.ObservableTransformer<T,T>, io.reactivex.rxjava3.core.SingleTransformer<T,T>
public class RateLimiterOperator<T> extends Object implements io.reactivex.rxjava3.core.FlowableTransformer<T,T>, io.reactivex.rxjava3.core.SingleTransformer<T,T>, io.reactivex.rxjava3.core.MaybeTransformer<T,T>, io.reactivex.rxjava3.core.CompletableTransformer, io.reactivex.rxjava3.core.ObservableTransformer<T,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.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final io.github.resilience4j.ratelimiter.RateLimiter
    rateLimiter
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    RateLimiterOperator(io.github.resilience4j.ratelimiter.RateLimiter rateLimiter)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    io.reactivex.rxjava3.core.CompletableSource
    apply(io.reactivex.rxjava3.core.Completable upstream)
     
    org.reactivestreams.Publisher<T>
    apply(io.reactivex.rxjava3.core.Flowable<T> upstream)
     
    io.reactivex.rxjava3.core.MaybeSource<T>
    apply(io.reactivex.rxjava3.core.Maybe<T> upstream)
     
    io.reactivex.rxjava3.core.ObservableSource<T>
    apply(io.reactivex.rxjava3.core.Observable<T> upstream)
     
    io.reactivex.rxjava3.core.SingleSource<T>
    apply(io.reactivex.rxjava3.core.Single<T> upstream)
     
    static <T> RateLimiterOperator<T>
    of(io.github.resilience4j.ratelimiter.RateLimiter rateLimiter)
    Creates a RateLimiterOperator.

    Methods inherited from class Object

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

  • Field Details

    • rateLimiter

      private final io.github.resilience4j.ratelimiter.RateLimiter rateLimiter

  • Constructor Details

    • RateLimiterOperator

      private RateLimiterOperator(io.github.resilience4j.ratelimiter.RateLimiter rateLimiter)

  • Method Details

    • of

      public static <T> RateLimiterOperator<T> of(io.github.resilience4j.ratelimiter.RateLimiter rateLimiter)
      Creates a RateLimiterOperator.
      Parameters:
      rateLimiter - the RateLimiter
      Returns:
      a RateLimiterOperator

    • apply

      public org.reactivestreams.Publisher<T> apply(io.reactivex.rxjava3.core.Flowable<T> upstream)
      Specified by:
      apply in interface io.reactivex.rxjava3.core.FlowableTransformer<T,T>

    • apply

      public io.reactivex.rxjava3.core.SingleSource<T> apply(io.reactivex.rxjava3.core.Single<T> upstream)
      Specified by:
      apply in interface io.reactivex.rxjava3.core.SingleTransformer<T,T>

    • apply

      public io.reactivex.rxjava3.core.CompletableSource apply(io.reactivex.rxjava3.core.Completable upstream)
      Specified by:
      apply in interface io.reactivex.rxjava3.core.CompletableTransformer

    • apply

      public io.reactivex.rxjava3.core.MaybeSource<T> apply(io.reactivex.rxjava3.core.Maybe<T> upstream)
      Specified by:
      apply in interface io.reactivex.rxjava3.core.MaybeTransformer<T,T>

    • apply

      public io.reactivex.rxjava3.core.ObservableSource<T> apply(io.reactivex.rxjava3.core.Observable<T> upstream)
      Specified by:
      apply in interface io.reactivex.rxjava3.core.ObservableTransformer<T,T>