folly/futures/Promise.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
  17 #pragma once
  18
  19 #include <folly/futures/Deprecated.h>
  20 #include <folly/futures/Try.h>
  21 #include <functional>
  22
  23 namespace folly {
  24
  25 // forward declaration
  26 template <class T> class Future;
  27
  28 template <class T>
  29 class Promise {
  30 public:
  31   Promise();
  32   ~Promise();
  33
  34   // not copyable
  35   Promise(Promise const&) = delete;
  36   Promise& operator=(Promise const&) = delete;
  37
  38   // movable
  39   Promise(Promise<T>&&) noexcept;
  40   Promise& operator=(Promise<T>&&) noexcept;
  41
  42   /** Return a Future tied to the shared core state. This can be called only
  43     once, thereafter Future already retrieved exception will be raised. */
  44   Future<T> getFuture();
  45
  46   /** Fulfill the Promise with an exception_wrapper */
  47   void setException(exception_wrapper ew);
  48
  49   /** Fulfill the Promise with an exception_ptr, e.g.
  50     try {
  51       ...
  52     } catch (...) {
  53       p.setException(std::current_exception());
  54     }
  55     */
  56   void setException(std::exception_ptr const&) DEPRECATED;
  57
  58   /** Fulfill the Promise with an exception type E, which can be passed to
  59     std::make_exception_ptr(). Useful for originating exceptions. If you
  60     caught an exception the exception_wrapper form is more appropriate.
  61     */
  62   template <class E>
  63   typename std::enable_if<std::is_base_of<std::exception, E>::value>::type
  64   setException(E const&);
  65
  66   /// Set an interrupt handler to handle interrupts. See the documentation for
  67   /// Future::raise(). Your handler can do whatever it wants, but if you
  68   /// bother to set one then you probably will want to fulfill the promise with
  69   /// an exception (or special value) indicating how the interrupt was
  70   /// handled.
  71   void setInterruptHandler(std::function<void(exception_wrapper const&)>);
  72
  73   /// Sugar to fulfill this Promise<Unit>
  74   template <class B = T>
  75   typename std::enable_if<std::is_same<Unit, B>::value, void>::type
  76   setValue() {
  77     setTry(Try<T>(T()));
  78   }
  79
  80   /** Set the value (use perfect forwarding for both move and copy) */
  81   template <class M>
  82   void setValue(M&& value);
  83
  84   void setTry(Try<T>&& t);
  85
  86   /** Fulfill this Promise with the result of a function that takes no
  87     arguments and returns something implicitly convertible to T.
  88     Captures exceptions. e.g.
  89
  90     p.setWith([] { do something that may throw; return a T; });
  91   */
  92   template <class F>
  93   void setWith(F&& func);
  94
  95   bool isFulfilled();
  96
  97 private:
  98   typedef typename Future<T>::corePtr corePtr;
  99   template <class> friend class Future;
 100
 101   // Whether the Future has been retrieved (a one-time operation).
 102   bool retrieved_;
 103
 104   // shared core state object
 105   corePtr core_;
 106
 107   void throwIfFulfilled();
 108   void throwIfRetrieved();
 109   void detach();
 110 };
 111
 112 }
 113
 114 #include <folly/futures/Future.h>
 115 #include <folly/futures/Promise-inl.h>