interface PeekableRequestRateLimiterInterface

A request limiter which allows peeking ahead.

This is valuable to reduce the cache backend load in scenarios like a login when we only want to consume a token on login failure, and where the majority of requests will be successful and thus not need to consume a token.

This way we can peek ahead before allowing the request through, and only consume if the request failed (1 backend op). This is compared to always consuming and then resetting the limit if the request is successful (2 backend ops).

@author Jordi Boggiano <j.boggiano@seld.be>

Hierarchy

• interface \Symfony\Component\HttpFoundation\RateLimiter\RequestRateLimiterInterface
  • interface \Symfony\Component\HttpFoundation\RateLimiter\PeekableRequestRateLimiterInterface extends \Symfony\Component\HttpFoundation\RateLimiter\RequestRateLimiterInterface

Expanded class hierarchy of PeekableRequestRateLimiterInterface

All classes that implement PeekableRequestRateLimiterInterface

File

vendor/symfony/http-foundation/RateLimiter/PeekableRequestRateLimiterInterface.php, line 32

Namespace

interface PeekableRequestRateLimiterInterface extends RequestRateLimiterInterface {
    public function peek(Request $request) : RateLimit;

}

Members