class PhpRedisLock extends RedisLock (View source)

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

The Redis factory implementation.

from  RedisLock

Methods

int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

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

Get the "available at" UNIX timestamp.

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

int
currentTime()

Get the current system time as a UNIX timestamp.

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.

bool
release()

Release the lock.

string
getCurrentOwner()

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

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
$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.

string
getConnectionName()

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

string
serializedAndCompressedOwner()

Get the owner key, serialized and compressed.

bool
compressed()

Determine if compression is enabled.

bool
lzfCompressed()

Determine if LZF compression is enabled.

bool
zstdCompressed()

Determine if ZSTD compression is enabled.

bool
lz4Compressed()

Determine if LZ4 compression is enabled.

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

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

protected bool isOwnedByCurrentProcess()

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

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

protected string serializedAndCompressedOwner()

Get the owner key, serialized and compressed.

Return Value

string

Exceptions

UnexpectedValueException

protected bool compressed()

Determine if compression is enabled.

Return Value

bool

protected bool lzfCompressed()

Determine if LZF compression is enabled.

Return Value

bool

protected bool zstdCompressed()

Determine if ZSTD compression is enabled.

Return Value

bool

protected bool lz4Compressed()

Determine if LZ4 compression is enabled.

Return Value

bool