org.redisson.reactive

Class RedissonPermitExpirableSemaphoreReactive

java.lang.Object

org.redisson.reactive.RedissonPermitExpirableSemaphoreReactive

All Implemented Interfaces:

RExpirableReactive, RObjectReactive, RPermitExpirableSemaphoreReactive

public class RedissonPermitExpirableSemaphoreReactive
extends Object
implements RPermitExpirableSemaphoreReactive

Author:

Nikita Koksharov

Constructor Summary

Constructors

Constructor and Description
RedissonPermitExpirableSemaphoreReactive(CommandReactiveExecutor connectionManager, String name, SemaphorePubSub semaphorePubSub)

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<String>	acquire() Acquires a permit from this semaphore, blocking until one is available, or the thread is interrupted.
org.reactivestreams.Publisher<String>	acquire(long leaseTime, TimeUnit unit) Acquires a permit with defined lease time from this semaphore, blocking until one is available, or the thread is interrupted.
org.reactivestreams.Publisher<Void>	addPermits(int permits) Increases or decreases the number of available permits by defined value.
org.reactivestreams.Publisher<Integer>	availablePermits() Returns the current number of available permits.
org.reactivestreams.Publisher<Boolean>	clearExpire() Clear an expire timeout or expire date for object in mode.
protected RLockAsync	createLock(CommandAsyncExecutor connectionManager, String name)
org.reactivestreams.Publisher<Boolean>	delete() Delete object in mode
protected void	encode(Collection<Object> params, Collection<?> values)
protected io.netty.buffer.ByteBuf	encode(Object value)
protected io.netty.buffer.ByteBuf	encodeMapKey(Object value)
protected io.netty.buffer.ByteBuf	encodeMapValue(Object value)
org.reactivestreams.Publisher<Boolean>	expire(long timeToLive, TimeUnit timeUnit) Set a timeout for object in mode.
org.reactivestreams.Publisher<Boolean>	expireAt(Date timestamp) Set an expire date for object in mode.
org.reactivestreams.Publisher<Boolean>	expireAt(long timestamp) Set an expire date for object in mode.
Codec	getCodec()
String	getName()
org.reactivestreams.Publisher<Boolean>	isExists() Check object existence
org.reactivestreams.Publisher<Void>	migrate(String host, int port, int database, long timeout) Transfer a object from a source Redis instance to a destination Redis instance in mode
org.reactivestreams.Publisher<Boolean>	move(int database) Move object to another database in mode
protected <V> reactor.core.publisher.Mono<V>	newSucceeded(V result)
<R> org.reactivestreams.Publisher<R>	reactive(Supplier<RFuture<R>> supplier)
org.reactivestreams.Publisher<Void>	release(String permitId) Releases a permit by its id, returning it to the semaphore.
org.reactivestreams.Publisher<Long>	remainTimeToLive() Get remaining time to live of object in milliseconds.
org.reactivestreams.Publisher<Void>	rename(String newName) Rename current object key to newName in mode
org.reactivestreams.Publisher<Boolean>	renamenx(String newName) Rename current object key to newName in mode only if new key is not exists
org.reactivestreams.Publisher<String>	tryAcquire() Acquires a permit only if one is available at the time of invocation.
org.reactivestreams.Publisher<String>	tryAcquire(long waitTime, long leaseTime, TimeUnit unit) Acquires a permit with defined lease time from this semaphore, if one becomes available within the given waiting time and the current thread has not been interrupted.
org.reactivestreams.Publisher<String>	tryAcquire(long waitTime, TimeUnit unit) Acquires a permit from this semaphore, if one becomes available within the given waiting time and the current thread has not been interrupted.
org.reactivestreams.Publisher<Boolean>	tryRelease(String permitId) Releases a permit by its id, returning it to the semaphore.
org.reactivestreams.Publisher<Boolean>	trySetPermits(int permits) Sets number of permits.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.RExpirableReactive

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObjectReactive

delete, getCodec, getName, isExists, migrate, move, rename, renamenx

Constructor Detail

RedissonPermitExpirableSemaphoreReactive

public RedissonPermitExpirableSemaphoreReactive(CommandReactiveExecutor connectionManager,
                                                String name,
                                                SemaphorePubSub semaphorePubSub)

Method Detail

createLock

protected RLockAsync createLock(CommandAsyncExecutor connectionManager,
                                String name)

