SyncMutex::lock
PHP function
Edit on GitHub ✎
(PECL sync >= 1.0.0)
Waits for an exclusive lock
Description
SyncMutex::lock(int $wait = -1): bool
Obtains an exclusive lock on a SyncMutex object. If the lock is already acquired, then this increments an internal counter.
Parameters
waitThe number of milliseconds to wait for the exclusive lock. A value of -1 is infinite.
Return Values
Success
Examples
SyncMutex::lock() example
php
<?php
$mutex = new SyncMutex("UniqueName");
if (!$mutex->lock(3000))
{
echo "Unable to lock mutex.";
exit();
}
/* ... */
$mutex->unlock();
?>See Also
SyncMutex::unlock