Type Alias IReaderSemaphore

IReaderSemaphore: {
    acquireReader(): Task<boolean>;
    acquireReaderBlocking(
        settings?: SharedLockAquireBlockingSettings,
    ): Task<boolean>;
    acquireReaderBlockingOrFail(
        settings?: SharedLockAquireBlockingSettings,
    ): Task<void>;
    acquireReaderOrFail(): Task<void>;
    forceReleaseAllReaders(): Task<boolean>;
    refreshReader(ttl?: ITimeSpan): Task<boolean>;
    refreshReaderOrFail(ttl?: ITimeSpan): Task<void>;
    releaseReader(): Task<boolean>;
    releaseReaderOrFail(): Task<void>;
    runReader<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
    ): Task<Result<TValue, LimitReachedReaderSemaphoreError>>;
    runReaderBlocking<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
        settings?: SharedLockAquireBlockingSettings,
    ): Task<Result<TValue, LimitReachedReaderSemaphoreError>>;
    runReaderBlockingOrFail<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
        settings?: SharedLockAquireBlockingSettings,
    ): Task<TValue>;
    runReaderOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): Task<TValue>;
}

IMPORT_PATH: "@daiso-tech/core/shared-lock/contracts"

Type declaration

acquireReader:function
- acquireReader(): Task<boolean>
- The acquireReader method acquires an slots only if the slot limit is not reached.
  
  Returns Task<boolean>
  Returns true if the slot limit is not reached otherwise false is returned.
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:82
acquireReaderBlocking:function
- acquireReaderBlocking(
  settings?: SharedLockAquireBlockingSettings,
  ): Task<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 Task<boolean>
  Returns true if the slot limit is not reached otherwise false is returned.
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:98
acquireReaderBlockingOrFail:function
- acquireReaderBlockingOrFail(
  settings?: SharedLockAquireBlockingSettings,
  ): Task<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 Task<void>
  Throws
  LimitReachedReaderSemaphoreError
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:109
acquireReaderOrFail:function
- acquireReaderOrFail(): Task<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 Task<void>
  Throws
  LimitReachedReaderSemaphoreError
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:90
forceReleaseAllReaders:function
- forceReleaseAllReaders(): Task<boolean>
- The forceReleaseAllReaders method releases the all slots.
  
  Returns Task<boolean>
  Returns true if the semaphore exists and has at least one unavailable slot or false if all slots are available.
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:132
refreshReader:function
- refreshReader(ttl?: ITimeSpan): Task<boolean>
- The refreshReader method updates the ttl of the slot when acquired.
  Parameters
  - Optionalttl: ITimeSpan
  Returns Task<boolean>
  Returns true if the slot is refreshed otherwise false is returned.
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:139
refreshReaderOrFail:function
- refreshReaderOrFail(ttl?: ITimeSpan): Task<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 Task<void>
  Throws
  FailedRefreshReaderSemaphoreError
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:146
releaseReader:function
- releaseReader(): Task<boolean>
- The releaseReader method releases the current slot.
  
  Returns Task<boolean>
  Returns true if the semaphore exists and has at least one busy slot or false.
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:118
releaseReaderOrFail:function
- releaseReaderOrFail(): Task<void>
- The releaseReaderOrFail method releases the current slot. Throws an error if the slot is not acquired.
  
  Returns Task<void>
  Throws
  FailedReleaseReaderSemaphoreError
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:125
runReader:function
- runReader<TValue = void>(
  asyncFn: AsyncLazy<TValue>,
  ): Task<Result<TValue, LimitReachedReaderSemaphoreError>>
- The runReader method wraps an Invokable or Task with the acquire and release method.
  Type Parameters
  - TValue = void
  Parameters
  - asyncFn: AsyncLazy<TValue>
  Returns Task<Result<TValue, LimitReachedReaderSemaphoreError>>
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:50
runReaderBlocking:function
- runReaderBlocking<TValue = void>(
  asyncFn: AsyncLazy<TValue>,
  settings?: SharedLockAquireBlockingSettings,
  ): Task<Result<TValue, LimitReachedReaderSemaphoreError>>
- The runReaderBlocking method wraps an Invokable or Task with the acquireBlocking and release method.
  Type Parameters
  - TValue = void
  Parameters
  - asyncFn: AsyncLazy<TValue>
  - Optionalsettings: SharedLockAquireBlockingSettings
  Returns Task<Result<TValue, LimitReachedReaderSemaphoreError>>
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:63
runReaderBlockingOrFail:function
- runReaderBlockingOrFail<TValue = void>(
  asyncFn: AsyncLazy<TValue>,
  settings?: SharedLockAquireBlockingSettings,
  ): Task<TValue>
- The runReaderBlockingOrFail method wraps an Invokable or Task with the acquireBlockingOrFail and release method.
  Type Parameters
  - TValue = void
  Parameters
  - asyncFn: AsyncLazy<TValue>
  - Optionalsettings: SharedLockAquireBlockingSettings
  Returns Task<TValue>
  Throws
  LimitReachedReaderSemaphoreError
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:72
runReaderOrFail:function
- runReaderOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): Task<TValue>
- The runReaderOrFail method wraps an Invokable or Task with the acquireOrFail and release method.
  Type Parameters
  - TValue = void
  Parameters
  - asyncFn: AsyncLazy<TValue>
  Returns Task<TValue>
  Throws
  LimitReachedReaderSemaphoreError
  - Defined in src/shared-lock/contracts/shared-lock.contract.ts:58

Type Alias IReaderSemaphore

Type declaration

acquireReader:function

Returns Task<boolean>

acquireReaderBlocking:function

Parameters

Returns Task<boolean>

acquireReaderBlockingOrFail:function

Parameters

Returns Task<void>

Throws

acquireReaderOrFail:function

Returns Task<void>

Throws

forceReleaseAllReaders:function

Returns Task<boolean>

refreshReader:function

Parameters

Returns Task<boolean>

refreshReaderOrFail:function

Parameters

Returns Task<void>

Throws

releaseReader:function

Returns Task<boolean>

releaseReaderOrFail:function

Returns Task<void>

Throws

runReader:function

Type Parameters

Parameters

Returns Task<Result<TValue, LimitReachedReaderSemaphoreError>>

runReaderBlocking:function

Type Parameters

Parameters

Returns Task<Result<TValue, LimitReachedReaderSemaphoreError>>

runReaderBlockingOrFail:function

Type Parameters

Parameters

Returns Task<TValue>

Throws

runReaderOrFail:function

Type Parameters

Parameters

Returns Task<TValue>

Throws

Settings