Download the PHP package zwirek/reactphp-limiter without Composer
On this page you can find all versions of the php package zwirek/reactphp-limiter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zwirek/reactphp-limiter
More information about zwirek/reactphp-limiter
Files in zwirek/reactphp-limiter
Package reactphp-limiter
Short Description Set of classes for limiting concurrent job execution using ReactPHP
License MIT
Informations about the package reactphp-limiter
zwirek/reactphp-limiter
Set of limiters designed to use with ReactPHP
Table of content
- Introduction
- Usage
- RateLimiter
- TimeWindowLimiter
- MutationLimiter
- Limiter Interface
Introduction
This repository contains several limiter classes designed for use with ReactPHP. Each limiter must have a registered handler (callable) that will be called immediately for each request before the limit is reached. Any additional request over the limit will be queued. There are different limiters for different purposes:
- RateLimiter: Limits simultaneous handler execution for a given limit
- TimeWindowLimiter: For time window, limit handler execution to the specified limit.
- MutationLimiter: Limits handler execution against a resource.
Usage
RateLimiter
Limit concurrent handler execution to given limit
Handler will only be fired twice at the same time.
It is possible to limit the number of jobs waiting to be executed by setting an overflow limit
Calls above the limit are immediately rejected.
TimeWindowLimiter
This limiter is responsible for limiting handler execution under a given limit within a time window. For example it is possible to limit a job execution to 100 times every 1 minute.
For this example, the handler is called twice every half second. The next calls will start immediately when the next window starts, even if jobs from the previous window are in pending state.
It is possible to limit the number of jobs waiting to be executed by setting an overflow limit.
MutationLimiter
This limiter can limit concurrent job calls for specific resource. Resource can be anything like file, connection, row in database because limiter needs additional callback that returns resource id. Resource id must be string or int or float.
Second callback is responsible for providing resource id. It gets the same data as argument as handler callback. In this way it is possible to resolve resource id based on given data.
It is possible to limit the number of jobs waiting to be executed per resource by setting an overflow limit.
Limiter Interface
Every limiter class implement \Zwirek\Limiter\Limiter
interface. Limiter interface have only one public method.
The handler can be called with zero or more arguments. It is important to call ::handle
with at least the number of arguments
as a registered handler callback.