spunQ_IMutex Interface Reference

Interface for mutex implementations. More...

Inheritance diagram for spunQ_IMutex:

List of all members.

Public Member Functions
	tryAcquiring ($timeout=0)
	Tries to acquires this mutex.
	release ()
	Releases this mutex.

---

Detailed Description

Interface for mutex implementations.

See also:

http://en.wikipedia.org/wiki/Mutex

Definition at line 7 of file IMutex.interface.php.

---

Member Function Documentation

spunQ_IMutex::release

(

)

Releases this mutex.

Returns:

strg_IMutex $this

Implemented in spunQ_Mutex.

spunQ_IMutex::tryAcquiring

(

$

timeout = 0

)

Tries to acquires this mutex.

Parameters:

$timeout

Amount of seconds the function should block until the lock is acquired. Setting this to NULL will block indefinitely (until max_execution_time runs out). The default value of 0 will not block at all.

Returns:

boolean Whether the mutex was successfully acquired.

Implemented in spunQ_Mutex.

---

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

• IMutex.interface.php