Class EqualReadWriteLocker

A ReadWriteLocker that gives no priority to read or write operations: both use the same lock.

Hierarchy (view full)

EqualReadWriteLocker
- BaseReadWriteLocker

Implements

ReadWriteLocker

Index

Constructors

Properties

Methods

withLock withReadLock withWriteLock

Constructors

constructor

new EqualReadWriteLocker(locker): EqualReadWriteLocker
Parameters
- locker: ResourceLocker
Returns EqualReadWriteLocker
- Defined in src/util/locking/EqualReadWriteLocker.ts:12

Properties

`Protected` `Readonly`locker

locker: ResourceLocker

Methods

`Protected`withLock

withLock<T>(identifier, whileLocked): Promise<T>
Acquires a new lock for the requested identifier. Will resolve when the input function resolves.
Type Parameters
- T
Parameters
- identifier: ResourceIdentifier
  Identifier of resource that needs to be locked.
- whileLocked: (() => PromiseOrValue<T>)
  Function to resolve while the resource is locked.
  - - (): PromiseOrValue<T>
    - Returns PromiseOrValue<T>
Returns Promise<T>
- Defined in src/util/locking/EqualReadWriteLocker.ts:31

withReadLock

withReadLock<T>(identifier, whileLocked): Promise<T>
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: (() => PromiseOrValue<T>)
  A function to execute while the resource is locked.
  - - (): PromiseOrValue<T>
    - Returns PromiseOrValue<T>
Returns Promise<T>
A promise resolving when the lock is released.
Implementation of ReadWriteLocker.withReadLock
- Defined in src/util/locking/EqualReadWriteLocker.ts:16

withWriteLock

withWriteLock<T>(identifier, whileLocked): Promise<T>
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: (() => PromiseOrValue<T>)
  A function to execute while the resource is locked.
  - - (): PromiseOrValue<T>
    - Returns PromiseOrValue<T>
Returns Promise<T>
A promise resolving when the lock is released.
Implementation of ReadWriteLocker.withWriteLock
- Defined in src/util/locking/EqualReadWriteLocker.ts:20