1. class
  2. Hypervel
  3. \
  4. Redis
  5. \
  6. Limiters
  7. \
  8. DurationLimiter

DurationLimiter

class DurationLimiter

Properties

int|null $decaysAt

The timestamp of the end of the current duration.
int|null $remaining

The number of remaining slots.

Methods

__construct(RedisProxy $redis, string $name, int $maxLocks, int $decay)

Create a new duration limiter instance.

mixed
block(int $timeout, callable|null $callback = null, int $sleep = 750)

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

bool
acquire()

Attempt to acquire the lock.

bool
tooManyAttempts()

Determine if the key has been "accessed" too many times.

void
clear()

Clear the limiter.

string
luaScript()

Get the Lua script for acquiring a lock.

string
tooManyAttemptsLuaScript()

Get the Lua script to determine if the key has been "accessed" too many times.

Details

at line 35
__construct(RedisProxy $redis, string $name, int $maxLocks, int $decay)

Create a new duration limiter instance.

Parameters

RedisProxy $redis

the Redis connection instance
string $name

the unique name of the lock
int $maxLocks

the allowed number of concurrent tasks
int $decay

the number of seconds a slot should be maintained

at line 48
mixed block(int $timeout, callable|null $callback = null, int $sleep = 750)

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

Parameters

int $timeout
callable|null $callback
int $sleep

Return Value

mixed

Exceptions

LimiterTimeoutException

at line 74
bool acquire()

Attempt to acquire the lock.

Return Value

bool

at line 95
bool tooManyAttempts()

Determine if the key has been "accessed" too many times.

Return Value

bool

at line 114
void clear()

Clear the limiter.

Return Value

void

at line 128
protected string luaScript()

Get the Lua script for acquiring a lock.

KEYS[1] - The limiter name ARGV[1] - Current time in microseconds ARGV[2] - Current time in seconds ARGV[3] - Duration of the bucket ARGV[4] - Allowed number of tasks

Return Value

string

at line 161
protected string tooManyAttemptsLuaScript()

Get the Lua script to determine if the key has been "accessed" too many times.

KEYS[1] - The limiter name ARGV[1] - Current time in microseconds ARGV[2] - Current time in seconds ARGV[3] - Duration of the bucket ARGV[4] - Allowed number of tasks

Return Value

string