class SuspendQueueException in Drupal 9

Exception class to throw to indicate that a cron queue should be skipped.

An implementation of \Drupal\Core\Queue\QueueWorkerInterface::processItem() throws this class of exception to indicate that processing of the whole queue should be skipped. This should be thrown rather than a normal Exception if the problem encountered by the queue worker is such that it can be deduced that workers of subsequent items would encounter it too. For example, if a remote site that the queue worker depends on appears to be inaccessible.

Hierarchy

• class \Drupal\Core\Queue\SuspendQueueException extends \Drupal\Core\Queue\RuntimeException

3 files declare their use of SuspendQueueException

Cron.php in core/lib/Drupal/Core/Cron.php

CronQueueTestBrokenQueue.php in core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestBrokenQueue.php

CronTest.php in core/tests/Drupal/Tests/Core/CronTest.php

1 string reference to 'SuspendQueueException'

CronTest::processQueuesTestData in core/tests/Drupal/Tests/Core/CronTest.php

Data provider for ::testProcessQueues() method.

File

core/lib/Drupal/Core/Queue/SuspendQueueException.php, line 15

Namespace

Drupal\Core\Queue

class SuspendQueueException extends \RuntimeException {

}