acquire

public org.reactivestreams.Publisher<String> acquire()

Description copied from interface: RPermitExpirableSemaphoreReactive

Acquires a permit from this semaphore, blocking until one is available, or the thread is interrupted.

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

If no permit is available then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of two things happens:

• Some other thread invokes the RPermitExpirableSemaphoreReactive.release(String) method for this semaphore and the current thread is next to be assigned a permit; or
• Some other thread interrupts the current thread.

Specified by:

acquire in interface RPermitExpirableSemaphoreReactive

Returns:

permit id

acquire

public org.reactivestreams.Publisher<String> acquire(long leaseTime,
                                                     TimeUnit unit)

Description copied from interface: RPermitExpirableSemaphoreReactive

Acquires a permit with defined lease time from this semaphore, blocking until one is available, or the thread is interrupted.

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

If no permit is available then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of two things happens:

• Some other thread invokes the RPermitExpirableSemaphoreReactive.release(java.lang.String) method for this semaphore and the current thread is next to be assigned a permit; or
• Some other thread interrupts the current thread.

Specified by:

acquire in interface RPermitExpirableSemaphoreReactive

Parameters:

leaseTime - - permit lease time

unit - - time unit

Returns:

permit id

tryAcquire

public org.reactivestreams.Publisher<String> tryAcquire()

Description copied from interface: RPermitExpirableSemaphoreReactive

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 permit id, reducing the number of available permits by one.

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

Specified by:

tryAcquire in interface RPermitExpirableSemaphoreReactive

Returns:

permit id if a permit was acquired and null otherwise

tryAcquire

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

Description copied from interface: RPermitExpirableSemaphoreReactive

Acquires a permit from this semaphore, if one becomes available within the given waiting time and the current thread has not been interrupted.

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

If no permit is available then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of three things happens:

• Some other thread invokes the RPermitExpirableSemaphoreReactive.release(String) method for this semaphore and the current thread is next to be assigned a permit; or
• Some other thread interrupts the current thread; or
• The specified waiting time elapses.

If a permit is acquired then the permit id is returned.

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

Specified by:

tryAcquire in interface RPermitExpirableSemaphoreReactive

Parameters:

waitTime - the maximum time to wait for a permit

unit - the time unit of the timeout argument

Returns:

permit id if a permit was acquired and null if the waiting time elapsed before a permit was acquired

tryAcquire

public org.reactivestreams.Publisher<String> tryAcquire(long waitTime,
                                                        long leaseTime,
                                                        TimeUnit unit)

Description copied from interface: RPermitExpirableSemaphoreReactive

Acquires a permit with defined lease time from this semaphore, if one becomes available within the given waiting time and the current thread has not been interrupted.

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

If no permit is available then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of three things happens:

• Some other thread invokes the RPermitExpirableSemaphoreReactive.release(String) method for this semaphore and the current thread is next to be assigned a permit; or
• Some other thread interrupts the current thread; or
• The specified waiting time elapses.

If a permit is acquired then the permit id is returned.

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

Specified by:

tryAcquire in interface RPermitExpirableSemaphoreReactive

Parameters:

waitTime - the maximum time to wait for a permit

leaseTime - permit lease time

unit - the time unit of the timeout argument

Returns:

permit id if a permit was acquired and null if the waiting time elapsed before a permit was acquired

tryRelease

public org.reactivestreams.Publisher<Boolean> tryRelease(String permitId)

Description copied from interface: RPermitExpirableSemaphoreReactive

Releases a permit by its id, 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 RPermitExpirableSemaphoreReactive.acquire(). Correct usage of a semaphore is established by programming convention in the application.

Specified by:

tryRelease in interface RPermitExpirableSemaphoreReactive

Parameters:

permitId - - permit id

Returns:

true if a permit has been released and false otherwise

release

public org.reactivestreams.Publisher<Void> release(String permitId)

Description copied from interface: RPermitExpirableSemaphoreReactive

Releases a permit by its id, 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 RPermitExpirableSemaphoreReactive.acquire(). Correct usage of a semaphore is established by programming convention in the application.

Throws an exception if permit id doesn't exist or has already been release

Specified by:

release in interface RPermitExpirableSemaphoreReactive

Parameters:

permitId - - permit id

Returns:

void

availablePermits

public org.reactivestreams.Publisher<Integer> availablePermits()

