Package org.redisson

Class RedissonPermitExpirableSemaphore

org.redisson.RedissonObject

org.redisson.RedissonPermitExpirableSemaphore

All Implemented Interfaces:

RExpirable, RExpirableAsync, RObject, RObjectAsync, RPermitExpirableSemaphore, RPermitExpirableSemaphoreAsync

public class RedissonPermitExpirableSemaphore
extends RedissonObject
implements RPermitExpirableSemaphore

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, name

Constructor Summary

Constructors

Constructor	Description
RedissonPermitExpirableSemaphore(CommandAsyncExecutor commandExecutor, name)

Method Summary

Modifier and Type	Method	Description
	acquire()	Acquires a permit and returns its id.
	acquire(long leaseTime, timeUnit)	Acquires a permit with defined leaseTime and return its id.
>	acquireAsync()	Acquires a permit and returns its id.
>	acquireAsync(long leaseTime, timeUnit)	Acquires a permit with defined leaseTime and return its id.
void	addPermits(int permits)	Increases or decreases the number of available permits by defined value.
>	addPermitsAsync(int permits)	Increases or decreases the number of available permits by defined value.
int	availablePermits()	Returns amount of available permits.
>	availablePermitsAsync()	Returns amount of available permits.
boolean	clearExpire()	Clear an expire timeout or expire date for object.
>	clearExpireAsync()	Clear an expire timeout or expire date for object in async mode.
protected >	... keys)
>	deleteAsync()	Delete object in async mode
boolean	expire(long timeToLive, timeUnit)	Set a timeout for object.
boolean	instant)	Set an expire date for object.
>	expireAsync(long timeToLive, timeUnit)	Set a timeout for object in async mode.
protected >	expireAsync(long timeToLive, timeUnit, ... keys)
>	instant)	Set an expire date for object.
boolean	expireAt(long timestamp)	Use RExpirable.expire(Instant) instead
boolean	timestamp)	Use RExpirable.expire(Instant) instead
>	expireAtAsync(long timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
protected >	expireAtAsync(long timestamp, ... keys)
>	timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
protected	generateId()
static	name)
void	permitId)	Releases a permit by its id.
>	permitId)	Releases a permit by its id.
long	remainTimeToLive()	Remaining time to live of Redisson object that has a timeout
>	remainTimeToLiveAsync()	Remaining time to live of Redisson object that has a timeout
>	sizeInMemoryAsync()	Returns bytes amount used by object in Redis memory.
	tryAcquire()	Tries to acquire currently available permit and return its id.
	tryAcquire(long waitTime, long ttl, unit)	Tries to acquire currently available permit with defined leaseTime and return its id.
	tryAcquire(long waitTime, unit)	Tries to acquire currently available permit and return its id.
>	tryAcquireAsync()	Tries to acquire currently available permit and return its id.
>	tryAcquireAsync(int permits, long timeoutDate)
>	tryAcquireAsync(long waitTime, long ttl, unit)	Tries to acquire currently available permit with defined leaseTime and return its id.
>	tryAcquireAsync(long waitTime, unit)	Tries to acquire currently available permit and return its id.
boolean	permitId)	Tries to release permit by its id.
>	permitId)	Tries to release permit by its id.
boolean	trySetPermits(int permits)	Tries to set number of permits.
>	trySetPermitsAsync(int permits)	Tries to set number of permits.
boolean	permitId, long leaseTime, unit)	Overrides and updates lease time for defined permit id.
>	permitId, long leaseTime, unit)	Overrides and updates lease time for defined permit id.

Methods inherited from class org.redisson.RedissonObject

addListener, addListener, addListenerAsync, addListenerAsync, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListenerAsync, removeListenersAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync

Methods inherited from class java.lang.

, , , , , , , , , ,

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

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

Methods inherited from interface org.redisson.api.RObjectAsync

addListenerAsync, copyAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, touchAsync, unlinkAsync

Constructor Detail

RedissonPermitExpirableSemaphore

public RedissonPermitExpirableSemaphore(CommandAsyncExecutor commandExecutor,
                                         name)

Method Detail

getChannelName

public static  getChannelName( name)

acquire

public  acquire()
               throws 

Description copied from interface: RPermitExpirableSemaphore

Acquires a permit and returns its id. Waits if necessary until a permit became available.

Specified by:

acquire in interface RPermitExpirableSemaphore

Returns:

permit id

Throws:

- if the current thread is interrupted

acquire

public  acquire(long leaseTime,
                       timeUnit)
               throws 

