55 lines
2.5 KiB
TypeScript
55 lines
2.5 KiB
TypeScript
/**
|
|
* @packageDocumentation
|
|
* @module std.base
|
|
*/
|
|
import { ILockable } from "./ILockable";
|
|
/**
|
|
* Common interface for timed lockable mutex.
|
|
*
|
|
* @author Jeongho Nam - https://github.com/samchon
|
|
*/
|
|
export interface ITimedLockable extends ILockable {
|
|
/**
|
|
* Tries to lock the mutex until timeout.
|
|
*
|
|
* Attempts to monopoly a mutex until timeout. If succeeded to monopoly the mutex until the
|
|
* timeout, it returns `true`. Otherwise failed to acquiring the lock in the given time, the
|
|
* function gives up the trial and returns `false`.
|
|
*
|
|
* Failed to acquiring the lock in the given time (returns `false`), it means that there's
|
|
* someone who has already {@link lock monopolied} the mutex and does not return it over the
|
|
* timeout.
|
|
*
|
|
* Note that, if you succeeded to monopoly the mutex (returns `true`) but do not call the
|
|
* {@link unlock} function after your business, the others who want to {@link lock monopoly}
|
|
* the mutex would be fall into the forever sleep. Therefore, never forget to calling the
|
|
* {@link unlock} function or utilize the {@link UniqueLock.try_lock_for} function instead to
|
|
* ensure the safety.
|
|
*
|
|
* @param ms The maximum miliseconds for waiting.
|
|
* @return Whether succeeded to monopoly the mutex or not.
|
|
*/
|
|
try_lock_for(ms: number): Promise<boolean>;
|
|
/**
|
|
* Tries to write lock the mutex until time expiration.
|
|
*
|
|
* Attemps to monopoly a mutex until time expiration. If succeeded to monopoly the mutex
|
|
* until the time expiration, it returns `true`. Otherwise failed to acquiring the lock in the
|
|
* given time, the function gives up the trial and returns `false`.
|
|
*
|
|
* Failed to acquiring the lock in the given time (returns `false`), it means that there's
|
|
* someone who has already {@link lock monopolied} the mutex and does not return it over the
|
|
* time expiration.
|
|
*
|
|
* Note that, if you succeeded to monopoly the mutex (returns `true`) but do not call the
|
|
* {@link unlock} function after your business, the others who want to {@link lock monopoly}
|
|
* the mutex would be fall into the forever sleep. Therefore, never forget to calling the
|
|
* {@link unlock} function or utilize the {@link UniqueLock.try_lock_until} function instead
|
|
* to ensure the safety.
|
|
*
|
|
* @param at The maximum time point to wait.
|
|
* @return Whether succeeded to monopoly the mutex or not.
|
|
*/
|
|
try_lock_until(at: Date): Promise<boolean>;
|
|
}
|