Interface ReadWriteLocker

Allows the locking of resources which is needed for non-atomic ResourceStores.

Hierarchy

ReadWriteLocker
- ExpiringReadWriteLocker

Implemented by

Index

Methods

Methods

withReadLock

withReadLock<T>(identifier: ResourceIdentifier, whileLocked: () => T | Promise<T>): Promise<T>

- Defined in src/util/locking/ReadWriteLocker.ts:17
Run the given function while the resource is locked. The lock will be released when the (async) input function resolves. This function should be used for operations that only require reading the resource.

Type parameters
- T
Parameters
- identifier: ResourceIdentifier
  Identifier of the resource that needs to be locked.
- whileLocked: () => T | Promise<T>
  A function to execute while the resource is locked.
  - - (): T | Promise<T>
    - Returns T | Promise<T>
Returns Promise<T>
A promise resolving when the lock is released.

withWriteLock

withWriteLock<T>(identifier: ResourceIdentifier, whileLocked: () => T | Promise<T>): Promise<T>

- Defined in src/util/locking/ReadWriteLocker.ts:29
Run the given function while the resource is locked. The lock will be released when the (async) input function resolves. This function should be used for operations that could modify the resource.

Type parameters
- T
Parameters
- identifier: ResourceIdentifier
  Identifier of the resource that needs to be locked.
- whileLocked: () => T | Promise<T>
  A function to execute while the resource is locked.
  - - (): T | Promise<T>
    - Returns T | Promise<T>
Returns Promise<T>
A promise resolving when the lock is released.