Description copied from interface: RPermitExpirableSemaphore

Acquires a permit with defined leaseTime and return its id. Waits if necessary until a permit became available.

Specified by:

acquire in interface RPermitExpirableSemaphore

Parameters:

leaseTime - permit lease time

timeUnit - time unit

Returns:

permit id

Throws:

- if the current thread is interrupted

acquireAsync

public > acquireAsync(long leaseTime,
                                     timeUnit)

Description copied from interface: RPermitExpirableSemaphoreAsync

Acquires a permit with defined leaseTime and return its id. Waits if necessary until a permit became available.

Specified by:

acquireAsync in interface RPermitExpirableSemaphoreAsync

Parameters:

leaseTime - permit lease time

timeUnit - time unit

Returns:

permit id

acquireAsync

public > acquireAsync()

Description copied from interface: RPermitExpirableSemaphoreAsync

Acquires a permit and returns its id. Waits if necessary until a permit became available.

Specified by:

acquireAsync in interface RPermitExpirableSemaphoreAsync

Returns:

permit id

tryAcquire

public  tryAcquire()

Description copied from interface: RPermitExpirableSemaphore

Tries to acquire currently available permit and return its id.

Specified by:

tryAcquire in interface RPermitExpirableSemaphore

Returns:

permit id if a permit was acquired and null otherwise

tryAcquireAsync

public > tryAcquireAsync()

Description copied from interface: RPermitExpirableSemaphoreAsync

Tries to acquire currently available permit and return its id.

Specified by:

tryAcquireAsync in interface RPermitExpirableSemaphoreAsync

Returns:

permit id if a permit was acquired and null otherwise

generateId

protected  generateId()

tryAcquireAsync

public > tryAcquireAsync(int permits,
                                       long timeoutDate)

tryAcquireAsync

public > tryAcquireAsync(long waitTime,
                                        unit)

Description copied from interface: RPermitExpirableSemaphoreAsync

Tries to acquire currently available permit and return its id. Waits up to defined waitTime if necessary until a permit became available.

Specified by:

tryAcquireAsync in interface RPermitExpirableSemaphoreAsync

Parameters:

waitTime - the maximum time to wait

unit - the time unit

Returns:

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

tryAcquire

public  tryAcquire(long waitTime,
                         long ttl,
                          unit)
                  throws 

Description copied from interface: RPermitExpirableSemaphore

Tries to acquire currently available permit with defined leaseTime and return its id. Waits up to defined waitTime if necessary until a permit became available.

Specified by:

tryAcquire in interface RPermitExpirableSemaphore

Parameters:

waitTime - the maximum time to wait

ttl - permit lease time, use -1 to make it permanent

unit - the time unit

Returns:

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

Throws:

- if the current thread is interrupted

tryAcquireAsync

public > tryAcquireAsync(long waitTime,
                                       long ttl,
                                        unit)

Description copied from interface: RPermitExpirableSemaphoreAsync

Tries to acquire currently available permit with defined leaseTime and return its id. Waits up to defined waitTime if necessary until a permit became available.

Specified by:

tryAcquireAsync in interface RPermitExpirableSemaphoreAsync

Parameters:

waitTime - the maximum time to wait

ttl - permit lease time, use -1 to make it permanent

unit - the time unit

Returns:

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

tryAcquire

public  tryAcquire(long waitTime,
                          unit)
                  throws 

Description copied from interface: RPermitExpirableSemaphore

Tries to acquire currently available permit and return its id. Waits up to defined waitTime if necessary until a permit became available.

Specified by:

tryAcquire in interface RPermitExpirableSemaphore

Parameters:

waitTime - the maximum time to wait

unit - the time unit

Returns:

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

Throws:

- if the current thread is interrupted

release

public void release( permitId)

Description copied from interface: RPermitExpirableSemaphore

Releases a permit by its id. Increases the number of available permits. Throws an exception if permit id doesn't exist or has already been released.

Specified by:

release in interface RPermitExpirableSemaphore

Parameters:

permitId - - permit id

tryRelease

public boolean tryRelease( permitId)

Description copied from interface: RPermitExpirableSemaphore

Tries to release permit by its id.

Specified by:

tryRelease in interface RPermitExpirableSemaphore

Parameters:

permitId - permit id

Returns:

true if a permit has been released and false otherwise

tryReleaseAsync

public > tryReleaseAsync( permitId)

Description copied from interface: RPermitExpirableSemaphoreAsync

Tries to release permit by its id.

Specified by:

tryReleaseAsync in interface RPermitExpirableSemaphoreAsync

Parameters:

permitId - permit id

Returns:

true if a permit has been released and false otherwise

sizeInMemoryAsync

public > sizeInMemoryAsync()

Description copied from interface: RObjectAsync

Returns bytes amount used by object in Redis memory.

Specified by:

sizeInMemoryAsync in interface RObjectAsync

Overrides:

sizeInMemoryAsync in class RedissonObject

Returns:

size in bytes

deleteAsync

public > deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Overrides:

deleteAsync in class RedissonObject

Returns:

true if object was deleted false if not

expireAsync

public > expireAsync(long timeToLive,
                                     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

expireAtAsync

protected > expireAtAsync(long timestamp,
                                         ... keys)

clearExpireAsync

public > 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

releaseAsync

public > releaseAsync( permitId)

Description copied from interface: RPermitExpirableSemaphoreAsync

Releases a permit by its id. Increases the number of available permits. Throws an exception if permit id doesn't exist or has already been released.

Specified by:

releaseAsync in interface RPermitExpirableSemaphoreAsync

Parameters:

permitId - - permit id

Returns:

void

availablePermits

public int availablePermits()

Description copied from interface: RPermitExpirableSemaphore

Returns amount of available permits.

Specified by:

availablePermits in interface RPermitExpirableSemaphore

Returns:

number of permits

availablePermitsAsync

public > availablePermitsAsync()

Description copied from interface: RPermitExpirableSemaphoreAsync

Returns amount of available permits.

Specified by:

availablePermitsAsync in interface RPermitExpirableSemaphoreAsync

Returns:

number of permits

trySetPermits

public boolean trySetPermits(int permits)

Description copied from interface: RPermitExpirableSemaphore

Tries to set number of permits.

Specified by:

trySetPermits in interface RPermitExpirableSemaphore

Parameters:

permits - - number of permits

Returns:

true if permits has been set successfully, otherwise false.

trySetPermitsAsync

public > trySetPermitsAsync(int permits)

Description copied from interface: RPermitExpirableSemaphoreAsync

Tries to set number of permits.

Specified by:

trySetPermitsAsync in interface RPermitExpirableSemaphoreAsync

Parameters:

permits - - number of permits

Returns:

true if permits has been set successfully, otherwise false.

addPermits

public void addPermits(int permits)

Description copied from interface: RPermitExpirableSemaphore

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

Specified by:

addPermits in interface RPermitExpirableSemaphore

Parameters:

permits - amount of permits to add/remove

addPermitsAsync

public > addPermitsAsync(int permits)

Description copied from interface: RPermitExpirableSemaphoreAsync

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

Specified by:

addPermitsAsync in interface RPermitExpirableSemaphoreAsync

Parameters:

permits - amount of permits to add/remove

Returns:

void

updateLeaseTimeAsync

public > updateLeaseTimeAsync( permitId,
                                             long leaseTime,
                                              unit)

Description copied from interface: RPermitExpirableSemaphoreAsync

Overrides and updates lease time for defined permit id.

Specified by:

updateLeaseTimeAsync in interface RPermitExpirableSemaphoreAsync

Parameters:

permitId - permit id

leaseTime - permit lease time, use -1 to make it permanent

unit - the time unit

Returns:

true if permits has been updated successfully, otherwise false.

updateLeaseTime

public boolean updateLeaseTime( permitId,
                               long leaseTime,
                                unit)

Description copied from interface: RPermitExpirableSemaphore

Overrides and updates lease time for defined permit id.

Specified by:

updateLeaseTime in interface RPermitExpirableSemaphore

Parameters:

permitId - permit id

leaseTime - permit lease time, use -1 to make it permanent

unit - the time unit

Returns:

true if permits has been updated successfully, otherwise false.

expire

public boolean expire(long timeToLive,
                       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

expireAt

public boolean expireAt(long timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

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

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

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

expire

public boolean expire( instant)

Description copied from interface: RExpirable

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

Specified by:

expire in interface RExpirable

Parameters:

instant - - expire date

Returns:

true if the timeout was set and false if not

expireAsync

public > expireAsync( instant)

Description copied from interface: RExpirableAsync

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

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

instant - - expire date

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt( timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public > expireAtAsync( timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

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

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

expireAsync

protected > expireAsync(long timeToLive,
                                        timeUnit,
                                       ... keys)

clearExpireAsync

protected > clearExpireAsync(... keys)