com.netflix.concurrency.limits

Interface Limiter<ContextT>

Type Parameters:

ContextT - Some limiters take a context to perform more fine grained limits.

All Known Implementing Classes:

AbstractLimiter, AbstractPartitionedLimiter, BlockingLimiter, LifoBlockingLimiter, SimpleLimiter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Limiter<ContextT>

Contract for a concurrency limiter. The caller is expected to call acquire() for each request and must also release the returned listener when the operation completes. Releasing the Listener may trigger an update to the concurrency limit based on error rate or latency measurement.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Limiter.Listener

Method Summary

Modifier and Type	Method and Description
java.util.Optional<Limiter.Listener>	acquire(ContextT context) Acquire a token from the limiter.

Method Detail

acquire

java.util.Optional<Limiter.Listener> acquire(ContextT context)

Acquire a token from the limiter. Returns an Optional.empty() if the limit has been exceeded. If acquired the caller must call one of the Listener methods when the operation has been completed to release the count.

Parameters:

context - Context for the request

Returns:

Optional.empty() if limit exceeded.