class ReliablePhpRedis in Redis 8

Redis queue implementation using PhpRedis extension backend.

Hierarchy

• class \Drupal\redis\Queue\QueueBase implements QueueInterface
  • class \Drupal\redis\Queue\ReliableQueueBase implements ReliableQueueInterface
    • class \Drupal\redis\Queue\ReliablePhpRedis

File

src/Queue/ReliablePhpRedis.php, line 10

Namespace

Drupal\redis\Queue

class ReliablePhpRedis extends ReliableQueueBase {

  /**
   * The Redis connection.
   *
   * @var \Redis $client
   */
  protected $client;

  /**
   * Constructs a \Drupal\redis\Queue\PhpRedis object.
   *
   * @param string $name
   *   The name of the queue.
   * @param array $settings
   *   Array of Redis-related settings for this queue.
   * @param \Redis $client
   *   The PhpRedis client.
   */
  public function __construct($name, array $settings, \Redis $client) {
    parent::__construct($name, $settings);
    $this->client = $client;
  }

  /**
   * {@inheritdoc}
   */
  public function createItem($data) {
    $record = new \stdClass();
    $record->data = $data;
    $record->qid = $this
      ->incrementId();

    // We cannot rely on REQUEST_TIME because many items might be created
    // by a single request which takes longer than 1 second.
    $record->timestamp = time();
    $result = $this->client
      ->multi()
      ->hsetnx($this->availableItems, $record->qid, serialize($record))
      ->lLen($this->availableListKey)
      ->lpush($this->availableListKey, $record->qid)
      ->exec();
    $success = $result[0] && $result[2] > $result[1];
    return $success ? $record->qid : FALSE;
  }

  /**
   * Gets next serial ID for Redis queue items.
   *
   * @return int
   *   Next serial ID for Redis queue item.
   */
  protected function incrementId() {
    return $this->client
      ->incr($this->incrementCounterKey);
  }

  /**
   * {@inheritdoc}
   */
  public function numberOfItems() {
    return $this->client
      ->lLen($this->availableListKey) + $this->client
      ->lLen($this->claimedListKey);
  }

  /**
   * {@inheritdoc}
   */
  public function claimItem($lease_time = 30) {

    // Is it OK to do garbage collection here (we need to loop list of claimed
    // items)?
    $this
      ->garbageCollection();
    $item = FALSE;
    if ($this->reserveTimeout !== NULL) {

      // A blocking version of claimItem to be used with long-running queue workers.
      $qid = $this->client
        ->brpoplpush($this->availableListKey, $this->claimedListKey, $this->reserveTimeout);
    }
    else {
      $qid = $this->client
        ->rpoplpush($this->availableListKey, $this->claimedListKey);
    }
    if ($qid) {
      $job = $this->client
        ->hget($this->availableItems, $qid);
      if ($job) {
        $item = unserialize($job);
        $this->client
          ->setex($this->leasedKeyPrefix . $item->qid, $lease_time, '1');
      }
    }
    return $item;
  }

  /**
   * {@inheritdoc}
   */
  public function releaseItem($item) {
    $this->client
      ->multi()
      ->lrem($this->claimedListKey, $item->qid, -1)
      ->lpush($this->availableListKey, $item->qid)
      ->exec();
  }

  /**
   * {@inheritdoc}
   */
  public function deleteItem($item) {
    $this->client
      ->multi()
      ->lrem($this->claimedListKey, $item->qid, -1)
      ->hdel($this->availableItems, $item->qid)
      ->exec();
  }

  /**
   * {@inheritdoc}
   */
  public function deleteQueue() {
    $keys_to_remove = [
      $this->claimedListKey,
      $this->availableListKey,
      $this->availableItems,
      $this->incrementCounterKey,
    ];
    foreach ($this->client
      ->keys($this->leasedKeyPrefix . '*') as $key) {
      $keys_to_remove[] = $key;
    }
    $this->client
      ->del($keys_to_remove);
  }

  /**
   * Automatically release items, that have been claimed and exceeded lease time.
   */
  protected function garbageCollection() {
    foreach ($this->client
      ->lrange($this->claimedListKey, 0, -1) as $qid) {
      if (!$this->client
        ->exists($this->leasedKeyPrefix . $qid)) {

        // The lease expired for this ID.
        $this->client
          ->multi()
          ->lrem($this->claimedListKey, $qid, -1)
          ->lpush($this->availableListKey, $qid)
          ->exec();
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
QueueBase::$availableItems	protected	property	Key for hash table of available queue items.
QueueBase::$availableListKey	protected	property	Key for list of available items.
QueueBase::$claimedListKey	protected	property	Key for list of claimed items.
QueueBase::$incrementCounterKey	protected	property	Key of increment counter key.
QueueBase::$leasedKeyPrefix	protected	property	Key prefix for items that are used to track expiration of leased items.
QueueBase::$name	protected	property	The name of the queue this instance is working with.
QueueBase::$reserveTimeout	protected	property	Reserve timeout for blocking item claim.
QueueBase::createQueue	public	function	Creates a queue. Overrides QueueInterface::createQueue
QueueBase::KEY_PREFIX		constant	Prefix used with all keys.
ReliablePhpRedis::$client	protected	property	The Redis connection.
ReliablePhpRedis::claimItem	public	function	Claims an item in the queue for processing. Overrides QueueInterface::claimItem
ReliablePhpRedis::createItem	public	function	Adds a queue item and store it directly to the queue. Overrides QueueInterface::createItem
ReliablePhpRedis::deleteItem	public	function	Deletes a finished item from the queue. Overrides QueueInterface::deleteItem
ReliablePhpRedis::deleteQueue	public	function	Deletes a queue and every item in the queue. Overrides QueueInterface::deleteQueue
ReliablePhpRedis::garbageCollection	protected	function	Automatically release items, that have been claimed and exceeded lease time.
ReliablePhpRedis::incrementId	protected	function	Gets next serial ID for Redis queue items.
ReliablePhpRedis::numberOfItems	public	function	Retrieves the number of items in the queue. Overrides QueueInterface::numberOfItems
ReliablePhpRedis::releaseItem	public	function	Releases an item that the worker could not process. Overrides QueueInterface::releaseItem
ReliablePhpRedis::__construct	public	function	Constructs a \Drupal\redis\Queue\PhpRedis object. Overrides QueueBase::__construct