SuspendQueueException.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Queue/SuspendQueueException.php
  2. 10 core/lib/Drupal/Core/Queue/SuspendQueueException.php
  3. 11.x core/lib/Drupal/Core/Queue/SuspendQueueException.php

Namespace

Drupal\Core\Queue

File

core/lib/Drupal/Core/Queue/SuspendQueueException.php

View source
<?php

namespace Drupal\Core\Queue;


/**
 * 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.
 */
class SuspendQueueException extends \RuntimeException {

}

Classes

Title Deprecated Summary
SuspendQueueException Exception class to throw to indicate that a cron queue should be skipped.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.