Interface Lock

interface Lock {
    durationSeconds: number;
    k8Factory: K8Factory;
    leaseName: string;
    lockHolder: LockHolder;
    namespace: NamespaceName;
    renewalService: LockRenewalService;
    scheduleId: number;
    acquire(): Promise<void>;
    isAcquired(): Promise<boolean>;
    isExpired(): Promise<boolean>;
    release(): Promise<void>;
    renew(): Promise<void>;
    tryAcquire(): Promise<boolean>;
    tryRelease(): Promise<boolean>;
    tryRenew(): Promise<boolean>;
}

Implemented by

IntervalLock

Index

Properties

durationSeconds k8Factory leaseName lockHolder namespace renewalService scheduleId

Methods

acquire isAcquired isExpired release renew tryAcquire tryRelease tryRenew

Properties

`Readonly`durationSeconds

durationSeconds: number

`Readonly`k8Factory

k8Factory: K8Factory

`Readonly`leaseName

leaseName: string

`Readonly`lockHolder

lockHolder: LockHolder

`Readonly`namespace

namespace: NamespaceName

`Readonly`renewalService

renewalService: LockRenewalService

scheduleId

scheduleId: number

Methods

acquire

acquire(): Promise<void>
Acquires the lock. If the lock is already acquired, it checks if the lock is expired or held by the same process. If the lock is expired, it creates a new lock. If the lock is held by the same process, it renews the lock. If the lock is held by another process, then an exception is thrown.

Returns Promise<void>
Throws
LeaseAcquisitionError - If the lock is already acquired by another process or an error occurs during acquisition.
- Defined in src/core/lock/lock.ts:24

isAcquired

isAcquired(): Promise<boolean>
Checks if the lock is acquired. If the lock is acquired and not expired, it returns true; otherwise, false.

Returns Promise<boolean>
true if the lock is acquired and not expired; otherwise, false.
- Defined in src/core/lock/lock.ts:71

isExpired

isExpired(): Promise<boolean>
Checks if the lock is expired. If the lock is expired, it returns true; otherwise, false. This method does not verify if the lock is acquired by the current process.

Returns Promise<boolean>
true if the lock is expired; otherwise, false.
- Defined in src/core/lock/lock.ts:79

release

release(): Promise<void>
Releases the lock. If the lock is expired or held by the same process, it deletes the lock. If the lock is held by another process, then an exception is thrown.

Returns Promise<void>
Throws
LeaseRelinquishmentError - If the lock is already acquired by another process or an error occurs during relinquishment.
- Defined in src/core/lock/lock.ts:56

renew

renew(): Promise<void>
Renews the lock. If the lock is expired or held by the same process, it creates or renews the lock. If the lock is held by another process, then an exception is thrown.

Returns Promise<void>
Throws
LeaseAcquisitionError - If the lock is already acquired by another process or an error occurs during renewal.
- Defined in src/core/lock/lock.ts:40

tryAcquire

tryAcquire(): Promise<boolean>
Attempts to acquire the lock, by calling the acquire method. If an exception is thrown, it is caught and false is returned. If the lock is successfully acquired, true is returned; otherwise, false is returned.

Returns Promise<boolean>
true if the lock is successfully acquired; otherwise, false.
- Defined in src/core/lock/lock.ts:32

tryRelease

tryRelease(): Promise<boolean>
Attempts to relock the lock, by calling the relock method. If an exception is thrown, it is caught and false is returned. If the lock is successfully released, true is returned; otherwise, false is returned.

Returns Promise<boolean>
true if the lock is successfully released; otherwise, false.
- Defined in src/core/lock/lock.ts:64

tryRenew

tryRenew(): Promise<boolean>
Attempts to renew the lock, by calling the renew method. If an exception is thrown, it is caught and false is returned. If the lock is successfully renewed, true is returned; otherwise, false is returned.

Returns Promise<boolean>
true if the lock is successfully renewed; otherwise, false.
- Defined in src/core/lock/lock.ts:48