Documentation

PdbMutex
in package
implements MutexInterface

Table of Contents

Interfaces

MutexInterface
A locking mechanism.

Properties

$autoRelease  : bool
$name  : string
$pdb  : Pdb
$releaseAllLocks  : bool
$uniqueLocks  : bool

Methods

__construct()  : mixed
__destruct()  : mixed
acquire()  : bool
Acquire the lock.
release()  : bool
Release the lock.

Properties

$autoRelease

public bool $autoRelease = true

$releaseAllLocks

public bool $releaseAllLocks = false

$uniqueLocks

public bool $uniqueLocks = true

Methods

__construct()

public __construct(Pdb $pdb, string $name) : mixed
Parameters
$pdb : Pdb
$name : string

__destruct()

public __destruct() : mixed
Tags
inheritdoc

acquire()

Acquire the lock.

public acquire([float $timeout = 0 ]) : bool
Parameters
$timeout : float = 0

in seconds

Tags
inheritdoc
Return values
bool

release()

Release the lock.

public release() : bool
Tags
inheritdoc
Return values
bool
On this page

Search results