Locks the mutex.
Monopolies a mutex until be unlocked. If there're someone who have already monopolied the mutex, the function call would be blocked until all of them to return their acquistions by calling the unlock method.
In same reason, if you don't call the unlock function after your business, the others who want to monopoly the mutex would be fall into the forever sleep. Therefore, never forget to calling the unlock function or utilize the UniqueLock.lock function instead to ensure the safety.
Tries to lock the mutex.
Attempts to monopoly a mutex without blocking. If succeeded to monopoly the mutex
immediately, it returns true directly. Otherwise there's someone who has already
monopolied the mutex, the function gives up the trial immediately and returns
false directly.
Note that, if you succeeded to monopoly the mutex (returns true) but do not call the
unlock function after your business, the others who want to monopoly
the mutex would be fall into the forever sleep. Therefore, never forget to calling the
unlock function or utilize the UniqueLock.try_lock function instead to
ensure the safety.
Whether succeeded to monopoly the mutex or not.
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 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
unlock function after your business, the others who want to monopoly
the mutex would be fall into the forever sleep. Therefore, never forget to calling the
unlock function or utilize the UniqueLock.try_lock_for function instead to
ensure the safety.
The maximum miliseconds for waiting.
Whether succeeded to monopoly the mutex or not.
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 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
unlock function after your business, the others who want to monopoly
the mutex would be fall into the forever sleep. Therefore, never forget to calling the
unlock function or utilize the UniqueLock.try_lock_until function instead
to ensure the safety.
The maximum time point to wait.
Whether succeeded to monopoly the mutex or not.
Unlocks the mutex.
When you call this unlock method and there're someone who are currently blocked by attempting to lock this mutex, one of them (FIFO; first-in-first-out) would acquire the lock and continues its execution.
Otherwise, there's not anyone who is acquiring the lock of this mutex, the DomainError exception would be thrown.
As you know, when you succeeded to acquire the
lock, you don't have to forget to calling this unlock method after your business. If you forget it, it would be a terrible situation for the others who're attempting to lock this mutex.However, if you utilize the UniqueLock, you don't need to consider about this unlock method. Just define your business into a callback function as a parameter of methods of the UniqueLock, then this unlock method would be automatically called by the UniqueLock after the business.
Generated using TypeDoc
Common interface for timed lockable mutex.
Jeongho Nam - https://github.com/samchon