FileLock
class FileLock extends CacheLock implements RefreshableLock
Traits
Properties
| protected string | $name | The name of the lock. |
from Lock |
| protected int | $seconds | The number of seconds the lock should be maintained. |
from Lock |
| protected string | $owner | The scope identifier of this lock. |
from Lock |
| protected int | $sleepMilliseconds | The number of milliseconds to wait before re-attempting to acquire a lock while blocking. |
from Lock |
| protected Store | $store | The cache store implementation. |
from CacheLock |
Methods
Get the number of seconds until the given DateTime.
Get the "available at" UNIX timestamp.
If the given value is an interval, convert it to a DateTime instance.
Given a start time, format the total run time for human readability.
Create a new lock instance.
Attempt to acquire the lock.
Release the lock without deleting another owner's replacement.
Return the current owner without deleting an expired lock record.
Attempt to acquire the lock for the given number of seconds.
Refresh the lock's TTL if still owned by this process.
Get the number of seconds until the lock expires.
Determine whether this lock is allowed to release the lock in the driver.
Determine whether this lock is owned by the given identifier.
Specify the number of milliseconds to sleep in between blocked lock acquisition attempts.
Details
in
InteractsWithTime at line 17
protected int
secondsUntil(DateInterval|DateTimeInterface|int $delay)
Get the number of seconds until the given DateTime.
in
InteractsWithTime at line 29
protected int
availableAt(DateInterval|DateTimeInterface|int|null $delay = 0)
Get the "available at" UNIX timestamp.
in
InteractsWithTime at line 47
protected DateTimeInterface|int
parseDateInterval(DateInterval|DateTimeInterface|int|null $delay)
If the given value is an interval, convert it to a DateTime instance.
in
InteractsWithTime at line 63
protected int
currentTime()
Get the current system time as a UNIX timestamp.
in
InteractsWithTime at line 71
protected string
runTimeForHumans(float $startTime, float|null $endTime = null)
Given a start time, format the total run time for human readability.
in
CacheLock at line 19
__construct(Store $store, string $name, int $seconds, string|null $owner = null)
Create a new lock instance.
at line 15
bool
acquire()
Attempt to acquire the lock.
at line 23
bool
release()
Release the lock without deleting another owner's replacement.
at line 31
protected string|null
getCurrentOwner()
Return the current owner without deleting an expired lock record.
in
Lock at line 74
mixed
get(callable|null $callback = null)
Attempt to acquire the lock.
in
Lock at line 96
mixed
block(int $seconds, callable|null $callback = null)
Attempt to acquire the lock for the given number of seconds.
in
Lock at line 130
protected never
releaseAfterFailure(Throwable $failure)
Release the lock while preserving the primary failure.
at line 41
bool
refresh(int|null $seconds = null)
Refresh the lock's TTL if still owned by this process.
at line 59
float|null
getRemainingLifetime()
Get the number of seconds until the lock expires.
in
Lock at line 164
string
owner()
Return the current owner of the lock.
in
Lock at line 172
bool
isLocked()
Determine if the lock is currently held by any process.
in
Lock at line 180
bool
isOwnedByCurrentProcess()
Determine whether this lock is allowed to release the lock in the driver.
in
Lock at line 188
bool
isOwnedBy(string|null $owner)
Determine whether this lock is owned by the given identifier.
in
Lock at line 198
Lock
betweenBlockedAttemptsSleepFor(int $milliseconds)
Specify the number of milliseconds to sleep in between blocked lock acquisition attempts.
in
CacheLock at line 63
void
forceRelease()
Releases this lock regardless of ownership.
at line 67
protected FileStore
fileStore()
Get the file store backing this lock.