SyncMutex::__construct

SyncMutex::unlock

SyncMutex::lock

Waits for an exclusive lock

Description

public bool SyncMutex::lock ([ integer $wait = -1 ] )

Obtains an exclusive lock on a SyncMutex object. If the lock is already acquired, then this increments an internal counter.

Parameters

wait: The number of milliseconds to wait for the exclusive lock. A value of -1 is infinite.

Return Values

A boolean of TRUE if the lock was obtained, FALSE otherwise.

Examples

Example #1 SyncMutex::lock example


<?php
$mutex = new SyncMutex("UniqueName");

if (!$mutex->lock(3000))
{
    echo "Unable to lock mutex.";

    exit();
}

/* ... */

$mutex->unlock();
?>

See Also

SyncMutex::unlock