Description copied from interface: RPermitExpirableSemaphoreReactive

Returns the current number of available permits.

Specified by:

availablePermits in interface RPermitExpirableSemaphoreReactive

Returns:

number of available permits

trySetPermits

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

Description copied from interface: RPermitExpirableSemaphoreReactive

Sets number of permits.

Specified by:

trySetPermits in interface RPermitExpirableSemaphoreReactive

Parameters:

permits - - number of permits

Returns:

true if permits has been set successfully, otherwise false.

addPermits

public org.reactivestreams.Publisher<Void> addPermits(int permits)

Description copied from interface: RPermitExpirableSemaphoreReactive

Increases or decreases the number of available permits by defined value.

Specified by:

addPermits in interface RPermitExpirableSemaphoreReactive

Parameters:

permits - - number of permits to add/remove

Returns:

void

expire

public org.reactivestreams.Publisher<Boolean> expire(long timeToLive,
                                                     TimeUnit timeUnit)

Description copied from interface: RExpirableReactive

Set a timeout for object in mode. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RExpirableReactive

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAt

public org.reactivestreams.Publisher<Boolean> expireAt(long timestamp)

Description copied from interface: RExpirableReactive

Set an expire date for object in mode. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RExpirableReactive

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAt

public org.reactivestreams.Publisher<Boolean> expireAt(Date timestamp)

Description copied from interface: RExpirableReactive

Set an expire date for object in mode. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RExpirableReactive

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

clearExpire

public org.reactivestreams.Publisher<Boolean> clearExpire()

Description copied from interface: RExpirableReactive

Clear an expire timeout or expire date for object in mode. Object will not be deleted.

Specified by:

clearExpire in interface RExpirableReactive

Returns:

true if the timeout was cleared and false if not

remainTimeToLive

public org.reactivestreams.Publisher<Long> remainTimeToLive()

Description copied from interface: RExpirableReactive

Get remaining time to live of object in milliseconds.

Specified by:

remainTimeToLive in interface RExpirableReactive

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

reactive

public <R> org.reactivestreams.Publisher<R> reactive(Supplier<RFuture<R>> supplier)

newSucceeded

protected <V> reactor.core.publisher.Mono<V> newSucceeded(V result)

getName

public String getName()

Specified by:

getName in interface RObjectReactive

getCodec

public Codec getCodec()

Specified by:

getCodec in interface RObjectReactive

encode

protected void encode(Collection<Object> params,
                      Collection<?> values)

encode

protected io.netty.buffer.ByteBuf encode(Object value)

encodeMapKey

protected io.netty.buffer.ByteBuf encodeMapKey(Object value)

encodeMapValue

protected io.netty.buffer.ByteBuf encodeMapValue(Object value)

rename

public org.reactivestreams.Publisher<Void> rename(String newName)

Description copied from interface: RObjectReactive

Rename current object key to newName in mode

Specified by:

rename in interface RObjectReactive

Parameters:

newName - - new name of object

Returns:

void

migrate

public org.reactivestreams.Publisher<Void> migrate(String host,
                                                   int port,
                                                   int database,
                                                   long timeout)

Description copied from interface: RObjectReactive

Transfer a object from a source Redis instance to a destination Redis instance in mode

Specified by:

migrate in interface RObjectReactive

Parameters:

host - - destination host

port - - destination port

database - - destination database

timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds

Returns:

void

move

public org.reactivestreams.Publisher<Boolean> move(int database)

Description copied from interface: RObjectReactive

Move object to another database in mode

Specified by:

move in interface RObjectReactive

Parameters:

database - - number of Redis database

Returns:

true if key was moved false if not

renamenx

public org.reactivestreams.Publisher<Boolean> renamenx(String newName)

Description copied from interface: RObjectReactive

Rename current object key to newName in mode only if new key is not exists

Specified by:

renamenx in interface RObjectReactive

Parameters:

newName - - new name of object

Returns:

true if object has been renamed successfully and false otherwise

delete

public org.reactivestreams.Publisher<Boolean> delete()

Description copied from interface: RObjectReactive

Delete object in mode

Specified by:

delete in interface RObjectReactive

Returns:

true if object was deleted false if not

isExists

public org.reactivestreams.Publisher<Boolean> isExists()

Description copied from interface: RObjectReactive

Check object existence

Specified by:

isExists in interface RObjectReactive

Returns:

true if object exists and false otherwise