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 for easily fakingISharedLockFactory 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>
Attempts to acquire a reader slot in the shared lock. Succeeds only if no non-expired writer lock is held and the current number of acquired reader slots has not reached the limit.
Parameters
- settings: SharedLockAcquireSettings
  Settings containing the context, key, lockId, limit, and ttl for the acquisition
Returns Promise<boolean>
Promise resolving to true if the reader slot was successfully acquired, false if the slot limit has been reached
Implementation of ISharedLockAdapter.acquireReader
- Defined in src/shared-lock/implementations/adapters/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:270

acquireWriter

acquireWriter(
    key: string,
    lockId: string,
    ttl: null | TimeSpan,
    _context: IReadableContext,
): Promise<boolean>
Attempts to acquire a writer lock for the specified key. Succeeds only if no non-expired writer lock exists and no non-expired reader slots are held.
Parameters
- key: string
  Unique identifier for the shared lock
- lockId: string
  Unique identifier for this acquirer (becomes the owner)
- ttl: null | TimeSpan
  Time-to-live duration or null for indefinite locks
- _context: IReadableContext
Returns Promise<boolean>
Promise resolving to true if the writer lock was successfully acquired, false if already held by another owner
Implementation of ISharedLockAdapter.acquireWriter
- Defined in src/shared-lock/implementations/adapters/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:117

deInit

deInit(): Promise<void>
Removes all in-memory shared-lock data.

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

forceRelease

forceRelease(key: string, context: IReadableContext): Promise<boolean>
Forcibly releases both the writer lock and all reader slots regardless of ownership. Used for complete emergency cleanup of the shared lock.
Parameters
- key: string
  Unique identifier for the shared lock
- context: IReadableContext
  Readable execution context for the operation
Returns Promise<boolean>
Promise resolving to true if the shared lock existed and was fully released, false if the shared lock doesn't exist
Implementation of ISharedLockAdapter.forceRelease
- Defined in src/shared-lock/implementations/adapters/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:447

forceReleaseAllReaders

forceReleaseAllReaders(key: string, context: IReadableContext): Promise<boolean>
Forcibly releases all reader slots for the specified shared lock regardless of ownership. Used for emergency cleanup or administrative operations. Bypasses ownership verification for situations where individual slot holders are unavailable.
Parameters
- key: string
  Unique identifier for the shared lock
- context: IReadableContext
  Readable execution context for the operation
Returns Promise<boolean>
Promise resolving to true if reader slots existed and were released, false if no reader slots are acquired
Implementation of ISharedLockAdapter.forceReleaseAllReaders
- Defined in src/shared-lock/implementations/adapters/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:391

forceReleaseWriter

forceReleaseWriter(key: string, context: IReadableContext): Promise<boolean>
Forcibly releases a writer lock regardless of ownership. Used for emergency lock release or administrative cleanup. Bypasses ownership verification for situations where the owner is unavailable.
Parameters
- key: string
  Unique identifier for the shared lock
- context: IReadableContext
  Readable execution context for the operation
Returns Promise<boolean>
Promise resolving to true if the writer lock existed and was released, false if the lock is already expired
Implementation of ISharedLockAdapter.forceReleaseWriter
- Defined in src/shared-lock/implementations/adapters/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:221

getState

getState(
key: string,
_context: IReadableContext,
): Promise<null | ISharedLockAdapterState>
Retrieves the current state of a shared lock.
Parameters
- key: string
  Unique identifier for the shared lock
- _context: IReadableContext
Returns Promise<null | ISharedLockAdapterState>
Promise resolving to the non-expired shared lock state if it exists; otherwise null for missing or expired shared locks
Implementation of ISharedLockAdapter.getState
- Defined in src/shared-lock/implementations/adapters/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:551

refreshReader

refreshReader(
    key: string,
    lockId: string,
    ttl: TimeSpan,
    _context: IReadableContext,
): Promise<boolean>
Refreshes (extends) the time-to-live of an existing reader slot. Only succeeds if all conditions are met: the slot exists, hasn't expired, and is expirable.
Parameters
- key: string
  Unique identifier for the shared lock
- lockId: string
- ttl: TimeSpan
  New time-to-live duration to set
- _context: IReadableContext
Returns Promise<boolean>
Promise resolving to true if refresh succeeded, false if the slot is unexpirable, expired, or doesn't exist
Implementation of ISharedLockAdapter.refreshReader
- Defined in src/shared-lock/implementations/adapters/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:398

refreshWriter

refreshWriter(
    key: string,
    lockId: string,
    ttl: TimeSpan,
    _context: IReadableContext,
): Promise<boolean>
Refreshes (extends) the time-to-live of an existing writer lock. Only succeeds if all conditions are met: ownership matches, lock hasn't expired, and it's expirable.
Parameters
- key: string
  Unique identifier for the shared lock
- lockId: string
  Unique identifier of the lock owner
- ttl: TimeSpan
  New time-to-live duration to set
- _context: IReadableContext
Returns Promise<boolean>
Promise resolving to true if refresh succeeded, false if the lock is unexpirable, expired, or not owned by lockId
Implementation of ISharedLockAdapter.refreshWriter
- Defined in src/shared-lock/implementations/adapters/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:228

releaseReader

releaseReader(
    key: string,
    lockId: string,
    _context: IReadableContext,
): Promise<boolean>
Releases a specific reader slot if it is currently acquired. Only the holder of the slot (identified by slotId) can release it.
Parameters
- key: string
  Unique identifier for the shared lock
- lockId: string
- _context: IReadableContext
Returns Promise<boolean>
Promise resolving to true if the reader slot was successfully released, false if the slot doesn't exist or is already released
Implementation of ISharedLockAdapter.releaseReader
- Defined in src/shared-lock/implementations/adapters/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:322

releaseWriter

releaseWriter(
    key: string,
    lockId: string,
    _context: IReadableContext,
): Promise<boolean>
Releases a writer lock if owned by the specified lockId. Ownership verification prevents accidental release of locks held by others.
Parameters
- key: string
  Unique identifier for the shared lock
- lockId: string
  Unique identifier of the lock owner
- _context: IReadableContext
Returns Promise<boolean>
Promise resolving to true if the writer lock was successfully released, false if not owned by lockId or doesn't exist
Implementation of ISharedLockAdapter.releaseWriter
- Defined in src/shared-lock/implementations/adapters/memory-shared-lock-adapter/memory-shared-lock-adapter.ts:162

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