Package org.redisson

Class RedissonQueueSemaphore

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonSemaphore

org.redisson.RedissonQueueSemaphore

All Implemented Interfaces:

RExpirable, RExpirableAsync, RObject, RObjectAsync, RSemaphore, RSemaphoreAsync

public class RedissonQueueSemaphore
extends RedissonSemaphore

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec

Constructor Summary

Constructors

Constructor	Description
RedissonQueueSemaphore(CommandExecutor commandExecutor, String name, SemaphorePubSub semaphorePubSub)

Method Summary

Modifier and Type	Method	Description
boolean	clearExpire()	Clear an expire timeout or expire date for object.
RFuture<Boolean>	clearExpireAsync()	Clear an expire timeout or expire date for object in async mode.
boolean	expire(long timeToLive, TimeUnit timeUnit)	Set a timeout for object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit)	Set a timeout for object in async mode.
boolean	expireAt(long timestamp)	Set an expire date for object.
boolean	expireAt(Date timestamp)	Set an expire date for object.
RFuture<Boolean>	expireAtAsync(long timestamp)	Set an expire date for object in async mode.
RFuture<Boolean>	expireAtAsync(Date timestamp)	Set an expire date for object in async mode.
long	remainTimeToLive()	Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync()	Remaining time to live of Redisson object that has a timeout
void	setQueueName(String queueName)
void	setValue(Object value)
void	setValues(Collection<?> values)
RFuture<Boolean>	tryAcquireAsync(int permits)	Acquires the given number of permits only if all are available at the time of invocation.

Methods inherited from class org.redisson.RedissonSemaphore

acquire, acquire, acquireAsync, acquireAsync, availablePermits, drainPermits, getChannelName, reducePermits, reducePermitsAsync, release, release, releaseAsync, releaseAsync, tryAcquire, tryAcquire, tryAcquire, tryAcquire, tryAcquireAsync, tryAcquireAsync, tryAcquireAsync, trySetPermits, trySetPermitsAsync

Methods inherited from class org.redisson.RedissonObject

await, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getName, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, touch, touchAsync, unlink, unlinkAsync

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.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

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

Methods inherited from interface org.redisson.api.RObjectAsync

copyAsync, deleteAsync, dumpAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Constructor Detail

RedissonQueueSemaphore

public RedissonQueueSemaphore(CommandExecutor commandExecutor,
                              String name,
                              SemaphorePubSub semaphorePubSub)

Method Detail

setQueueName

public void setQueueName(String queueName)

setValues

public void setValues(Collection<?> values)

setValue

public void setValue(Object value)

tryAcquireAsync

public RFuture<Boolean> tryAcquireAsync(int permits)

Description copied from interface: RSemaphoreAsync

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 permitss.

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

Specified by:

tryAcquireAsync in interface RSemaphoreAsync

Overrides:

tryAcquireAsync in class RedissonSemaphore

Parameters:

permits - the number of permits to acquire

Returns:

true if a permit was acquired and false otherwise

expire

public boolean expire(long timeToLive,
                      TimeUnit timeUnit)

Description copied from interface: RExpirable

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

Specified by:

expire in interface RExpirable

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(long timeToLive,
                                    TimeUnit timeUnit)

Description copied from interface: RExpirableAsync

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

Specified by:

expireAsync in interface RExpirableAsync

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 boolean expireAt(long timestamp)

Description copied from interface: RExpirable

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

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(long timestamp)

Description copied from interface: RExpirableAsync

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

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

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

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(Date timestamp)

Description copied from interface: RExpirableAsync

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

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

clearExpire

public boolean clearExpire()

Description copied from interface: RExpirable

Clear an expire timeout or expire date for object.

Specified by:

clearExpire in interface RExpirable

Returns:

true if timeout was removed false if object does not exist or does not have an associated timeout

clearExpireAsync

public RFuture<Boolean> clearExpireAsync()

Description copied from interface: RExpirableAsync

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

Specified by:

clearExpireAsync in interface RExpirableAsync

Returns:

true if the timeout was cleared and false if not

remainTimeToLive

public long remainTimeToLive()

Description copied from interface: RExpirable

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLive in interface RExpirable

Returns:

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

remainTimeToLiveAsync

public RFuture<Long> remainTimeToLiveAsync()

Description copied from interface: RExpirableAsync

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

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