vendor/symfony/rate-limiter/LimiterInterface.php line 38

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Symfony\Component\RateLimiter;
  14. use Symfony\Component\RateLimiter\Exception\MaxWaitDurationExceededException;
  15. use Symfony\Component\RateLimiter\Exception\ReserveNotSupportedException;
  17. /**
  18. * @author Wouter de Jong <wouter@wouterj.nl>
  19. *
  20. * @experimental in 5.3
  21. */
  22. interface LimiterInterface
  23. {
  24. /**
  25. * Waits until the required number of tokens is available.
  26. *
  27. * The reserved tokens will be taken into account when calculating
  28. * future token consumptions. Do not use this method if you intend
  29. * to skip this process.
  30. *
  31. * @param int $tokens the number of tokens required
  32. * @param float $maxTime maximum accepted waiting time in seconds
  33. *
  34. * @throws MaxWaitDurationExceededException if $maxTime is set and the process needs to wait longer than its value (in seconds)
  35. * @throws ReserveNotSupportedException if this limiter implementation doesn't support reserving tokens
  36. * @throws \InvalidArgumentException if $tokens is larger than the maximum burst size
  37. */
  38. public function reserve(int $tokens = 1, float $maxTime = null): Reservation;
  40. /**
  41. * Use this method if you intend to drop if the required number
  42. * of tokens is unavailable.
  43. *
  44. * @param int $tokens the number of tokens required
  45. */
  46. public function consume(int $tokens = 1): RateLimit;
  48. /**
  49. * Resets the limit.
  50. */
  51. public function reset(): void;
  52. }