Login Register

DatabaseQueue

Default queue implementation.

Hierarchy

class \Drupal\Core\Queue\DatabaseQueue implements QueueGarbageCollectionInterface, ReliableQueueInterface uses DependencySerializationTrait

Related topics

Queue operations: Queue items to allow later processing.

File

core/lib/Drupal/Core/Queue/DatabaseQueue.php, line 14

Namespace

Drupal\Core\Queue

Members

Name	Modifiers	Type	Description
DatabaseQueue::$connection	protected	property	The database connection.
DatabaseQueue::$name	protected	property	The name of the queue this instance is working with.
DatabaseQueue::catchException	protected	function	Act on an exception when queue might be stale.
DatabaseQueue::claimItem	public	function	Claims an item in the queue for processing. Overrides QueueInterface::claimItem
DatabaseQueue::createItem	public	function	Adds a queue item and store it directly to the queue. Overrides QueueInterface::createItem
DatabaseQueue::createQueue	public	function	Creates a queue. Overrides QueueInterface::createQueue
DatabaseQueue::deleteItem	public	function	Deletes a finished item from the queue. Overrides QueueInterface::deleteItem
DatabaseQueue::deleteQueue	public	function	Deletes a queue and every item in the queue. Overrides QueueInterface::deleteQueue
DatabaseQueue::doCreateItem	protected	function	Adds a queue item and store it directly to the queue.
DatabaseQueue::ensureTableExists	protected	function	Check if the table exists and create it if not.
DatabaseQueue::garbageCollection	public	function	Cleans queues of garbage. Overrides QueueGarbageCollectionInterface::garbageCollection
DatabaseQueue::numberOfItems	public	function	Retrieves the number of items in the queue. Overrides QueueInterface::numberOfItems
DatabaseQueue::releaseItem	public	function	Releases an item that the worker could not process. Overrides QueueInterface::releaseItem
DatabaseQueue::schemaDefinition	public	function	Defines the schema for the queue table.
DatabaseQueue::TABLE_NAME		constant	The database table name.
DatabaseQueue::__construct		function	Constructs a \Drupal\Core\Queue\DatabaseQueue object.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function
DependencySerializationTrait::__wakeup	public	function

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Queue%21DatabaseQueue.php/class/DatabaseQueue/8.2.x

doc_Drupal

2016-10-29 08:59:48

Comments

Leave a Comment

Please login to continue.

Popular Articles

DatabaseQueue::releaseItem public DatabaseQueue::releaseItem($item) Releases an item that the worker could not process. Another worker can come in and process it before the tim

DatabaseQueue DatabaseQueue class DatabaseQueue extends Queue implements Queue (View source) Methods mixed pushOn(string $queue, string $job, mixed $data = '

DatabaseQueue::setContainer() void setContainer(Container $container) Set the IoC container instance. Parameters Container $container Return Value void

DatabaseQueue::doCreateItem protected DatabaseQueue::doCreateItem($data) Adds a queue item and store it directly to the queue. Parameters $data: Arbitrary data to be associated

DatabaseQueue::pop() Job|null pop(string $queue = null) Pop the next job off of the queue. Parameters string $queue Return Value Job|null