RoutineLocker
in package
implements
RoutineLockerInterface
Interfaces, Classes and Traits
Table of Contents
- $lockerFilePath : string
- $lockResource : resource
- __construct() : mixed
- RoutineLocker constructor.
- acquireLock() : mixed
- releaseLock() : mixed|void
- waitUntilLockIsReleasedOrTimeout() : void
- canLock() : bool
Properties
$lockerFilePath
protected
string
$lockerFilePath
$lockResource
protected
resource
$lockResource
Methods
__construct()
RoutineLocker constructor.
public
__construct(ExistingDirectory $directory, string $lockName) : mixed
Parameters
- $directory : ExistingDirectory
- $lockName : string
Return values
mixed —acquireLock()
public
acquireLock() : mixed
Tags
Return values
mixed —releaseLock()
public
releaseLock() : mixed|void
Return values
mixed|void —waitUntilLockIsReleasedOrTimeout()
public
waitUntilLockIsReleasedOrTimeout(mixed $timeout) : void
Parameters
- $timeout : mixed
Tags
Return values
void —canLock()
protected
canLock() : bool