interface PushQueueProcessorInterface in Salesforce Suite 5.0.x

Interface implemented by Salesforce Push Queue Processors.

Push Queue Processors are responsible for asynchronously processing a set of push queue items (during cron).

Hierarchy

• interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface
  • interface \Drupal\salesforce_push\PushQueueProcessorInterface

2 files declare their use of PushQueueProcessorInterface

PushQueueTest.php in modules/salesforce_push/tests/src/Unit/PushQueueTest.php

Rest.php in modules/salesforce_push/src/Plugin/SalesforcePushQueueProcessor/Rest.php

File

modules/salesforce_push/src/PushQueueProcessorInterface.php, line 15

Namespace

Drupal\salesforce_push

interface PushQueueProcessorInterface extends ContainerFactoryPluginInterface {

  /**
   * Process an array of push queue items.
   *
   * When an item is successfully processed, delete the item from queue via
   * PushQueue::deleteItem().
   *
   * @param array $items
   *   The items to process.
   *
   * @throws \Drupal\Core\Queue\SuspendQueueException
   *   Indicate that processing for this queue should not continue.
   *   Move on to the next queue.
   *   Items should be released.
   *
   * @throws \Drupal\Core\Queue\RequeueException
   *   Indicate that processing for this set of items failed.
   *   Processing for this queue should continue.
   *   Items should be released.
   *
   * @throws \Exception
   *   Indicate any other condition. Processing for this queue should continue.
   *   Items should not be released.
   */
  public function process(array $items);

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	120
PushQueueProcessorInterface::process	public	function	Process an array of push queue items.	1