Class RedisSharedLockAdapter

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

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

IMPORT_PATH: "@daiso-tech/core/shared-lock/redis-shared-lock-adapter"

Implements

ISharedLockAdapter

Index

Constructors

constructor

Methods

acquireReader acquireWriter forceRelease forceReleaseAllReaders forceReleaseWriter getState refreshReader refreshWriter releaseReader releaseWriter

Constructors

constructor

new RedisSharedLockAdapter(database: Redis): RedisSharedLockAdapter

Parameters

database: Redis

Returns RedisSharedLockAdapter

Example

import { RedisSharedLockAdapter } from "@daiso-tech/core/shared-lock/redis-shared-lock-adapter";
import Redis from "ioredis";

const database = new Redis("YOUR_REDIS_CONNECTION_STRING");
const sharedLockAdapter = new RedisSharedLockAdapter(database);

Methods

acquireReader

acquireReader(settings: SharedLockAcquireSettings): Promise<boolean>
The acquireReader method acquires a slot only if the slot limit is not reached.
Parameters
- settings: SharedLockAcquireSettings
Returns Promise<boolean>
Returns true if the slot limit is not reached otherwise false is returned.
Implementation of ISharedLockAdapter.acquireReader
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:761

acquireWriter

acquireWriter(
    key: string,
    lockId: string,
    ttl: null | TimeSpan,
): Promise<boolean>
The acquireWriter method acquires a lock only if expired.
Parameters
- key: string
- lockId: string
- ttl: null | TimeSpan
Returns Promise<boolean>
Returns true if expired otherwise false is returned.
Implementation of ISharedLockAdapter.acquireWriter
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:721

forceRelease

forceRelease(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>
Implementation of ISharedLockAdapter.forceRelease
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:805

forceReleaseAllReaders

forceReleaseAllReaders(key: string): Promise<boolean>
The forceReleaseAllReaders method releases all slots related to the key.
Parameters
- key: string
Returns Promise<boolean>
Implementation of ISharedLockAdapter.forceReleaseAllReaders
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:796

forceReleaseWriter

forceReleaseWriter(key: string): Promise<boolean>
The forceReleaseWriter method releases a lock regardless of the owner.
Parameters
- key: string
Returns Promise<boolean>
Returns true if the lock exists or false if the lock is expired.
Implementation of ISharedLockAdapter.forceReleaseWriter
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:755

getState

getState(key: string): Promise<null | ISharedLockAdapterState>
Parameters
- key: string
Returns Promise<null | ISharedLockAdapterState>
Implementation of ISharedLockAdapter.getState
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:813

refreshReader

refreshReader(key: string, lockId: string, ttl: TimeSpan): Promise<boolean>
The refreshReader method expiration of slot if not already expired.
Parameters
- key: string
- lockId: string
- ttl: TimeSpan
Returns Promise<boolean>
Returns true if the slot is refreshed* otherwise false is returned.
Implementation of ISharedLockAdapter.refreshReader
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:782

refreshWriter

refreshWriter(key: string, lockId: string, ttl: TimeSpan): Promise<boolean>
The refreshWriter method will upadte ttl of lock if it matches the owner and is expireable.
Parameters
- key: string
- lockId: string
- ttl: TimeSpan
Returns Promise<boolean>
Returns false if the lock is unexpireable, the is expired, does not match the owner otherwise true is returned.
Implementation of ISharedLockAdapter.refreshWriter
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:742

releaseReader

releaseReader(key: string, lockId: string): Promise<boolean>
The releaseReader method releases given slot related to the key.
Parameters
- key: string
- lockId: 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 ISharedLockAdapter.releaseReader
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:773

releaseWriter

releaseWriter(key: string, lockId: string): Promise<boolean>
The releaseWriter method releases a lock if the owner matches.
Parameters
- key: string
- lockId: string
Returns Promise<boolean>
Returns true if released otherwise false is returned.
Implementation of ISharedLockAdapter.releaseWriter
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:734

Class RedisSharedLockAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RedisSharedLockAdapter

Example

Methods

acquireReader

Parameters

Returns Promise<boolean>

acquireWriter

Parameters

Returns Promise<boolean>

forceRelease

Parameters

Returns Promise<boolean>

forceReleaseAllReaders

Parameters

Returns Promise<boolean>

forceReleaseWriter

Parameters

Returns Promise<boolean>

getState

Parameters

Returns Promise<null | ISharedLockAdapterState>

refreshReader

Parameters

Returns Promise<boolean>

refreshWriter

Parameters

Returns Promise<boolean>

releaseReader

Parameters

Returns Promise<boolean>

releaseWriter

Parameters

Returns Promise<boolean>

Settings

On This Page