org.spf4j.concurrent

Interface PermitSupplier

All Known Subinterfaces:

Semaphore

All Known Implementing Classes:

CompoundSemaphore, GuavaRateLimiter, JdbcSemaphore, LocalSemaphore, ProcessLimitedJdbcSemaphore, RateLimiter

@ThreadSafe
 @ParametersAreNonnullByDefault
public interface PermitSupplier

Author:

Zoltan Farkas

Method Summary

Modifier and Type	Method and Description
default void	acquire(int nrPermits, long timeout, TimeUnit unit) Acquire a arbitrary number of permits.
default void	acquire(long timeout, TimeUnit unit) Acquire one permit.
default Semaphore	toSemaphore()
boolean	tryAcquire(int nrPermits, long deadlineNanos)
default boolean	tryAcquire(int nrPermits, long timeout, TimeUnit unit) try to acquire a number of permits.
default boolean	tryAcquire(long timeout, TimeUnit unit) try to acquire a permit.

Method Detail

acquire

default void acquire(long timeout,
                     TimeUnit unit)
              throws InterruptedException,
                     TimeoutException

Acquire one permit.

Parameters:

timeout - time to wait for permit to become available.

unit - units of time.

Throws:

InterruptedException - - operation interrupted.

TimeoutException - - timed out.

acquire

default void acquire(int nrPermits,
                     @Nonnegative
                     long timeout,
                     TimeUnit unit)
              throws InterruptedException,
                     TimeoutException

Acquire a arbitrary number of permits.

Parameters:

nrPermits - - numer of permits to acquire.

timeout - - time to wait for permit to become available.

unit - - units of time.

Throws:

InterruptedException - - operation interrupted.

TimeoutException - - timed out.

tryAcquire

@CheckReturnValue
default boolean tryAcquire(@Nonnegative
                                             long timeout,
                                             TimeUnit unit)
                                      throws InterruptedException

try to acquire a permit.

Parameters:

timeout - time to wait for permit to become available.

unit - units of time.

Returns:

true if permit acquired, false if timed out.

Throws:

InterruptedException - - operation interrupted.

tryAcquire

@CheckReturnValue
default boolean tryAcquire(@Nonnegative
                                             int nrPermits,
                                             @Nonnegative
                                             long timeout,
                                             TimeUnit unit)
                                      throws InterruptedException

try to acquire a number of permits.

Parameters:

nrPermits - number of permits to acquire.

timeout - time to wait for permits to become available.

unit - units of time.

Returns:

true if permits acquired, false if timed out.

Throws:

InterruptedException - - operation interrupted.

tryAcquire

@CheckReturnValue
boolean tryAcquire(@Nonnegative
                                     int nrPermits,
                                     long deadlineNanos)
                              throws InterruptedException

Throws:

InterruptedException

toSemaphore

default Semaphore toSemaphore()