hphp/hsl/src/async/KeyedPoll.php

   1 <?hh
   2 /*
   3  *  Copyright (c) 2004-present, Facebook, Inc.
   4  *  All rights reserved.
   5  *
   6  *  This source code is licensed under the MIT license found in the
   7  *  LICENSE file in the root directory of this source tree.
   8  *
   9  */
  10
  11 namespace HH\Lib\Async;
  12
  13 /** A keyed variant of `Poll`.
  14  *
  15  * See `Poll` if you do not need to preserve keys.
  16  *
  17  * Keys are retrieved with:
  18  *
  19  * ```
  20  * foreach ($keyed_poll await as $k => $v) {
  21  * ```
  22  *
  23  * ===== WARNING ===== WARNING ===== WARNING ===== WARNING ===== WARNING =====
  24  *
  25  * See detailed warning for `BasePoll`
  26  *
  27  * ===== WARNING ===== WARNING ===== WARNING ===== WARNING ===== WARNING =====
  28  */
  29 final class KeyedPoll<Tk, Tv>
  30   extends BasePoll<Tk, Tv>
  31   implements AsyncKeyedIterator<Tk, Tv> {
  32
  33   /** Create a `KeyedPoll` from the specified list of awaitables.
  34    *
  35    * See `Poll` if keys are unimportant.
  36    */
  37   public static function from(
  38     KeyedTraversable<Tk, Awaitable<Tv>> $awaitables,
  39   ): this {
  40     return self::fromImpl($awaitables);
  41   }
  42
  43   /** Add a single awaitable to the poll.
  44    *
  45    * The key is retrieved with `foreach ($poll await as $k => $v) {}`
  46    */
  47   public function add(Tk $key, Awaitable<Tv> $awaitable): void {
  48     $this->addImpl($key, $awaitable);
  49   }
  50
  51   /** Add multiple keys and awaitables to the poll */
  52   public function addMulti(
  53     KeyedTraversable<Tk, Awaitable<Tv>> $awaitables,
  54   ): void {
  55     $this->addMultiImpl($awaitables);
  56   }
  57 }