Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WrappedExpiringReadWriteLocker

Wraps around an existing ReadWriteLocker and adds expiration logic to prevent locks from getting stuck.

Hierarchy

  • WrappedExpiringReadWriteLocker

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly expiration

expiration: number

Protected Readonly locker

locker: ReadWriteLocker

Protected Readonly logger

logger: Logger = ...

Methods

Private expiringPromise

  • expiringPromise<T>(identifier: ResourceIdentifier, whileLocked: (maintainLock: () => void) => T | Promise<T>): Promise<T>

  • Creates a Promise that either resolves the given input function or rejects if time runs out, whichever happens first. The input function can reset the timer by calling the maintainLock function it receives. The ResourceIdentifier is only used for logging.

    Type parameters

    • T

    Parameters

    • identifier: ResourceIdentifier
    • whileLocked: (maintainLock: () => void) => T | Promise<T>
        • (maintainLock: () => void): T | Promise<T>

        • Parameters

          • maintainLock: () => void
              • (): void

              • Returns void

          Returns T | Promise<T>

    Returns Promise<T>

withReadLock

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

  • As ReadWriteLocker.withReadLock but the locked function gets called with a maintainLock callback function to reset the lock expiration every time it is called. The resulting promise will reject once the lock expires.

    Type parameters

    • T

    Parameters

    • identifier: ResourceIdentifier
    • whileLocked: (maintainLock: () => void) => T | Promise<T>
        • (maintainLock: () => void): T | Promise<T>

        • Parameters

          • maintainLock: () => void
              • (): void

              • Returns void

          Returns T | Promise<T>

    Returns Promise<T>

withWriteLock

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

  • As ReadWriteLocker.withWriteLock but the locked function gets called with a maintainLock callback function to reset the lock expiration every time it is called. The resulting promise will reject once the lock expires.

    Type parameters

    • T

    Parameters

    • identifier: ResourceIdentifier
    • whileLocked: (maintainLock: () => void) => T | Promise<T>
        • (maintainLock: () => void): T | Promise<T>

        • Parameters

          • maintainLock: () => void
              • (): void

              • Returns void

          Returns T | Promise<T>

    Returns Promise<T>