class SystemQueue
Default queue implementation.
Hierarchy
- class \SystemQueue implements \DrupalReliableQueueInterface
Expanded class hierarchy of SystemQueue
Related topics
1 string reference to 'SystemQueue'
- DrupalQueue::get in modules/
system/ system.queue.inc - Returns the queue object for a given name.
File
-
modules/
system/ system.queue.inc, line 198
View source
class SystemQueue implements DrupalReliableQueueInterface {
/**
* The name of the queue this instance is working with.
*
* @var string
*/
protected $name;
public function __construct($name) {
$this->name = $name;
}
public function createItem($data) {
// During a Drupal 6.x to 7.x update, drupal_get_schema() does not contain
// the queue table yet, so we cannot rely on drupal_write_record().
$query = db_insert('queue')->fields(array(
'name' => $this->name,
'data' => serialize($data),
// We cannot rely on REQUEST_TIME because many items might be created
// by a single request which takes longer than 1 second.
'created' => time(),
));
return (bool) $query->execute();
}
public function numberOfItems() {
return db_query('SELECT COUNT(item_id) FROM {queue} WHERE name = :name', array(
':name' => $this->name,
))
->fetchField();
}
public function claimItem($lease_time = 30) {
// Claim an item by updating its expire fields. If claim is not successful
// another thread may have claimed the item in the meantime. Therefore loop
// until an item is successfully claimed or we are reasonably sure there
// are no unclaimed items left.
while (TRUE) {
$item = db_query_range('SELECT data, item_id FROM {queue} q WHERE expire = 0 AND name = :name ORDER BY created, item_id ASC', 0, 1, array(
':name' => $this->name,
))
->fetchObject();
if ($item) {
// Try to update the item. Only one thread can succeed in UPDATEing the
// same row. We cannot rely on REQUEST_TIME because items might be
// claimed by a single consumer which runs longer than 1 second. If we
// continue to use REQUEST_TIME instead of the current time(), we steal
// time from the lease, and will tend to reset items before the lease
// should really expire.
$update = db_update('queue')->fields(array(
'expire' => time() + $lease_time,
))
->condition('item_id', $item->item_id)
->condition('expire', 0);
// If there are affected rows, this update succeeded.
if ($update->execute()) {
$item->data = unserialize($item->data);
return $item;
}
}
else {
// No items currently available to claim.
return FALSE;
}
}
}
public function releaseItem($item) {
$update = db_update('queue')->fields(array(
'expire' => 0,
))
->condition('item_id', $item->item_id);
return $update->execute();
}
public function deleteItem($item) {
db_delete('queue')->condition('item_id', $item->item_id)
->execute();
}
public function createQueue() {
// All tasks are stored in a single database table (which is created when
// Drupal is first installed) so there is nothing we need to do to create
// a new queue.
}
public function deleteQueue() {
db_delete('queue')->condition('name', $this->name)
->execute();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
SystemQueue::$name | protected | property | The name of the queue this instance is working with. | |
SystemQueue::claimItem | public | function | 1 | |
SystemQueue::createItem | public | function | ||
SystemQueue::createQueue | public | function | ||
SystemQueue::deleteItem | public | function | ||
SystemQueue::deleteQueue | public | function | ||
SystemQueue::numberOfItems | public | function | ||
SystemQueue::releaseItem | public | function | ||
SystemQueue::__construct | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.