Type Alias IReaderSemaphore

Type declaration

• acquireReader:function

  • acquireReader(): ITask<boolean>

  • The acquireReader method acquires an slots only if the slot limit is not reached.

    Returns ITask<boolean>

    Returns true if the slot limit is not reached otherwise false is returned.

• acquireReaderBlocking:function

  • acquireReaderBlocking(
        settings?: SharedLockAquireBlockingSettings,
    ): ITask<boolean>

  • The acquireReaderBlocking method acquires an slots only if the slot limit is not reached. If the slot limit is reached, it retries every settings.interval until settings.time is reached.

    Parameters

    • Optionalsettings: SharedLockAquireBlockingSettings

    Returns ITask<boolean>

    Returns true if the slot limit is not reached otherwise false is returned.

• acquireReaderBlockingOrFail:function

  • acquireReaderBlockingOrFail(
        settings?: SharedLockAquireBlockingSettings,
    ): ITask<void>

  • The acquireReaderBlockingOrFail method acquires an slots only if the slot limit is not reached. If the slot limit is reached, it retries every settings.interval until settings.time is reached. Throws an error if the slot limit is reached after the given settings.time.

    Parameters

    • Optionalsettings: SharedLockAquireBlockingSettings

    Returns ITask<void>

    Throws

    LimitReachedReaderSemaphoreError

• acquireReaderOrFail:function

  • acquireReaderOrFail(): ITask<void>

  • The acquireReaderOrFail method acquires an slots only if the slot limit is not reached. Throws an error if the slot limit is reached.

    Returns ITask<void>

    Throws

    LimitReachedReaderSemaphoreError

• forceReleaseAllReaders:function

  • forceReleaseAllReaders(): ITask<boolean>

  • The forceReleaseAllReaders method releases the all slots.

    Returns ITask<boolean>

    Returns true if the semaphore exists and has at least one unavailable slot or false if all slots are available.

• refreshReader:function

  • refreshReader(ttl?: ITimeSpan): ITask<boolean>

  • The refreshReader method updates the ttl of the slot when acquired.

    Parameters

    • Optionalttl: ITimeSpan

    Returns ITask<boolean>

    Returns true if the slot is refreshed otherwise false is returned.

• refreshReaderOrFail:function

  • refreshReaderOrFail(ttl?: ITimeSpan): ITask<void>

  • The refreshReaderOrFail method updates the ttl of the slot when acquired. Throws an error if the slot is not acquired.

    Parameters

    • Optionalttl: ITimeSpan

    Returns ITask<void>

    Throws

    FailedRefreshReaderSemaphoreError

• releaseReader:function

  • releaseReader(): ITask<boolean>

  • The releaseReader method releases the current slot.

    Returns ITask<boolean>

    Returns true if the semaphore exists and has at least one busy slot or false.

• releaseReaderOrFail:function

  • releaseReaderOrFail(): ITask<void>

  • The releaseReaderOrFail method releases the current slot. Throws an error if the slot is not acquired.

    Returns ITask<void>

    Throws

    FailedReleaseReaderSemaphoreError

• runReaderBlockingOrFail:function

  • runReaderBlockingOrFail<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
        settings?: SharedLockAquireBlockingSettings,
    ): ITask<TValue>

  • The runReaderBlockingOrFail method wraps an Invokable or ITask with the acquireBlockingOrFail and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>
    • Optionalsettings: SharedLockAquireBlockingSettings

    Returns ITask<TValue>

    Throws

    LimitReachedReaderSemaphoreError

• runReaderOrFail:function

  • runReaderOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): ITask<TValue>

  • The runReaderOrFail method wraps an Invokable or ITask with the acquireOrFail and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>

    Returns ITask<TValue>

    Throws

    LimitReachedReaderSemaphoreError