LockUtility Class Reference
Public Member Functions | |
| setTimeout ($timeout) | |
| lock ($id, $waitForTimeout=true) | |
| unlock ($id) | |
| __destruct () | |
Detailed Description
Definition at line 15 of file lockutility.php.
Constructor & Destructor Documentation
| __destruct | ( | ) |
Definition at line 103 of file lockutility.php.
Member Function Documentation
| lock | ( | $ | id, | |
| $ | waitForTimeout = true | |||
| ) |
Lock a user id
- Parameters:
-
int $id, id of the user to lock. bool $waitForTimeout, wait for time out
- Returns:
- bool, returns true if the user was locked
Definition at line 44 of file lockutility.php.
References kataMakeTmpPath().
Here is the call graph for this function:
| setTimeout | ( | $ | timeout | ) |
- Parameters:
-
integer $timout how many seconds to wait for a lock before we fail
Definition at line 29 of file lockutility.php.
| unlock | ( | $ | id | ) |
Unlock a user id
- Parameters:
-
int $id, id of the user to lock
- Returns:
- true if the user was unlocked
Definition at line 82 of file lockutility.php.
The documentation for this class was generated from the following file:
