core\lock\lock_utils Class Reference

Lock utilities. More...

Static Public Member Functions
static	wait_for_lock_with_progress (lock_factory $lockfactory, string $resource, core\progress\base $progress, int $timeout, string $message='', int $progressupdatetime=10, int $maxlifetime=DAYSECS,)
	Start a progress bar and attempt to get a lock, updating the bar until a lock is achieved.

Detailed Description

Lock utilities.

Copyright

2023 onwards Catalyst IT EU

Author

Mark Johnson mark..nosp@m.john.nosp@m.son@c.nosp@m.atal.nosp@m.yst-e.nosp@m.u.ne.nosp@m.t

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

wait_for_lock_with_progress()

static core\lock\lock_utils::wait_for_lock_with_progress ( lock_factory $lockfactory, string $resource, core\progress\base $progress, int $timeout, string $message = '', int $progressupdatetime = 10, int $maxlifetime = DAYSECS )

static

Start a progress bar and attempt to get a lock, updating the bar until a lock is achieved.

This will make multiple attempts at getting the lock using a short timeout set by $progressupdatetime. After each failed attempt, it will update the progress bar and try again, until $timeout is reached.

Parameters

lock_factory	$lockfactory	The factory to use to get the lock
string	$resource	The resource key we will try to get a lock on
base	$progress	The progress bar
int	$timeout	The maximum time in seconds to wait for a lock
string	$message	Optional message to display on the progress bar
int	$progressupdatetime	The number of seconds to wait for each lock attempt before updating the progress bar.
int	$maxlifetime	The maxlifetime to set on the lock, if supported.

Return values

lock|false

A lock if successful, or false if the timeout expires.

Exceptions

coding_exception

---

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

• lib/classes/lock/lock_utils.php