Package org.redisson.api

Interface RPermitExpirableSemaphoreAsync

All Superinterfaces:

RExpirableAsync, RObjectAsync

All Known Subinterfaces:

RPermitExpirableSemaphore

All Known Implementing Classes:

RedissonPermitExpirableSemaphore

public interface RPermitExpirableSemaphoreAsync
extends RExpirableAsync

Asynchronous interface for Semaphore object with lease time parameter support for each acquired permit.

Each permit identified by own id and could be released only using its id. Permit id is a 128-bits unique random identifier generated each time during acquiring.

Works in non-fair mode. Therefore order of acquiring is unpredictable.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
>	acquireAsync()	Acquires a permit and returns its id.
>	acquireAsync(long leaseTime, unit)	Acquires a permit with defined leaseTime and return its id.
>	addPermitsAsync(int permits)	Increases or decreases the number of available permits by defined value.
>	availablePermitsAsync()	Returns amount of available permits.
>	permitId)	Releases a permit by its id.
>	tryAcquireAsync()	Tries to acquire currently available permit and return its id.
>	tryAcquireAsync(long waitTime, long leaseTime, 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.
>	permitId)	Tries to release permit by its id.
>	trySetPermitsAsync(int permits)	Tries to set number of permits.
>	permitId, long leaseTime, unit)	Overrides and updates lease time for defined permit id.

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

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

Method Detail

acquireAsync

> acquireAsync()

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

Returns:

permit id

acquireAsync

> acquireAsync(long leaseTime,
                              unit)

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

Parameters:

leaseTime - permit lease time

unit - time unit

Returns:

permit id

tryAcquireAsync

> tryAcquireAsync()

Tries to acquire currently available permit and return its id.

Returns:

permit id if a permit was acquired and null otherwise

tryAcquireAsync

> tryAcquireAsync(long waitTime,
                                 unit)

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

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

tryAcquireAsync

> tryAcquireAsync(long waitTime,
                                long leaseTime,
                                 unit)

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.

Parameters:

waitTime - the maximum time to wait

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

tryReleaseAsync

> tryReleaseAsync( permitId)

Tries to release permit by its id.

Parameters:

permitId - permit id

Returns:

true if a permit has been released and false otherwise

releaseAsync

> releaseAsync( permitId)

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.

Parameters:

permitId - - permit id

Returns:

void

availablePermitsAsync

> availablePermitsAsync()

Returns amount of available permits.

Returns:

number of permits

trySetPermitsAsync

> trySetPermitsAsync(int permits)

Tries to set number of permits.

Parameters:

permits - - number of permits

Returns:

true if permits has been set successfully, otherwise false.

addPermitsAsync

> addPermitsAsync(int permits)

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

Parameters:

permits - amount of permits to add/remove

Returns:

void

updateLeaseTimeAsync

> updateLeaseTimeAsync( permitId,
                                      long leaseTime,
                                       unit)

Overrides and updates lease time for defined permit id.

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.