org.redisson.reactive

Class RedissonSemaphoreReactive

java.lang.Object

org.redisson.reactive.RedissonSemaphoreReactive

All Implemented Interfaces:

RExpirableReactive, RObjectReactive, RSemaphoreReactive

public class RedissonSemaphoreReactive
extends Object
implements RSemaphoreReactive

Author:

Nikita Koksharov

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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<Boolean>	clearExpire() Clear an expire timeout or expire date for object in mode.
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>	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<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<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 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

RedissonSemaphoreReactive

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

Method Detail

tryAcquire

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

Description copied from interface: RSemaphoreReactive

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.

Specified by:

tryAcquire in interface RSemaphoreReactive

Returns:

true if a permit was acquired and false otherwise

tryAcquire

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

Description copied from interface: RSemaphoreReactive

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.

Specified by:

tryAcquire in interface RSemaphoreReactive

Parameters:

permits - the number of permits to acquire

Returns:

true if a permit was acquired and false otherwise

acquire

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

Description copied from interface: RSemaphoreReactive

Acquires a permit from this semaphore.

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

Specified by:

acquire in interface RSemaphoreReactive

Returns:

void

acquire

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

Description copied from interface: RSemaphoreReactive

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

Specified by:

acquire in interface RSemaphoreReactive

Parameters:

permits - the number of permits to acquire

Returns:

void

release

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

Description copied from interface: RSemaphoreReactive

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 RSemaphoreReactive.acquire(). Correct usage of a semaphore is established by programming convention in the application.

Specified by:

release in interface RSemaphoreReactive

Returns:

void

release

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

Description copied from interface: RSemaphoreReactive

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 RSemaphoreReactive.acquire(). Correct usage of a semaphore is established by programming convention in the application.

Specified by:

release in interface RSemaphoreReactive

Parameters:

permits - amount

Returns:

void

trySetPermits

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

Description copied from interface: RSemaphoreReactive

Sets number of permits.

Specified by:

trySetPermits in interface RSemaphoreReactive

Parameters:

permits - - number of permits

Returns:

true if permits has been set successfully, otherwise false.

tryAcquire

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

Description copied from interface: RSemaphoreReactive

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.

Specified by:

tryAcquire in interface RSemaphoreReactive

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

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

Description copied from interface: RSemaphoreReactive

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.

Specified by:

tryAcquire in interface RSemaphoreReactive

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

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

Description copied from interface: RSemaphoreReactive

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 RSemaphoreReactive.acquire() in that it does not block waiting for permits to become available.

Specified by:

reducePermits in interface RSemaphoreReactive

Parameters:

permits - - reduction the number of permits to 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