interface QueueInterface

  1. 8.0.x lib/Drush/Queue/QueueInterface.php QueueInterface
  2. 7.x lib/Drush/Queue/QueueInterface.php QueueInterface
  3. master lib/Drush/Queue/QueueInterface.php QueueInterface

Defines an interface for interacting with queues.

Namespace

Drush\Queue

Implemented by

Hierarchy

Expanded class hierarchy of QueueInterface

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
QueueInterface::getInfo public function Returns a given queue definition.
QueueInterface::getQueue public function Returns a given queue definition.
QueueInterface::getQueues public function Returns all queues.
QueueInterface::run public function Runs a given queue.

File

lib/Drush/Queue/QueueInterface.php, line 8

View source
interface QueueInterface {

  /**
   * Returns all queues.
   */
  public function getQueues();

  /**
   * Runs a given queue.
   *
   * @param string $name
   *   The name of the queue to run.
   * @param int $time_limit
   *   The maximum number of seconds that the queue can run. By default the
   *   queue will be run as long as possible.
   *
   * @return int
   *   The number of items successfully processed from the queue.
   */
  public function run($name, $time_limit = 0);

  /**
   * Returns a given queue definition.
   *
   * @param string $name
   *   The name of the queue to run.
   */
  public function getQueue($name);

  /**
   * Returns a given queue definition.
   *
   * @param string $name
   *   The name of the queue to run.
   */
  public function getInfo($name);

}