class DelayedRequeueException
Same name in other branches
- 10 core/lib/Drupal/Core/Queue/DelayedRequeueException.php \Drupal\Core\Queue\DelayedRequeueException
- 11.x core/lib/Drupal/Core/Queue/DelayedRequeueException.php \Drupal\Core\Queue\DelayedRequeueException
Throw this exception to leave an item in the queue until its lock expires.
For more information about how this exception interacts with Drupal's queue processing via the built-in cron service. Queues must implement this interface to support custom delay intervals; if this interface is missing, any custom delay interval specified for this exception will be ignored and the remaining time in the original lease will be used as the duration of the delay interval. For use when an item needs to be requeued immediately.
Hierarchy
- class \Drupal\Core\Queue\DelayedRequeueException extends \Drupal\Core\Queue\RuntimeException
Expanded class hierarchy of DelayedRequeueException
See also
\Drupal\Core\Cron::processQueues()
\Drupal\Core\Queue\DelayableQueueInterface
\Drupal\Core\Queue\RequeueException
5 files declare their use of DelayedRequeueException
- Cron.php in core/
lib/ Drupal/ Core/ Cron.php - CronQueueTestDatabaseDelayException.php in core/
modules/ system/ tests/ modules/ cron_queue_test/ src/ Plugin/ QueueWorker/ CronQueueTestDatabaseDelayException.php - CronQueueTestMemoryDelayException.php in core/
modules/ system/ tests/ modules/ cron_queue_test/ src/ Plugin/ QueueWorker/ CronQueueTestMemoryDelayException.php - CronTest.php in core/
tests/ Drupal/ Tests/ Core/ CronTest.php - QueueExceptionsTest.php in core/
tests/ Drupal/ Tests/ Core/ Queue/ QueueExceptionsTest.php
1 string reference to 'DelayedRequeueException'
- CronTest::processQueuesTestData in core/
tests/ Drupal/ Tests/ Core/ CronTest.php - Data provider for ::testProcessQueues() method.
File
-
core/
lib/ Drupal/ Core/ Queue/ DelayedRequeueException.php, line 19
Namespace
Drupal\Core\QueueView source
class DelayedRequeueException extends \RuntimeException {
/**
* The interval of time that the item should remain locked (in seconds).
*
* @var int
*/
protected $delay = 0;
/**
* Constructs a DelayedRequeueException.
*
* @param int $delay
* The desired delay interval for this item (in seconds).
* @param string $message
* The error message.
* @param int $code
* The error code.
* @param \Throwable|null $previous
* The previous throwable used for the exception chaining.
*/
public function __construct(int $delay = 0, string $message = '', int $code = 0, \Throwable $previous = NULL) {
parent::__construct($message, $code, $previous);
if ($delay > 0) {
$this->delay = $delay;
}
}
/**
* Get the desired delay interval for this item.
*
* @see self::$delay
* For recommended value usage in a queue processor.
*
* @return int
* The desired delay interval for this item.
*/
public function getDelay() : int {
return $this->delay;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
DelayedRequeueException::$delay | protected | property | The interval of time that the item should remain locked (in seconds). |
DelayedRequeueException::getDelay | public | function | Get the desired delay interval for this item. |
DelayedRequeueException::__construct | public | function | Constructs a DelayedRequeueException. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.