W3cubDocs

/Laravel 11

PhpRedisLock

class PhpRedisLock extends RedisLock (View source)

Traits

InteractsWithTime

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 Connection $redis

The Redis factory implementation.

 from RedisLock

Methods

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

 from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

 from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

 from InteractsWithTime
int currentTime()

Get the current system time as a UNIX timestamp.

 from InteractsWithTime
string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

 from InteractsWithTime
void __construct(Connection $redis, string $name, int $seconds, string|null $owner = null)

Create a new phpredis lock instance.
bool acquire()

Attempt to acquire the lock.

 from RedisLock
bool release()

Release the lock.
string getCurrentOwner()

Returns the owner value written into the driver for this lock.

 from RedisLock
mixed get(callable|null $callback = null)

Attempt to acquire the lock.

 from Lock
mixed block(int $seconds, callable|null $callback = null)

Attempt to acquire the lock for the given number of seconds.

 from Lock
string owner()

Returns the current owner of the lock.

 from Lock
bool isOwnedByCurrentProcess()

Determines whether this lock is allowed to release the lock in the driver.

 from Lock
bool isOwnedBy(string|null $owner)

Determine whether this lock is owned by the given identifier.

 from Lock
$this betweenBlockedAttemptsSleepFor(int $milliseconds)

Specify the number of milliseconds to sleep in between blocked lock acquisition attempts.

 from Lock
void forceRelease()

Releases this lock in disregard of ownership.

 from RedisLock
string getConnectionName()

Get the name of the Redis connection being used to manage the lock.

 from RedisLock

Details

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float $endTime

Return Value

string

void __construct(Connection $redis, string $name, int $seconds, string|null $owner = null)

Create a new phpredis lock instance.

Parameters

Connection $redis
string $name
int $seconds
string|null $owner

Return Value

void

bool acquire()

Attempt to acquire the lock.

Return Value

bool

bool release()

Release the lock.

Return Value

bool

protected string getCurrentOwner()

Returns the owner value written into the driver for this lock.

Return Value

string

mixed get(callable|null $callback = null)

Attempt to acquire the lock.

Parameters

callable|null $callback

Return Value

mixed

mixed block(int $seconds, callable|null $callback = null)

Attempt to acquire the lock for the given number of seconds.

Parameters

int $seconds
callable|null $callback

Return Value

mixed

Exceptions

LockTimeoutException

string owner()

Returns the current owner of the lock.

Return Value

string

bool isOwnedByCurrentProcess()

Determines whether this lock is allowed to release the lock in the driver.

Return Value

bool

bool isOwnedBy(string|null $owner)

Determine whether this lock is owned by the given identifier.

Parameters

string|null $owner

Return Value

bool

$this betweenBlockedAttemptsSleepFor(int $milliseconds)

Specify the number of milliseconds to sleep in between blocked lock acquisition attempts.

Parameters

int $milliseconds

Return Value

$this

void forceRelease()

Releases this lock in disregard of ownership.

Return Value

void

string getConnectionName()

Get the name of the Redis connection being used to manage the lock.

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Cache/PhpRedisLock.html