You are here

SuspendQueueException.php in Zircon Profile 8

Same filename and directory in other branches
  1. 8.0 core/lib/Drupal/Core/Queue/SuspendQueueException.php

Namespace

Drupal\Core\Queue

File

core/lib/Drupal/Core/Queue/SuspendQueueException.php
View source
<?php

/**
 * @file
 * Contains \Drupal\Core\Queue\SuspendQueueException.
 */
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

Namesort descending Description
SuspendQueueException Exception class to throw to indicate that a cron queue should be skipped.