Class MemoryLockAdapter

Note the MemoryLockAdapter 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/lock/adapters"

Implements

ILockAdapter

Index

Constructors

constructor

Methods

acquire forceRelease refresh release

Constructors

constructor

new MemoryLockAdapter(map?: Map<string, ILockData>): MemoryLockAdapter

Parameters

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

Returns MemoryLockAdapter

Example

import { MemoryLockAdapter } from "@daiso-tech/core/lock/adapters";

const lockAdapter = new MemoryLockAdapter();

You can also provide an Map.

Example

import { MemoryLockAdapter } from "@daiso-tech/core/lock/adapters";

const map = new Map<any, any>();
const lockAdapter = new MemoryLockAdapter(map);

Methods

acquire

acquire(key: string, owner: string, ttl: null | TimeSpan): Promise<boolean>
The acquire method acquires a lock only if the lock is not already acquired. Returns true if not already acquired othewise false is returned.
Parameters
- key: string
- owner: string
- ttl: null | TimeSpan
Returns Promise<boolean>
Implementation of ILockAdapter.acquire
- Defined in src/lock/implementations/adapters/memory-lock-adapter/memory-lock-adapter.ts:43

forceRelease

forceRelease(key: string): Promise<void>
The forceRelease method releases a lock regardless of the owner.
Parameters
- key: string
Returns Promise<void>
Implementation of ILockAdapter.forceRelease
- Defined in src/lock/implementations/adapters/memory-lock-adapter/memory-lock-adapter.ts:83

refresh

refresh(key: string, owner: string, time: TimeSpan): Promise<boolean>
The refresh method will upadte ttl of lock if it matches the given key and matches the given owner. Returns true if the update occured otherwise false is returned.
Parameters
- key: string
- owner: string
- time: TimeSpan
Returns Promise<boolean>
Implementation of ILockAdapter.refresh
- Defined in src/lock/implementations/adapters/memory-lock-adapter/memory-lock-adapter.ts:90

release

release(key: string, owner: string): Promise<boolean>
The release method releases a lock if the owner matches. Returns true if released otherwise false is returned.
Parameters
- key: string
- owner: string
Returns Promise<boolean>
Implementation of ILockAdapter.release
- Defined in src/lock/implementations/adapters/memory-lock-adapter/memory-lock-adapter.ts:68

Class MemoryLockAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MemoryLockAdapter

Example

Example

Methods

acquire

Parameters

Returns Promise<boolean>

forceRelease

Parameters

Returns Promise<void>

refresh

Parameters

Returns Promise<boolean>

release

Parameters

Returns Promise<boolean>

Settings

On This Page