class BatchQueue

Defines a batch queue.

Stale items from failed batches are cleaned from the {queue} table on cron using the 'created' date.

Hierarchy

Expanded class hierarchy of BatchQueue

File

includes/batch.queue.inc, line 19
Queue handlers used by the Batch API.

Members

Name Modifiers Type Description
BatchQueue::claimItem public function Overrides SystemQueue::claimItem(). Overrides SystemQueue::claimItem
BatchQueue::getAllItems public function Retrieves all remaining items in the queue.
SystemQueue::$name protected property The name of the queue this instance is working with.
SystemQueue::createItem public function Add a queue item and store it directly to the queue. Overrides DrupalQueueInterface::createItem
SystemQueue::createQueue public function Create a queue. Overrides DrupalQueueInterface::createQueue
SystemQueue::deleteItem public function Delete a finished item from the queue. Overrides DrupalQueueInterface::deleteItem
SystemQueue::deleteQueue public function Delete a queue and every item in the queue. Overrides DrupalQueueInterface::deleteQueue
SystemQueue::numberOfItems public function Retrieve the number of items in the queue. Overrides DrupalQueueInterface::numberOfItems
SystemQueue::releaseItem public function Release an item that the worker could not process, so another worker can come in and process it before the timeout expires. Overrides DrupalQueueInterface::releaseItem
SystemQueue::__construct public function

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/includes!batch.queue.inc/class/BatchQueue/7.x