Class EqualReadWriteLocker

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

Hierarchy

EqualReadWriteLocker

Implements

ReadWriteLocker

Index

Constructors

constructor

Properties

locker

Methods

Constructors

constructor

new EqualReadWriteLocker(locker: ResourceLocker): EqualReadWriteLocker

- Defined in src/util/locking/EqualReadWriteLocker.ts:9
Parameters
- locker: ResourceLocker
Returns EqualReadWriteLocker

Properties

Private Readonly locker

locker: ResourceLocker

Methods

Private withLock

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

- Defined in src/util/locking/EqualReadWriteLocker.ts:29
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: () => T | Promise<T>
  
  Function to resolve while the resource is locked.
  - - (): T | Promise<T>
    - Returns T | Promise<T>
Returns Promise<T>

withReadLock

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

- Defined in src/util/locking/EqualReadWriteLocker.ts:15
Type parameters
- T
Parameters
- identifier: ResourceIdentifier
- whileLocked: () => T | Promise<T>
  - - (): T | Promise<T>
    - Returns T | Promise<T>
Returns Promise<T>

withWriteLock

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

- Defined in src/util/locking/EqualReadWriteLocker.ts:19
Type parameters
- T
Parameters
- identifier: ResourceIdentifier
- whileLocked: () => T | Promise<T>
  - - (): T | Promise<T>
    - Returns T | Promise<T>
Returns Promise<T>