Type Alias IWriterLock

Type declaration

• acquireWriter:function

  • acquireWriter(): Task<boolean>

  • The acquireWriter method acquires a lock only if the key is not already acquired by different owner.

    Returns Task<boolean>

    Returns true if the lock is not already acquired otherwise false is returned.

• acquireWriterBlocking:function

  • acquireWriterBlocking(
        settings?: SharedLockAquireBlockingSettings,
    ): Task<boolean>

  • The acquireWriterBlocking method acquires a lock only if the key is not already acquired by different owner. If the lock is not acquired, it retries every settings.interval until settings.time is reached.

    Parameters

    • Optionalsettings: SharedLockAquireBlockingSettings

    Returns Task<boolean>

    Returns true if the lock is not already acquired otherwise false is returned.

• acquireWriterBlockingOrFail:function

  • acquireWriterBlockingOrFail(
        settings?: SharedLockAquireBlockingSettings,
    ): Task<void>

  • The acquireWriterBlockingOrFail method acquires a lock only if the key is not already acquired by different owner. If the lock is not acquired, it retries every settings.interval until settings.time is reached. Throws an error if the lock is already acquired by different owner.

    Parameters

    • Optionalsettings: SharedLockAquireBlockingSettings

    Returns Task<void>

    Throws

    FailedAcquireWriterLockError

• acquireWriterOrFail:function

  • acquireWriterOrFail(): Task<void>

  • The acquireWriterOrFail method acquires a lock only if the key is not already acquired by different owner. Throws an error if the lock is already acquired by different owner.

    Returns Task<void>

    Throws

    FailedAcquireWriterLockError

• forceReleaseWriter:function

  • forceReleaseWriter(): Task<boolean>

  • The forceReleaseWriter method releases a lock regardless of the owner.

    Returns Task<boolean>

    Returns true if the lock exists or false if the lock doesnt exists.

• refreshWriter:function

  • refreshWriter(ttl?: ITimeSpan): Task<boolean>

  • The refreshWriter method updates the ttl of the lock if expireable and owned by the same owner.

    Parameters

    • Optionalttl: ITimeSpan

    Returns Task<boolean>

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

• refreshWriterOrFail:function

  • refreshWriterOrFail(ttl?: ITimeSpan): Task<void>

  • The refreshWriterOrFail method updates the ttl of the lock if expireable and owned by the same owner. Throws an error if the lock is not owned by same owner. Throws an error if the key is unexpirable.

    Parameters

    • Optionalttl: ITimeSpan

    Returns Task<void>

    Throws

    FailedRefreshWriterLockError

• releaseWriter:function

  • releaseWriter(): Task<boolean>

  • The releaseWriter method releases a lock if owned by the same owner.

    Returns Task<boolean>

    Returns true if the lock is released otherwise false is returned.

• releaseWriterOrFail:function

  • releaseWriterOrFail(): Task<void>

  • The releaseWriterOrFail method releases a lock if owned by the same owner. Throws an error if the lock is not owned by same owner.

    Returns Task<void>

    Throws

    FailedReleaseWriterLockError

• runWriter:function

  • runWriter<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
    ): Task<Result<TValue, FailedAcquireWriterLockError>>

  • The runWriter method wraps an Invokable or Task with the acquire and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>

    Returns Task<Result<TValue, FailedAcquireWriterLockError>>

• runWriterBlocking:function

  • runWriterBlocking<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
        settings?: SharedLockAquireBlockingSettings,
    ): Task<Result<TValue, FailedAcquireWriterLockError>>

  • The runWriterBlocking 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, FailedAcquireWriterLockError>>

• runWriterBlockingOrFail:function

  • runWriterBlockingOrFail<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
        settings?: SharedLockAquireBlockingSettings,
    ): Task<TValue>

  • The runWriterBlockingOrFail 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

    FailedAcquireWriterLockError

• runWriterOrFail:function

  • runWriterOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): Task<TValue>

  • The runWriterOrFail method wraps an Invokable or Task with the acquireOrFail and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>

    Returns Task<TValue>

    Throws

    FailedAcquireWriterLockError