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  * @param priority optionally, the priority to add with. Defaults to 0 which
 132  * represents medium priority.
 133  *
 134  * @returns a void Future that will call back on the given executor
 135  */
 136 inline Future<void> via(
 137     Executor* executor,
 138     int8_t priority = Executor::MID_PRI);
 139
 140 /** When all the input Futures complete, the returned Future will complete.
 141   Errors do not cause early termination; this Future will always succeed
 142   after all its Futures have finished (whether successfully or with an
 143   error).
 144
 145   The Futures are moved in, so your copies are invalid. If you need to
 146   chain further from these Futures, use the variant with an output iterator.
 147
 148   This function is thread-safe for Futures running on different threads. But
 149   if you are doing anything non-trivial after, you will probably want to
 150   follow with `via(executor)` because it will complete in whichever thread the
 151   last Future completes in.
 152
 153   The return type for Future<T> input is a Future<std::vector<Try<T>>>
 154   */
 155 template <class InputIterator>
 156 Future<std::vector<Try<
 157   typename std::iterator_traits<InputIterator>::value_type::value_type>>>
 158 collectAll(InputIterator first, InputIterator last);
 159
 160 /// Sugar for the most common case
 161 template <class Collection>
 162 auto collectAll(Collection&& c) -> decltype(collectAll(c.begin(), c.end())) {
 163   return collectAll(c.begin(), c.end());
 164 }
 165
 166 /// This version takes a varying number of Futures instead of an iterator.
 167 /// The return type for (Future<T1>, Future<T2>, ...) input
 168 /// is a Future<std::tuple<Try<T1>, Try<T2>, ...>>.
 169 /// The Futures are moved in, so your copies are invalid.
 170 template <typename... Fs>
 171 typename detail::VariadicContext<
 172   typename std::decay<Fs>::type::value_type...>::type
 173 collectAll(Fs&&... fs);
 174
 175 /// Like collectAll, but will short circuit on the first exception. Thus, the
 176 /// type of the returned Future is std::vector<T> instead of
 177 /// std::vector<Try<T>>
 178 template <class InputIterator>
 179 Future<typename detail::CollectContext<
 180   typename std::iterator_traits<InputIterator>::value_type::value_type
 181 >::result_type>
 182 collect(InputIterator first, InputIterator last);
 183
 184 /// Sugar for the most common case
 185 template <class Collection>
 186 auto collect(Collection&& c) -> decltype(collect(c.begin(), c.end())) {
 187   return collect(c.begin(), c.end());
 188 }
 189
 190 /** The result is a pair of the index of the first Future to complete and
 191   the Try. If multiple Futures complete at the same time (or are already
 192   complete when passed in), the "winner" is chosen non-deterministically.
 193
 194   This function is thread-safe for Futures running on different threads.
 195   */
 196 template <class InputIterator>
 197 Future<std::pair<
 198   size_t,
 199   Try<typename std::iterator_traits<InputIterator>::value_type::value_type>>>
 200 collectAny(InputIterator first, InputIterator last);
 201
 202 /// Sugar for the most common case
 203 template <class Collection>
 204 auto collectAny(Collection&& c) -> decltype(collectAny(c.begin(), c.end())) {
 205   return collectAny(c.begin(), c.end());
 206 }
 207
 208 /** when n Futures have completed, the Future completes with a vector of
 209   the index and Try of those n Futures (the indices refer to the original
 210   order, but the result vector will be in an arbitrary order)
 211
 212   Not thread safe.
 213   */
 214 template <class InputIterator>
 215 Future<std::vector<std::pair<
 216   size_t,
 217   Try<typename std::iterator_traits<InputIterator>::value_type::value_type>>>>
 218 collectN(InputIterator first, InputIterator last, size_t n);
 219
 220 /// Sugar for the most common case
 221 template <class Collection>
 222 auto collectN(Collection&& c, size_t n)
 223     -> decltype(collectN(c.begin(), c.end(), n)) {
 224   return collectN(c.begin(), c.end(), n);
 225 }
 226
 227 template <typename F, typename T, typename ItT>
 228 using MaybeTryArg = typename std::conditional<
 229   detail::callableWith<F, T&&, Try<ItT>&&>::value, Try<ItT>, ItT>::type;
 230
 231 template<typename F, typename T, typename Arg>
 232 using isFutureResult = isFuture<typename std::result_of<F(T&&, Arg&&)>::type>;
 233
 234 /** repeatedly calls func on every result, e.g.
 235     reduce(reduce(reduce(T initial, result of first), result of second), ...)
 236
 237     The type of the final result is a Future of the type of the initial value.
 238
 239     Func can either return a T, or a Future<T>
 240   */
 241 template <class It, class T, class F>
 242 Future<T> reduce(It first, It last, T&& initial, F&& func);
 243
 244 /// Sugar for the most common case
 245 template <class Collection, class T, class F>
 246 auto reduce(Collection&& c, T&& initial, F&& func)
 247     -> decltype(reduce(c.begin(), c.end(), std::forward<T>(initial),
 248                 std::forward<F>(func))) {
 249   return reduce(
 250       c.begin(),
 251       c.end(),
 252       std::forward<T>(initial),
 253       std::forward<F>(func));
 254 }
 255
 256 } // namespace folly