RateLimited
class RateLimited
Properties
| protected RateLimiter | $limiter | The rate limiter instance. |
|
| protected string | $limiterName | The name of the rate limiter. |
|
| DateTimeInterface|int|null | $releaseAfter | The number of seconds before a job should be available again if the limit is exceeded. |
|
| bool | $shouldRelease | Indicates if the job should be released if the limit is exceeded. |
Methods
Create a new middleware instance.
Process the job.
Handle a rate limited job.
Set the delay (in seconds) to release the job back to the queue.
Do not release the job back to the queue if the limit is exceeded.
Get the number of seconds that should elapse before the job is retried.
Prepare the object for serialization.
Prepare the object after unserialization.
Details
at line 42
__construct(UnitEnum|string $limiterName)
Create a new middleware instance.
at line 53
mixed
handle(mixed $job, callable $next)
Process the job.
at line 84
protected mixed
handleJob(mixed $job, callable $next, array $limits)
Handle a rate limited job.
at line 102
RateLimited
releaseAfter(DateTimeInterface|int $releaseAfter)
Set the delay (in seconds) to release the job back to the queue.
at line 112
RateLimited
dontRelease()
Do not release the job back to the queue if the limit is exceeded.
at line 122
protected int
getTimeUntilNextRetry(string $key)
Get the number of seconds that should elapse before the job is retried.
at line 130
array
__sleep()
Prepare the object for serialization.
at line 142
__wakeup()
Prepare the object after unserialization.