pip-services3-components-nodex/obj/src/lock/ILock.d.ts

Component definitions for Pip.Services in Node.js / ES2017

/** @module lock */
/**
 * Interface for locks to synchronize work or parallel processes and to prevent collisions.
 *
 * The lock allows to manage multiple locks identified by unique keys.
 */
export interface ILock {
    /**
     * Makes a single attempt to acquire a lock by its key.
     * It returns immediately a positive or negative result.
     *
     * @param correlationId     (optional) transaction id to trace execution through call chain.
     * @param key               a unique lock key to acquire.
     * @param ttl               a lock timeout (time to live) in milliseconds.
     * @returns                 <code>true</code> if the lock was acquired and <code>false</code> otherwise.
     */
    tryAcquireLock(correlationId: string, key: string, ttl: number): Promise<boolean>;
    /**
     * Makes multiple attempts to acquire a lock by its key within give time interval.
     *
     * @param correlationId     (optional) transaction id to trace execution through call chain.
     * @param key               a unique lock key to acquire.
     * @param ttl               a lock timeout (time to live) in milliseconds.
     * @param timeout           a lock acquisition timeout.
     */
    acquireLock(correlationId: string, key: string, ttl: number, timeout: number): Promise<void>;
    /**
     * Releases prevously acquired lock by its key.
     *
     * @param correlationId     (optional) transaction id to trace execution through call chain.
     * @param key               a unique lock key to release.
     */
    releaseLock(correlationId: string, key: string): Promise<void>;
}