com.netflix.concurrency.limits.limiter

Class SimpleLimiter<ContextT>

java.lang.Object

com.netflix.concurrency.limits.limiter.AbstractLimiter<ContextT>

com.netflix.concurrency.limits.limiter.SimpleLimiter<ContextT>

All Implemented Interfaces:

Limiter<ContextT>

public class SimpleLimiter<ContextT>
extends AbstractLimiter<ContextT>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleLimiter.Builder<ContextT>

Nested classes/interfaces inherited from interface com.netflix.concurrency.limits.Limiter

Limiter.Listener

Constructor Summary

Constructors

Constructor and Description
SimpleLimiter(AbstractLimiter.Builder<?,ContextT> builder)

Method Summary

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

Methods inherited from class com.netflix.concurrency.limits.limiter.AbstractLimiter

createListener, getInflight, getLimit, onNewLimit

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleLimiter

public SimpleLimiter(AbstractLimiter.Builder<?,ContextT> builder)

Method Detail

newBuilder

public static <ContextT> SimpleLimiter.Builder<ContextT> newBuilder()

acquire

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

Description copied from interface: Limiter

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.