Interface DistributedLock

A handler for a distributed lock that can be released.

interface DistributedLock {
    get lockId(): string;
    get resourceId(): string;
    isReleased(): boolean;
    observeRelease(): Observable<void>;
    release(): Promise<void>;
}

Index

Accessors

lockId resourceId

Methods

isReleased observeRelease release

Accessors

lockId

get lockId(): string

Unique lock instance ID within the system.

Returns string

resourceId

get resourceId(): string

The resource identifier (mutex name) that was locked.

Returns string

Methods

isReleased

isReleased(): boolean

Whether the lock has been released.

Returns boolean
True if the lock has been released.

observeRelease

observeRelease(): Observable<void>

Observes when the lock is released (It may be released due to a connection issue). Emits as soon as the lock is considered released locally, without waiting for the server to confirm it.

Returns Observable<void>
An observable that emits when the lock is released.

release

release(): Promise<void>

Releases the lock by sending a release message to the server. The lock is considered released immediately; the message to the server is sent asynchronously.

Returns Promise<void>
A promise that resolves when the release message is sent, or undefined for backward compatibility.