A rate limiter.
A rate limiter limits the number of requests from a particular source to a particular limit over a defined period. Once the limit is reached, the server refuses to process any more requests until the defined period is rolled over.
This rate limiter uses the FatFree Framework's cache to store rate limit information.
| Methods | ||
|---|---|---|
public
|
__construct(string $key, int $limit = 10, int $interval = 10)
|
# |
public
|
throttle(string $src = null, int $weight = 1): bool
|
# |
public
|
remainder(string $src = null): int
|
# |
public
|
penalize(string $src = null): void
|
# |
public
|
reset(string $src = null): void
|
# |
public
|
resetAll(): void
|
# |
public
|
getKey(): string
|
# |
public
|
getLimit(): int
|
# |
public
|
getInterval(): int
|
# |
protected
|
getDefaultSource(): string
|
# |
protected
|
getCacheName(string $src): string
|
# |
| Properties | |||
|---|---|---|---|
protected
|
string
|
$key
|
# |
protected
|
int
|
$limit
|
# |
protected
|
int
|
$interval
|
# |