Package io.smallrye.faulttolerance.api

Interface TypedGuard.Builder.RateLimitBuilder<T>

Enclosing interface:

TypedGuard.Builder<T>

public static interface TypedGuard.Builder.RateLimitBuilder<T>

Configures a rate limit.

See Also:

• @RateLimit

Method Summary

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

Method Details

limit

TypedGuard.Builder.RateLimitBuilder<T> 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

See Also:

• @RateLimit.value

window

TypedGuard.Builder.RateLimitBuilder<T> 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

See Also:

• @RateLimit.window
• @RateLimit.windowUnit

minSpacing

TypedGuard.Builder.RateLimitBuilder<T> 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

See Also:

• @RateLimit.minSpacing
• @RateLimit.minSpacingUnit

type

TypedGuard.Builder.RateLimitBuilder<T> 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

See Also:

• @RateLimit.type

onPermitted

TypedGuard.Builder.RateLimitBuilder<T> 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

TypedGuard.Builder.RateLimitBuilder<T> 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

TypedGuard.Builder<T> done()

Returns the original fault tolerance builder.

Returns:

the original fault tolerance builder

with

default TypedGuard.Builder.RateLimitBuilder<T> with(Consumer<TypedGuard.Builder.RateLimitBuilder<T>> consumer)