Provides database mutex that can be used to prevent race conditions between two processes that affect the same data. More...

Public Member Functions
	__construct (protected Database $db)
	Constructor. More...

	lock (string $namespace)
	Creates a table {prefix}{$namespace}_lock that is used as a mutex. More...

	unlock (string $namespace)
	Unlocks mutex. More...

	isLocked (string $namespace)
	Checks if mutex is locked. More...

Protected Member Functions
	assertNamespace (string $namespace)
	Assert that the namespace contains only characters [A-Za-z]. More...

Detailed Description

Provides database mutex that can be used to prevent race conditions between two processes that affect the same data.

NOTE: This class uses the database connections directly because the queries aren't QueryBuilders

Definition at line 18 of file Mutex.php.

Constructor & Destructor Documentation

Elgg\Database\Mutex::__construct ( protected Database $db )

Constructor.

Parameters

Database $db Database

Definition at line 27 of file Mutex.php.

Elgg\Database\Mutex::assertNamespace ( string $namespace )

protected

Assert that the namespace contains only characters [A-Za-z].

Parameters

string $namespace Namespace to use for the database table

Exceptions

InvalidArgumentException

Definition at line 89 of file Mutex.php.

Elgg\Database\Mutex::isLocked ( string $namespace )

Checks if mutex is locked.

Parameters

string $namespace Namespace to use for the database table

Definition at line 74 of file Mutex.php.

Elgg\Database\Mutex::lock ( string $namespace )

Creates a table {prefix}{$namespace}_lock that is used as a mutex.

Parameters

string $namespace Allows having separate locks for separate processes

Definition at line 37 of file Mutex.php.

Elgg\Database\Mutex::unlock ( string $namespace )

Unlocks mutex.

Parameters

string $namespace Namespace to use for the database table

Definition at line 59 of file Mutex.php.

The documentation for this class was generated from the following file: