folly/futures/helpers.h

   1 /*
   2  * Copyright 2015 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 #pragma once
  17
  18 #include <folly/futures/Future.h>
  19
  20 namespace folly {
  21
  22 /// This namespace is for utility functions that would usually be static
  23 /// members of Future, except they don't make sense there because they don't
  24 /// depend on the template type (rather, on the type of their arguments in
  25 /// some cases). This is the least-bad naming scheme we could think of. Some
  26 /// of the functions herein have really-likely-to-collide names, like "map"
  27 /// and "sleep".
  28 namespace futures {
  29   /// Returns a Future that will complete after the specified duration. The
  30   /// Duration typedef of a `std::chrono` duration type indicates the
  31   /// resolution you can expect to be meaningful (milliseconds at the time of
  32   /// writing). Normally you wouldn't need to specify a Timekeeper, we will
  33   /// use the global futures timekeeper (we run a thread whose job it is to
  34   /// keep time for futures timeouts) but we provide the option for power
  35   /// users.
  36   ///
  37   /// The Timekeeper thread will be lazily created the first time it is
  38   /// needed. If your program never uses any timeouts or other time-based
  39   /// Futures you will pay no Timekeeper thread overhead.
  40   Future<void> sleep(Duration, Timekeeper* = nullptr);
  41
  42   /// Create a Future chain from a sequence of callbacks. i.e.
  43   ///
  44   ///   f.then(a).then(b).then(c);
  45   ///
  46   /// where f is a Future<A> and the result of the chain is a Future<Z>
  47   /// becomes
  48   ///
  49   ///   f.then(chain<A,Z>(a, b, c));
  50   // If anyone figures how to get chain to deduce A and Z, I'll buy you a drink.
  51   template <class A, class Z, class... Callbacks>
  52   std::function<Future<Z>(Try<A>)>
  53   chain(Callbacks... fns);
  54
  55   /**
  56    * Set func as the callback for each input Future and return a vector of
  57    * Futures containing the results in the input order.
  58    */
  59   template <class It, class F,
  60             class ItT = typename std::iterator_traits<It>::value_type,
  61             class Result
  62       = typename decltype(std::declval<ItT>().then(std::declval<F>()))::value_type>
  63   std::vector<Future<Result>> map(It first, It last, F func);
  64
  65   // Sugar for the most common case
  66   template <class Collection, class F>
  67   auto map(Collection&& c, F&& func)
  68       -> decltype(map(c.begin(), c.end(), func)) {
  69     return map(c.begin(), c.end(), std::forward<F>(func));
  70   }
  71
  72 }
  73
  74 /**
  75   Make a completed Future by moving in a value. e.g.
  76
  77     string foo = "foo";
  78     auto f = makeFuture(std::move(foo));
  79
  80   or
  81
  82     auto f = makeFuture<string>("foo");
  83 */
  84 template <class T>
  85 Future<typename std::decay<T>::type> makeFuture(T&& t);
  86
  87 /** Make a completed void Future. */
  88 Future<void> makeFuture();
  89
  90 /** Make a completed Future by executing a function. If the function throws
  91   we capture the exception, otherwise we capture the result. */
  92 template <class F>
  93 auto makeFutureWith(
  94   F&& func,
  95   typename std::enable_if<
  96     !std::is_reference<F>::value, bool>::type sdf = false)
  97   -> Future<decltype(func())>;
  98
  99 template <class F>
 100 auto makeFutureWith(
 101   F const& func)
 102   -> Future<decltype(func())>;
 103
 104 /// Make a failed Future from an exception_ptr.
 105 /// Because the Future's type cannot be inferred you have to specify it, e.g.
 106 ///
 107 ///   auto f = makeFuture<string>(std::current_exception());
 108 template <class T>
 109 Future<T> makeFuture(std::exception_ptr const& e) DEPRECATED;
 110
 111 /// Make a failed Future from an exception_wrapper.
 112 template <class T>
 113 Future<T> makeFuture(exception_wrapper ew);
 114
 115 /** Make a Future from an exception type E that can be passed to
 116   std::make_exception_ptr(). */
 117 template <class T, class E>
 118 typename std::enable_if<std::is_base_of<std::exception, E>::value,
 119                         Future<T>>::type
 120 makeFuture(E const& e);
 121
 122 /** Make a Future out of a Try */
 123 template <class T>
 124 Future<T> makeFuture(Try<T>&& t);
 125
 126 /*
 127  * Return a new Future that will call back on the given Executor.
 128  * This is just syntactic sugar for makeFuture().via(executor)
 129  *
 130  * @param executor the Executor to call back on
 131  *
 132  * @returns a void Future that will call back on the given executor
 133  */
 134 template <typename Executor>
 135 Future<void> via(Executor* executor);
 136
 137 /** When all the input Futures complete, the returned Future will complete.
 138   Errors do not cause early termination; this Future will always succeed
 139   after all its Futures have finished (whether successfully or with an
 140   error).
 141
 142   The Futures are moved in, so your copies are invalid. If you need to
 143   chain further from these Futures, use the variant with an output iterator.
 144
 145   This function is thread-safe for Futures running on different threads. But
 146   if you are doing anything non-trivial after, you will probably want to
 147   follow with `via(executor)` because it will complete in whichever thread the
 148   last Future completes in.
 149
 150   The return type for Future<T> input is a Future<std::vector<Try<T>>>
 151   */
 152 template <class InputIterator>
 153 Future<std::vector<Try<
 154   typename std::iterator_traits<InputIterator>::value_type::value_type>>>
 155 collectAll(InputIterator first, InputIterator last);
 156
 157 /// Sugar for the most common case
 158 template <class Collection>
 159 auto collectAll(Collection&& c) -> decltype(collectAll(c.begin(), c.end())) {
 160   return collectAll(c.begin(), c.end());
 161 }
 162
 163 /// This version takes a varying number of Futures instead of an iterator.
 164 /// The return type for (Future<T1>, Future<T2>, ...) input
 165 /// is a Future<std::tuple<Try<T1>, Try<T2>, ...>>.
 166 /// The Futures are moved in, so your copies are invalid.
 167 template <typename... Fs>
 168 typename detail::VariadicContext<
 169   typename std::decay<Fs>::type::value_type...>::type
 170 collectAll(Fs&&... fs);
 171
 172 /// Like collectAll, but will short circuit on the first exception. Thus, the
 173 /// type of the returned Future is std::vector<T> instead of
 174 /// std::vector<Try<T>>
 175 template <class InputIterator>
 176 Future<typename detail::CollectContext<
 177   typename std::iterator_traits<InputIterator>::value_type::value_type
 178 >::result_type>
 179 collect(InputIterator first, InputIterator last);
 180
 181 /// Sugar for the most common case
 182 template <class Collection>
 183 auto collect(Collection&& c) -> decltype(collect(c.begin(), c.end())) {
 184   return collect(c.begin(), c.end());
 185 }
 186
 187 /** The result is a pair of the index of the first Future to complete and
 188   the Try. If multiple Futures complete at the same time (or are already
 189   complete when passed in), the "winner" is chosen non-deterministically.
 190
 191   This function is thread-safe for Futures running on different threads.
 192   */
 193 template <class InputIterator>
 194 Future<std::pair<
 195   size_t,
 196   Try<typename std::iterator_traits<InputIterator>::value_type::value_type>>>
 197 collectAny(InputIterator first, InputIterator last);
 198
 199 /// Sugar for the most common case
 200 template <class Collection>
 201 auto collectAny(Collection&& c) -> decltype(collectAny(c.begin(), c.end())) {
 202   return collectAny(c.begin(), c.end());
 203 }
 204
 205 /** when n Futures have completed, the Future completes with a vector of
 206   the index and Try of those n Futures (the indices refer to the original
 207   order, but the result vector will be in an arbitrary order)
 208
 209   Not thread safe.
 210   */
 211 template <class InputIterator>
 212 Future<std::vector<std::pair<
 213   size_t,
 214   Try<typename std::iterator_traits<InputIterator>::value_type::value_type>>>>
 215 collectN(InputIterator first, InputIterator last, size_t n);
 216
 217 /// Sugar for the most common case
 218 template <class Collection>
 219 auto collectN(Collection&& c, size_t n)
 220     -> decltype(collectN(c.begin(), c.end(), n)) {
 221   return collectN(c.begin(), c.end(), n);
 222 }
 223
 224 template <typename F, typename T, typename ItT>
 225 using MaybeTryArg = typename std::conditional<
 226   detail::callableWith<F, T&&, Try<ItT>&&>::value, Try<ItT>, ItT>::type;
 227
 228 template<typename F, typename T, typename Arg>
 229 using isFutureResult = isFuture<typename std::result_of<F(T&&, Arg&&)>::type>;
 230
 231 /** repeatedly calls func on every result, e.g.
 232     reduce(reduce(reduce(T initial, result of first), result of second), ...)
 233
 234     The type of the final result is a Future of the type of the initial value.
 235
 236     Func can either return a T, or a Future<T>
 237   */
 238 template <class It, class T, class F,
 239           class ItT = typename std::iterator_traits<It>::value_type::value_type,
 240           class Arg = MaybeTryArg<F, T, ItT>>
 241 typename std::enable_if<!isFutureResult<F, T, Arg>::value, Future<T>>::type
 242 reduce(It first, It last, T initial, F func);
 243
 244 template <class It, class T, class F,
 245           class ItT = typename std::iterator_traits<It>::value_type::value_type,
 246           class Arg = MaybeTryArg<F, T, ItT>>
 247 typename std::enable_if<isFutureResult<F, T, Arg>::value, Future<T>>::type
 248 reduce(It first, It last, T initial, F func);
 249
 250 /// Sugar for the most common case
 251 template <class Collection, class T, class F>
 252 auto reduce(Collection&& c, T&& initial, F&& func)
 253     -> decltype(reduce(c.begin(), c.end(), initial, func)) {
 254   return reduce(
 255       c.begin(),
 256       c.end(),
 257       std::forward<T>(initial),
 258       std::forward<F>(func));
 259 }
 260
 261 } // namespace folly