Package io.smallrye.faulttolerance.api

Interface FaultTolerance.Builder.RateLimitBuilder<T,R>

Enclosing interface:

FaultTolerance.Builder<T,R>

public static interface FaultTolerance.Builder.RateLimitBuilder<T,R>

Configures a rate limit.

See Also:

@RateLimit

Method Summary

Modifier and Type	Method	Description
FaultTolerance.Builder<T,R>	done()	Returns the original fault tolerance builder.
FaultTolerance.Builder.RateLimitBuilder<T,R>	limit(int value)	Sets the maximum number of invocations in a time window.
FaultTolerance.Builder.RateLimitBuilder<T,R>	minSpacing(long value, ChronoUnit unit)	Sets the minimum spacing between invocations.
FaultTolerance.Builder.RateLimitBuilder<T,R>	onPermitted(Runnable callback)	Sets a callback that will be invoked when this rate limit permits an invocation.
FaultTolerance.Builder.RateLimitBuilder<T,R>	onRejected(Runnable callback)	Sets a callback that will be invoked when this rate limit rejects an invocation.
FaultTolerance.Builder.RateLimitBuilder<T,R>	type(RateLimitType value)	Sets the type of time windows used for rate limiting.
FaultTolerance.Builder.RateLimitBuilder<T,R>	window(long value, ChronoUnit unit)	Sets the time window length.
default FaultTolerance.Builder.RateLimitBuilder<T,R>	with(Consumer<FaultTolerance.Builder.RateLimitBuilder<T,R>> consumer)

Method Detail

limit

FaultTolerance.Builder.RateLimitBuilder<T,R> limit(int value)

Sets the maximum number of invocations in a time window. Defaults to 100.

Parameters:

value - maximum number of invocations in a time window, must be >= 1

Returns:

this rate limit builder

window

FaultTolerance.Builder.RateLimitBuilder<T,R> window(long value,
                                                          ChronoUnit unit)

Sets the time window length. Defaults to 1 second.

Parameters:

value - the time window size, must be >= 1

Returns:

this rate limit builder

minSpacing

FaultTolerance.Builder.RateLimitBuilder<T,R> minSpacing(long value,
                                                              ChronoUnit unit)

Sets the minimum spacing between invocations. Defaults to 0.

Parameters:

value - the minimum spacing, must be >= 0

Returns:

this rate limit builder

type

FaultTolerance.Builder.RateLimitBuilder<T,R> type(RateLimitType value)

Sets the type of time windows used for rate limiting. Defaults to RateLimitType.FIXED.

Parameters:

value - the time window type, must not be null

Returns:

this rate limit builder

onPermitted

FaultTolerance.Builder.RateLimitBuilder<T,R> onPermitted(Runnable callback)

Sets a callback that will be invoked when this rate limit permits an invocation.

The callback must be fast and non-blocking and must not throw an exception.

Parameters:

callback - the permitted callback, must not be null

Returns:

this rate limit builder

onRejected

FaultTolerance.Builder.RateLimitBuilder<T,R> onRejected(Runnable callback)

Sets a callback that will be invoked when this rate limit rejects an invocation.

The callback must be fast and non-blocking and must not throw an exception.

Parameters:

callback - the rejected callback, must not be null

Returns:

this rate limit builder

done

FaultTolerance.Builder<T,R> done()

Returns the original fault tolerance builder.

Returns:

the original fault tolerance builder

with

default FaultTolerance.Builder.RateLimitBuilder<T,R> with(Consumer<FaultTolerance.Builder.RateLimitBuilder<T,R>> consumer)