RedisLock
class RedisLock extends Lock 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 RedisProxy | $redis | The Redis connection proxy. |
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.
Returns the owner value written into the driver for this lock.
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.
Releases this lock in disregard of ownership.
Get the name of the Redis connection being used to manage the lock.
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 41
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 57
protected int
currentTime()
Get the current system time as a UNIX timestamp.
in
InteractsWithTime at line 65
protected string
runTimeForHumans(float $startTime, float|null $endTime = null)
Given a start time, format the total run time for human readability.
at line 23
__construct(RedisProxy $redis, string $name, int $seconds, string|null $owner = null)
Create a new lock instance.
at line 33
bool
acquire()
Attempt to acquire the lock.
at line 45
bool
release()
Release the lock.
at line 68
protected string|null
getCurrentOwner()
Returns the owner value written into the driver for this lock.
in
Lock at line 73
mixed
get(callable|null $callback = null)
Attempt to acquire the lock.
in
Lock at line 101
mixed
block(int $seconds, callable|null $callback = null)
Attempt to acquire the lock for the given number of seconds.
at line 78
bool
refresh(int|null $seconds = null)
Refresh the lock's TTL if still owned by this process.
at line 108
float|null
getRemainingLifetime()
Get the number of seconds until the lock expires.
in
Lock at line 161
string
owner()
Return the current owner of the lock.
in
Lock at line 169
bool
isLocked()
Determine if the lock is currently held by any process.
in
Lock at line 177
bool
isOwnedByCurrentProcess()
Determine whether this lock is allowed to release the lock in the driver.
in
Lock at line 185
bool
isOwnedBy(string|null $owner)
Determine whether this lock is owned by the given identifier.
in
Lock at line 193
Lock
betweenBlockedAttemptsSleepFor(int $milliseconds)
Specify the number of milliseconds to sleep in between blocked lock acquisition attempts.
at line 60
void
forceRelease()
Releases this lock in disregard of ownership.
at line 123
string
getConnectionName()
Get the name of the Redis connection being used to manage the lock.