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

DurationLimiter

class DurationLimiter (View source)

Properties

int $decaysAt

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

The number of remaining slots.

Methods

void
__construct(Connection $redis, string $name, int $maxLocks, int $decay)

Create a new duration limiter instance.

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

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

bool
acquire()

Attempt to acquire the lock.

string
luaScript()

Get the Lua script for acquiring a lock.

Details

at line 60
void __construct(Connection $redis, string $name, int $maxLocks, int $decay)

Create a new duration limiter instance.

Parameters

Connection $redis
string $name
int $maxLocks
int $decay

Return Value

void

at line 77
mixed block(int $timeout, callable|null $callback = null)

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

Parameters

int $timeout
callable|null $callback

Return Value

mixed

Exceptions

LimiterTimeoutException

at line 101
bool acquire()

Attempt to acquire the lock.

Return Value

bool

at line 125
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

Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.