RetryStrategyInterface.php 1.1 KB

12345678910111213141516171819202122232425262728293031323334
  1. <?php
  2. /**
  3. * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  4. * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  5. *
  6. * Licensed under The MIT License
  7. * For full copyright and license information, please see the LICENSE.txt
  8. * Redistributions of files must retain the above copyright notice.
  9. *
  10. * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  11. * @link https://cakephp.org CakePHP(tm) Project
  12. * @since 3.6.0
  13. * @license https://opensource.org/licenses/mit-license.php MIT License
  14. */
  15. namespace Cake\Core\Retry;
  16. use Exception;
  17. /**
  18. * Used to instruct a CommandRetry object on whether or not a retry
  19. * for an action should be performed
  20. */
  21. interface RetryStrategyInterface
  22. {
  23. /**
  24. * Returns true if the action can be retried, false otherwise.
  25. *
  26. * @param Exception $exception The exception that caused the action to fail
  27. * @param int $retryCount The number of times the action has been already called
  28. * @return bool Whether or not it is OK to retry the action
  29. */
  30. public function shouldRetry(Exception $exception, $retryCount);
  31. }