Branch: Tag:

2019-02-18

2019-02-18 13:28:40 by Henrik Grubbström (Grubba) <grubba@grubba.org>

Documentation [Concurrent]: Note where backend state isn't propagated.

1126:   //! A @[Future] that represents the first   //! of the @expr{futures@} that completes.   //! + //! @note + //! The returned @[Future] does NOT have any state (eg backend) + //! propagated from the @[futures]. This must be done by hand. + //!   //! @seealso   //! @[race()], @[Promise.first_completed()]   variant Future first_completed(array(Future) futures)
1139:      //! JavaScript Promise API equivalent of @[first_completed()].   //! + //! @note + //! The returned @[Future] does NOT have any state (eg backend) + //! propagated from the @[futures]. This must be done by hand. + //!   //! @seealso   //! @[first_completed()], @[Promise.first_completed()]   //! @url{https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise@}
1154:   //! @returns   //! A @[Future] that represents the array of all the completed @expr{futures@}.   //! + //! @note + //! The returned @[Future] does NOT have any state (eg backend) + //! propagated from the @[futures]. This must be done by hand. + //!   //! @seealso   //! @[all()], @[Promise.depend()]   variant Future results(array(Future) futures)
1170:      //! JavaScript Promise API equivalent of @[results()].   //! + //! @note + //! The returned @[Future] does NOT have any state (eg backend) + //! propagated from the @[futures]. This must be done by hand. + //!   //! @seealso   //! @[results()], @[Promise.depend()]   //! @url{https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise@}
1185:   //! @returns   //! A new @[Future] that has already failed for the specified @expr{reason@}.   //! + //! @note + //! The returned @[Future] does NOT have a backend set. + //!   //! @seealso   //! @[Future.on_failure()], @[Promise.failure()]   //! @url{https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise@}
1201:   //! @note   //! This function can be used to ensure values are futures.   //! + //! @note + //! The returned @[Future] does NOT have a backend set. + //!   //! @seealso   //! @[Future.on_success()], @[Promise.success()]   //! @url{https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise@}
1213:      //! Return a @[Future] that represents the array of mapping @[fun]   //! over the results of the completed @[futures]. + //! + //! @note + //! The returned @[Future] does NOT have any state (eg backend) + //! propagated from the @[futures]. This must be done by hand.   Future traverse(array(Future) futures,    function(mixed, mixed ... : mixed) fun,    mixed ... extra)
1239:   //! once for every @[Future] in @[futures], unless one of   //! calls fails in which case no further calls will be   //! performed. + //! + //! @note + //! The returned @[Future] does NOT have any state (eg backend) + //! propagated from the @[futures]. This must be done by hand.   Future fold(array(Future) futures,    mixed initial,    function(mixed, mixed, mixed ... : mixed) fun,