DurationLimiterBuilder
class DurationLimiterBuilder (View source)
Traits
Properties
| Connection | $connection | The Redis connection. |
|
| string | $name | The name of the lock. |
|
| int | $maxLocks | The maximum number of locks that can be obtained per time window. |
|
| int | $decay | The amount of time the lock window is maintained. |
|
| int | $timeout | The amount of time to block until a lock is available. |
|
| int | $sleep | The number of milliseconds to wait between attempts to acquire the lock. |
Methods
Get the number of seconds until the given DateTime.
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.
Set the maximum number of locks that can be obtained per time window.
Set the amount of time the lock window is maintained.
Set the amount of time to block until a lock is available.
The number of milliseconds to wait between lock acquisition attempts.
Execute the given callback if a lock is obtained, otherwise call the failure callback.
Details
protected int
secondsUntil(DateTimeInterface|DateInterval|int $delay)
Get the number of seconds until the given DateTime.
protected int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Get the "available at" UNIX timestamp.
protected DateTimeInterface|int
parseDateInterval(DateTimeInterface|DateInterval|int $delay)
If the given value is an interval, convert it to a DateTime instance.
protected int
currentTime()
Get the current system time as a UNIX timestamp.
protected string
runTimeForHumans(float $startTime, float $endTime = null)
Given a start time, format the total run time for human readability.
void
__construct(Connection $connection, string $name)
Create a new builder instance.
$this
allow(int $maxLocks)
Set the maximum number of locks that can be obtained per time window.
$this
every(DateTimeInterface|DateInterval|int $decay)
Set the amount of time the lock window is maintained.
$this
block(int $timeout)
Set the amount of time to block until a lock is available.
$this
sleep(int $sleep)
The number of milliseconds to wait between lock acquisition attempts.
mixed
then(callable $callback, callable|null $failure = null)
Execute the given callback if a lock is obtained, otherwise call the failure callback.