public function QueueInterface::claimItem in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Queue/QueueInterface.php \Drupal\Core\Queue\QueueInterface::claimItem()
2. 9 core/lib/Drupal/Core/Queue/QueueInterface.php \Drupal\Core\Queue\QueueInterface::claimItem()

Claims an item in the queue for processing.

Parameters

$lease_time: How long the processing is expected to take in seconds, defaults to an hour. After this lease expires, the item will be reset and another consumer can claim the item. For idempotent tasks (which can be run multiple times without side effects), shorter lease times would result in lower latency in case a consumer fails. For tasks that should not be run more than once (non-idempotent), a larger lease time will make it more rare for a given task to run multiple times in cases of failure, at the cost of higher latency.

Return value

On success we return an item object. If the queue is unable to claim an item it returns false. This implies a best effort to retrieve an item and either the queue is empty or there is some other non-recoverable problem.

If returned, the object will have at least the following properties:

• data: the same as what passed into createItem().
• item_id: the unique ID returned from createItem().
• created: timestamp when the item was put into the queue.

File

core/lib/Drupal/Core/Queue/QueueInterface.php, line 69

Class

QueueInterface

Interface for a queue.

Namespace

Drupal\Core\Queue

Code

public function claimItem($lease_time = 3600);