Package org.redisson.api

Interface RSemaphoreReactive

All Superinterfaces:

RExpirableReactive, RObjectReactive

public interface RSemaphoreReactive
extends RExpirableReactive

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
org.reactivestreams.Publisher<Void>	acquire()	Acquires a permit from this semaphore.
org.reactivestreams.Publisher<Void>	acquire(int permits)	Acquires the given number of permits, if they are available, and returns immediately, reducing the number of available permits by the given amount.
org.reactivestreams.Publisher<Void>	reducePermits(int permits)	Shrinks the number of available permits by the indicated reduction.
org.reactivestreams.Publisher<Void>	release()	Releases a permit, returning it to the semaphore.
org.reactivestreams.Publisher<Void>	release(int permits)	Releases the given number of permits, returning them to the semaphore.
org.reactivestreams.Publisher<Boolean>	tryAcquire()	Acquires a permit only if one is available at the time of invocation.
org.reactivestreams.Publisher<Boolean>	tryAcquire(int permits)	Acquires the given number of permits only if all are available at the time of invocation.
org.reactivestreams.Publisher<Boolean>	tryAcquire(int permits, long waitTime, TimeUnit unit)	Acquires the given number of permits only if all are available within the given waiting time.
org.reactivestreams.Publisher<Boolean>	tryAcquire(long waitTime, TimeUnit unit)	Acquires a permit, if one is available and returns immediately, with the value true, reducing the number of available permits by one.
org.reactivestreams.Publisher<Boolean>	trySetPermits(int permits)	Sets number of permits.

Methods inherited from interface org.redisson.api.RExpirableReactive

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObjectReactive

copy, delete, dump, getCodec, getName, isExists, migrate, move, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, touch, unlink

Method Detail

tryAcquire

org.reactivestreams.Publisher<Boolean> tryAcquire()

Acquires a permit only if one is available at the time of invocation.

Acquires a permit, if one is available and returns immediately, with the value true, reducing the number of available permits by one.

If no permit is available then this method will return immediately with the value false.

Returns:

true if a permit was acquired and false otherwise

tryAcquire

org.reactivestreams.Publisher<Boolean> tryAcquire(int permits)

Acquires the given number of permits only if all are available at the time of invocation.

Acquires a permits, if all are available and returns immediately, with the value true, reducing the number of available permits by given number of permits.

If no permits are available then this method will return immediately with the value false.

Parameters:

permits - the number of permits to acquire

Returns:

true if a permit was acquired and false otherwise

acquire

org.reactivestreams.Publisher<Void> acquire()

Acquires a permit from this semaphore.

Acquires a permit, if one is available and returns immediately, reducing the number of available permits by one.

Returns:

void

acquire

org.reactivestreams.Publisher<Void> acquire(int permits)

Acquires the given number of permits, if they are available, and returns immediately, reducing the number of available permits by the given amount.

Parameters:

permits - the number of permits to acquire

Returns:

void

Throws:

IllegalArgumentException - if permits is negative

release

org.reactivestreams.Publisher<Void> release()

Releases a permit, returning it to the semaphore.

Releases a permit, increasing the number of available permits by one. If any threads of Redisson client are trying to acquire a permit, then one is selected and given the permit that was just released.

There is no requirement that a thread that releases a permit must have acquired that permit by calling acquire(). Correct usage of a semaphore is established by programming convention in the application.

Returns:

void

release

org.reactivestreams.Publisher<Void> release(int permits)

Releases the given number of permits, returning them to the semaphore.

Releases the given number of permits, increasing the number of available permits by the given number of permits. If any threads of Redisson client are trying to acquire a permits, then next threads is selected and tries to acquire the permits that was just released.

There is no requirement that a thread that releases a permits must have acquired that permit by calling acquire(). Correct usage of a semaphore is established by programming convention in the application.

Parameters:

permits - amount

Returns:

void

trySetPermits

org.reactivestreams.Publisher<Boolean> trySetPermits(int permits)

Sets number of permits.

Parameters:

permits - - number of permits

Returns:

true if permits has been set successfully, otherwise false.

tryAcquire

org.reactivestreams.Publisher<Boolean> tryAcquire(long waitTime,
                                                  TimeUnit unit)

Acquires a permit, if one is available and returns immediately, with the value true, reducing the number of available permits by one.

If a permit is acquired then the value true is returned.

If the specified waiting time elapses then the value false is returned. If the time is less than or equal to zero, the method will not wait at all.

Parameters:

waitTime - the maximum time to wait for a permit

unit - the time unit of the timeout argument

Returns:

true if a permit was acquired and false if the waiting time elapsed before a permit was acquired

tryAcquire

org.reactivestreams.Publisher<Boolean> tryAcquire(int permits,
                                                  long waitTime,
                                                  TimeUnit unit)

Acquires the given number of permits only if all are available within the given waiting time.

Acquires a permits, if all are available and returns immediately, with the value true, reducing the number of available permits by one.

If a permits is acquired then the value true is returned.

If the specified waiting time elapses then the value false is returned. If the time is less than or equal to zero, the method will not wait at all.

Parameters:

permits - amount

waitTime - the maximum time to wait for a available permits

unit - the time unit of the timeout argument

Returns:

true if a permit was acquired and false if the waiting time elapsed before a permit was acquired

reducePermits

org.reactivestreams.Publisher<Void> reducePermits(int permits)

Shrinks the number of available permits by the indicated reduction. This method can be useful in subclasses that use semaphores to track resources that become unavailable. This method differs from acquire() in that it does not block waiting for permits to become available.

Parameters:

permits - - reduction the number of permits to remove

Returns:

void

Throws:

IllegalArgumentException - if reduction is negative