Mutex::lock

(PECL pthreads < 3.0.0)

Mutex::lock — Acquire Mutex

Warning

The Mutex class has been removed in pthreads v3.

Description

final public static Mutex::lock ( int $mutex ) : bool

Attempt to lock the Mutex for the caller.

An attempt to lock a Mutex owned (locked) by another Thread will result in blocking.

Parameters

mutex: A handle returned by a previous call to Mutex::create().

Return Values

A boolean indication of success.

Examples

Example #1 Mutex Locking and Unlocking


<?php
/** You cannot use the "new" keyword, a Mutex is not a PHP object **/
$mutex = Mutex::create();
/** You can now lock the mutex in any context **/
var_dump(Mutex::lock($mutex));
/** It is invalid to attempt to destroy a locked Mutex **/
var_dump(Mutex::unlock($mutex));
/** Always destroy mutex you have created **/
Mutex::destroy($mutex);
?>

The above example will output:

bool(true)
bool(true)