| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
Class representing a lock The methods available for a specific lock type are only known by it's factory.
| Copyright: | Damyon Wiese 2013 |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 126 lines (4 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
lock:: (5 methods):
__construct()
get_key()
extend()
release()
__destruct()
| __construct($key, $factory) X-Ref |
| Construct a lock containing the unique key required to release it. param: mixed $key - The lock key. The type of this is up to the lock_factory being used. param: lock_factory $factory - The factory that generated this lock. |
| get_key() X-Ref |
| Return the unique key representing this lock. return: string|int lock key. |
| extend($maxlifetime = 86400) X-Ref |
| Extend the lifetime of this lock. Not supported by all factories. param: int $maxlifetime - the new lifetime for the lock (in seconds). return: bool |
| release() X-Ref |
| Release this lock return: bool |
| __destruct() X-Ref |
| Print debugging if this lock falls out of scope before being released. |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |