Class MemorySharedLockAdapter

Note the MemorySharedLockAdapter is limited to single process usage and cannot be shared across multiple servers or different processes. This adapter is meant to be used for testing.

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

Implements

Index

Constructors

constructor

Methods

acquireReader acquireWriter deInit forceRelease forceReleaseAllReaders forceReleaseWriter getState refreshReader refreshWriter releaseReader releaseWriter

Constructors

constructor

new MemorySharedLockAdapter(
map?: Map<string, MemorySharedLockData>,
): MemorySharedLockAdapter

Parameters

map: Map<string, MemorySharedLockData> = ...

Returns MemorySharedLockAdapter

Example

import { MemorySharedLockAdapter } from "@daiso-tech/core/shared-lock/memory-shared-lock-adapter";

const sharedLockAdapter = new MemorySharedLockAdapter();

You can also provide an Map.

Example

import { MemorySharedLockAdapter } from "@daiso-tech/core/shared-lock/memory-shared-lock-adapter";

const map = new Map<any, any>();
const sharedLockAdapter = new MemorySharedLockAdapter(map);

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/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:240

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/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:111

deInit

deInit(): Promise<void>
Returns Promise<void>
Implementation of IDeinitizable.deInit
- Defined in src/shared-lock/implementations/adapters/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:90

forceRelease

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

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/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:328

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/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:180

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/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:403

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/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:349

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/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:202

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/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:293

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/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:156

Class MemorySharedLockAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MemorySharedLockAdapter

Example

Example

Methods

acquireReader

Parameters

Returns Promise<boolean>

acquireWriter

Parameters

Returns Promise<boolean>

deInit

Returns Promise<void>

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