src/types/AnyLock.ts
/*!
* Copyright (c) 2018, imqueue.com <support@imqueue.com>
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
* REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
* INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
* LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
/**
* Lock implementation interface to follow
*/
export interface AnyLock {
/**
* Must initialize lock asynchronously
*/
init(): Promise<void>;
/**
* Implements lock acquire logic asynchronously
*/
acquire(): Promise<boolean>;
/**
* Implements lock release logic asynchronously
*/
release(): Promise<void>;
/**
* Implements lock acquire verification asynchronously
*/
isAcquired(): boolean;
/**
* Implements lock safe destruction asynchronously
*/
destroy(): Promise<void>;
/**
* Implements lock release handler upset
*
* @param {(channel: string) => void} handler
*/
onRelease(handler: (channel: string) => void): void;
}