Class RedisSemaphoreAdapter

To utilize the RedisSemaphoreAdapter, you must install the "ioredis" package.

Note in order to use RedisSemaphoreAdapter correctly, ensure you use a single, consistent database across all server instances.

IMPORT_PATH: "@daiso-tech/core/semaphore/adapters"

Implements

ISemaphoreAdapter

Index

Constructors

constructor

Methods

acquire forceReleaseAll getState refresh release

Constructors

constructor

new RedisSemaphoreAdapter(database: Redis): RedisSemaphoreAdapter
Parameters
- database: Redis
Returns RedisSemaphoreAdapter
- Defined in src/semaphore/implementations/adapters/redis-semaphore-adapter/redis-semaphore-adapter.ts:70

Methods

acquire

acquire(settings: SemaphoreAcquireSettings): Promise<boolean>
The acquire method acquires a slot only if the slot limit is not reached.
Parameters
- settings: SemaphoreAcquireSettings
Returns Promise<boolean>
Returns true if the slot limit is not reached otherwise false is returned.
Implementation of ISemaphoreAdapter.acquire
- Defined in src/semaphore/implementations/adapters/redis-semaphore-adapter/redis-semaphore-adapter.ts:388

forceReleaseAll

forceReleaseAll(key: string): Promise<boolean>
The forceReleaseAll method releases all slots related to the key.
Parameters
- key: string
Returns Promise<boolean>
Implementation of ISemaphoreAdapter.forceReleaseAll
- Defined in src/semaphore/implementations/adapters/redis-semaphore-adapter/redis-semaphore-adapter.ts:409

getState

getState(key: string): Promise<null | ISemaphoreAdapterState>
The getState method returns the state of the semaphore.
Parameters
- key: string
Returns Promise<null | ISemaphoreAdapterState>
Returns ISemaphoreAdapterState if the semaphore exists in the database or null if doesnt exists.
Implementation of ISemaphoreAdapter.getState
- Defined in src/semaphore/implementations/adapters/redis-semaphore-adapter/redis-semaphore-adapter.ts:432

refresh

refresh(key: string, slotId: string, ttl: TimeSpan): Promise<boolean>
The refresh method expiration of slot if not already expired.
Parameters
- key: string
- slotId: string
- ttl: TimeSpan
Returns Promise<boolean>
Returns true if the slot is refreshed* otherwise false is returned.
Implementation of ISemaphoreAdapter.refresh
- Defined in src/semaphore/implementations/adapters/redis-semaphore-adapter/redis-semaphore-adapter.ts:418

release

release(key: string, slotId: string): Promise<boolean>
The release method releases given slot related to the key.
Parameters
- key: string
- slotId: string
Returns Promise<boolean>
Returns true if the semaphore exists and has at least one unavailable slot or false if all slots are available.
Implementation of ISemaphoreAdapter.release
- Defined in src/semaphore/implementations/adapters/redis-semaphore-adapter/redis-semaphore-adapter.ts:400

Class RedisSemaphoreAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RedisSemaphoreAdapter

Methods

acquire

Parameters

Returns Promise<boolean>

forceReleaseAll

Parameters

Returns Promise<boolean>

getState

Parameters

Returns Promise<null | ISemaphoreAdapterState>

refresh

Parameters

Returns Promise<boolean>

release

Parameters

Returns Promise<boolean>

Settings

On This Page