Chris@50: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors Chris@50: // Licensed under the MIT License: Chris@50: // Chris@50: // Permission is hereby granted, free of charge, to any person obtaining a copy Chris@50: // of this software and associated documentation files (the "Software"), to deal Chris@50: // in the Software without restriction, including without limitation the rights Chris@50: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell Chris@50: // copies of the Software, and to permit persons to whom the Software is Chris@50: // furnished to do so, subject to the following conditions: Chris@50: // Chris@50: // The above copyright notice and this permission notice shall be included in Chris@50: // all copies or substantial portions of the Software. Chris@50: // Chris@50: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR Chris@50: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, Chris@50: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE Chris@50: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER Chris@50: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, Chris@50: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN Chris@50: // THE SOFTWARE. Chris@50: Chris@50: #ifndef KJ_ASYNC_H_ Chris@50: #define KJ_ASYNC_H_ Chris@50: Chris@50: #if defined(__GNUC__) && !KJ_HEADER_WARNINGS Chris@50: #pragma GCC system_header Chris@50: #endif Chris@50: Chris@50: #include "async-prelude.h" Chris@50: #include "exception.h" Chris@50: #include "refcount.h" Chris@50: Chris@50: namespace kj { Chris@50: Chris@50: class EventLoop; Chris@50: class WaitScope; Chris@50: Chris@50: template Chris@50: class Promise; Chris@50: template Chris@50: class ForkedPromise; Chris@50: template Chris@50: class PromiseFulfiller; Chris@50: template Chris@50: struct PromiseFulfillerPair; Chris@50: Chris@50: template Chris@50: using PromiseForResult = Promise<_::JoinPromises<_::ReturnType>>; Chris@50: // Evaluates to the type of Promise for the result of calling functor type Func with parameter type Chris@50: // T. If T is void, then the promise is for the result of calling Func with no arguments. If Chris@50: // Func itself returns a promise, the promises are joined, so you never get Promise>. Chris@50: Chris@50: // ======================================================================================= Chris@50: // Promises Chris@50: Chris@50: template Chris@50: class Promise: protected _::PromiseBase { Chris@50: // The basic primitive of asynchronous computation in KJ. Similar to "futures", but designed Chris@50: // specifically for event loop concurrency. Similar to E promises and JavaScript Promises/A. Chris@50: // Chris@50: // A Promise represents a promise to produce a value of type T some time in the future. Once Chris@50: // that value has been produced, the promise is "fulfilled". Alternatively, a promise can be Chris@50: // "broken", with an Exception describing what went wrong. You may implicitly convert a value of Chris@50: // type T to an already-fulfilled Promise. You may implicitly convert the constant Chris@50: // `kj::READY_NOW` to an already-fulfilled Promise. You may also implicitly convert a Chris@50: // `kj::Exception` to an already-broken promise of any type. Chris@50: // Chris@50: // Promises are linear types -- they are moveable but not copyable. If a Promise is destroyed Chris@50: // or goes out of scope (without being moved elsewhere), any ongoing asynchronous operations Chris@50: // meant to fulfill the promise will be canceled if possible. All methods of `Promise` (unless Chris@50: // otherwise noted) actually consume the promise in the sense of move semantics. (Arguably they Chris@50: // should be rvalue-qualified, but at the time this interface was created compilers didn't widely Chris@50: // support that yet and anyway it would be pretty ugly typing kj::mv(promise).whatever().) If Chris@50: // you want to use one Promise in two different places, you must fork it with `fork()`. Chris@50: // Chris@50: // To use the result of a Promise, you must call `then()` and supply a callback function to Chris@50: // call with the result. `then()` returns another promise, for the result of the callback. Chris@50: // Any time that this would result in Promise>, the promises are collapsed into a Chris@50: // simple Promise that first waits for the outer promise, then the inner. Example: Chris@50: // Chris@50: // // Open a remote file, read the content, and then count the Chris@50: // // number of lines of text. Chris@50: // // Note that none of the calls here block. `file`, `content` Chris@50: // // and `lineCount` are all initialized immediately before any Chris@50: // // asynchronous operations occur. The lambda callbacks are Chris@50: // // called later. Chris@50: // Promise> file = openFtp("ftp://host/foo/bar"); Chris@50: // Promise content = file.then( Chris@50: // [](Own file) -> Promise { Chris@50: // return file.readAll(); Chris@50: // }); Chris@50: // Promise lineCount = content.then( Chris@50: // [](String text) -> int { Chris@50: // uint count = 0; Chris@50: // for (char c: text) count += (c == '\n'); Chris@50: // return count; Chris@50: // }); Chris@50: // Chris@50: // For `then()` to work, the current thread must have an active `EventLoop`. Each callback Chris@50: // is scheduled to execute in that loop. Since `then()` schedules callbacks only on the current Chris@50: // thread's event loop, you do not need to worry about two callbacks running at the same time. Chris@50: // You will need to set up at least one `EventLoop` at the top level of your program before you Chris@50: // can use promises. Chris@50: // Chris@50: // To adapt a non-Promise-based asynchronous API to promises, use `newAdaptedPromise()`. Chris@50: // Chris@50: // Systems using promises should consider supporting the concept of "pipelining". Pipelining Chris@50: // means allowing a caller to start issuing method calls against a promised object before the Chris@50: // promise has actually been fulfilled. This is particularly useful if the promise is for a Chris@50: // remote object living across a network, as this can avoid round trips when chaining a series Chris@50: // of calls. It is suggested that any class T which supports pipelining implement a subclass of Chris@50: // Promise which adds "eventual send" methods -- methods which, when called, say "please Chris@50: // invoke the corresponding method on the promised value once it is available". These methods Chris@50: // should in turn return promises for the eventual results of said invocations. Cap'n Proto, Chris@50: // for example, implements the type `RemotePromise` which supports pipelining RPC requests -- see Chris@50: // `capnp/capability.h`. Chris@50: // Chris@50: // KJ Promises are based on E promises: Chris@50: // http://wiki.erights.org/wiki/Walnut/Distributed_Computing#Promises Chris@50: // Chris@50: // KJ Promises are also inspired in part by the evolving standards for JavaScript/ECMAScript Chris@50: // promises, which are themselves influenced by E promises: Chris@50: // http://promisesaplus.com/ Chris@50: // https://github.com/domenic/promises-unwrapping Chris@50: Chris@50: public: Chris@50: Promise(_::FixVoid value); Chris@50: // Construct an already-fulfilled Promise from a value of type T. For non-void promises, the Chris@50: // parameter type is simply T. So, e.g., in a function that returns `Promise`, you can Chris@50: // say `return 123;` to return a promise that is already fulfilled to 123. Chris@50: // Chris@50: // For void promises, use `kj::READY_NOW` as the value, e.g. `return kj::READY_NOW`. Chris@50: Chris@50: Promise(kj::Exception&& e); Chris@50: // Construct an already-broken Promise. Chris@50: Chris@50: inline Promise(decltype(nullptr)) {} Chris@50: Chris@50: template Chris@50: PromiseForResult then(Func&& func, ErrorFunc&& errorHandler = _::PropagateException()) Chris@50: KJ_WARN_UNUSED_RESULT; Chris@50: // Register a continuation function to be executed when the promise completes. The continuation Chris@50: // (`func`) takes the promised value (an rvalue of type `T`) as its parameter. The continuation Chris@50: // may return a new value; `then()` itself returns a promise for the continuation's eventual Chris@50: // result. If the continuation itself returns a `Promise`, then `then()` shall also return Chris@50: // a `Promise` which first waits for the original promise, then executes the continuation, Chris@50: // then waits for the inner promise (i.e. it automatically "unwraps" the promise). Chris@50: // Chris@50: // In all cases, `then()` returns immediately. The continuation is executed later. The Chris@50: // continuation is always executed on the same EventLoop (and, therefore, the same thread) which Chris@50: // called `then()`, therefore no synchronization is necessary on state shared by the continuation Chris@50: // and the surrounding scope. If no EventLoop is running on the current thread, `then()` throws Chris@50: // an exception. Chris@50: // Chris@50: // You may also specify an error handler continuation as the second parameter. `errorHandler` Chris@50: // must be a functor taking a parameter of type `kj::Exception&&`. It must return the same Chris@50: // type as `func` returns (except when `func` returns `Promise`, in which case `errorHandler` Chris@50: // may return either `Promise` or just `U`). The default error handler simply propagates the Chris@50: // exception to the returned promise. Chris@50: // Chris@50: // Either `func` or `errorHandler` may, of course, throw an exception, in which case the promise Chris@50: // is broken. When compiled with -fno-exceptions, the framework will still detect when a Chris@50: // recoverable exception was thrown inside of a continuation and will consider the promise Chris@50: // broken even though a (presumably garbage) result was returned. Chris@50: // Chris@50: // If the returned promise is destroyed before the callback runs, the callback will be canceled Chris@50: // (it will never run). Chris@50: // Chris@50: // Note that `then()` -- like all other Promise methods -- consumes the promise on which it is Chris@50: // called, in the sense of move semantics. After returning, the original promise is no longer Chris@50: // valid, but `then()` returns a new promise. Chris@50: // Chris@50: // *Advanced implementation tips:* Most users will never need to worry about the below, but Chris@50: // it is good to be aware of. Chris@50: // Chris@50: // As an optimization, if the callback function `func` does _not_ return another promise, then Chris@50: // execution of `func` itself may be delayed until its result is known to be needed. The Chris@50: // expectation here is that `func` is just doing some transformation on the results, not Chris@50: // scheduling any other actions, therefore the system doesn't need to be proactive about Chris@50: // evaluating it. This way, a chain of trivial then() transformations can be executed all at Chris@50: // once without repeatedly re-scheduling through the event loop. Use the `eagerlyEvaluate()` Chris@50: // method to suppress this behavior. Chris@50: // Chris@50: // On the other hand, if `func` _does_ return another promise, then the system evaluates `func` Chris@50: // as soon as possible, because the promise it returns might be for a newly-scheduled Chris@50: // long-running asynchronous task. Chris@50: // Chris@50: // As another optimization, when a callback function registered with `then()` is actually Chris@50: // scheduled, it is scheduled to occur immediately, preempting other work in the event queue. Chris@50: // This allows a long chain of `then`s to execute all at once, improving cache locality by Chris@50: // clustering operations on the same data. However, this implies that starvation can occur Chris@50: // if a chain of `then()`s takes a very long time to execute without ever stopping to wait for Chris@50: // actual I/O. To solve this, use `kj::evalLater()` to yield control; this way, all other events Chris@50: // in the queue will get a chance to run before your callback is executed. Chris@50: Chris@50: Promise ignoreResult() KJ_WARN_UNUSED_RESULT { return then([](T&&) {}); } Chris@50: // Convenience method to convert the promise to a void promise by ignoring the return value. Chris@50: // Chris@50: // You must still wait on the returned promise if you want the task to execute. Chris@50: Chris@50: template Chris@50: Promise catch_(ErrorFunc&& errorHandler) KJ_WARN_UNUSED_RESULT; Chris@50: // Equivalent to `.then(identityFunc, errorHandler)`, where `identifyFunc` is a function that Chris@50: // just returns its input. Chris@50: Chris@50: T wait(WaitScope& waitScope); Chris@50: // Run the event loop until the promise is fulfilled, then return its result. If the promise Chris@50: // is rejected, throw an exception. Chris@50: // Chris@50: // wait() is primarily useful at the top level of a program -- typically, within the function Chris@50: // that allocated the EventLoop. For example, a program that performs one or two RPCs and then Chris@50: // exits would likely use wait() in its main() function to wait on each RPC. On the other hand, Chris@50: // server-side code generally cannot use wait(), because it has to be able to accept multiple Chris@50: // requests at once. Chris@50: // Chris@50: // If the promise is rejected, `wait()` throws an exception. If the program was compiled without Chris@50: // exceptions (-fno-exceptions), this will usually abort. In this case you really should first Chris@50: // use `then()` to set an appropriate handler for the exception case, so that the promise you Chris@50: // actually wait on never throws. Chris@50: // Chris@50: // `waitScope` is an object proving that the caller is in a scope where wait() is allowed. By Chris@50: // convention, any function which might call wait(), or which might call another function which Chris@50: // might call wait(), must take `WaitScope&` as one of its parameters. This is needed for two Chris@50: // reasons: Chris@50: // * `wait()` is not allowed during an event callback, because event callbacks are themselves Chris@50: // called during some other `wait()`, and such recursive `wait()`s would only be able to Chris@50: // complete in LIFO order, which might mean that the outer `wait()` ends up waiting longer Chris@50: // than it is supposed to. To prevent this, a `WaitScope` cannot be constructed or used during Chris@50: // an event callback. Chris@50: // * Since `wait()` runs the event loop, unrelated event callbacks may execute before `wait()` Chris@50: // returns. This means that anyone calling `wait()` must be reentrant -- state may change Chris@50: // around them in arbitrary ways. Therefore, callers really need to know if a function they Chris@50: // are calling might wait(), and the `WaitScope&` parameter makes this clear. Chris@50: // Chris@50: // TODO(someday): Implement fibers, and let them call wait() even when they are handling an Chris@50: // event. Chris@50: Chris@50: ForkedPromise fork() KJ_WARN_UNUSED_RESULT; Chris@50: // Forks the promise, so that multiple different clients can independently wait on the result. Chris@50: // `T` must be copy-constructable for this to work. Or, in the special case where `T` is Chris@50: // `Own`, `U` must have a method `Own addRef()` which returns a new reference to the same Chris@50: // (or an equivalent) object (probably implemented via reference counting). Chris@50: Chris@50: _::SplitTuplePromise split(); Chris@50: // Split a promise for a tuple into a tuple of promises. Chris@50: // Chris@50: // E.g. if you have `Promise>`, `split()` returns Chris@50: // `kj::Tuple, Promise>`. Chris@50: Chris@50: Promise exclusiveJoin(Promise&& other) KJ_WARN_UNUSED_RESULT; Chris@50: // Return a new promise that resolves when either the original promise resolves or `other` Chris@50: // resolves (whichever comes first). The promise that didn't resolve first is canceled. Chris@50: Chris@50: // TODO(someday): inclusiveJoin(), or perhaps just join(), which waits for both completions Chris@50: // and produces a tuple? Chris@50: Chris@50: template Chris@50: Promise attach(Attachments&&... attachments) KJ_WARN_UNUSED_RESULT; Chris@50: // "Attaches" one or more movable objects (often, Owns) to the promise, such that they will Chris@50: // be destroyed when the promise resolves. This is useful when a promise's callback contains Chris@50: // pointers into some object and you want to make sure the object still exists when the callback Chris@50: // runs -- after calling then(), use attach() to add necessary objects to the result. Chris@50: Chris@50: template Chris@50: Promise eagerlyEvaluate(ErrorFunc&& errorHandler) KJ_WARN_UNUSED_RESULT; Chris@50: Promise eagerlyEvaluate(decltype(nullptr)) KJ_WARN_UNUSED_RESULT; Chris@50: // Force eager evaluation of this promise. Use this if you are going to hold on to the promise Chris@50: // for awhile without consuming the result, but you want to make sure that the system actually Chris@50: // processes it. Chris@50: // Chris@50: // `errorHandler` is a function that takes `kj::Exception&&`, like the second parameter to Chris@50: // `then()`, except that it must return void. We make you specify this because otherwise it's Chris@50: // easy to forget to handle errors in a promise that you never use. You may specify nullptr for Chris@50: // the error handler if you are sure that ignoring errors is fine, or if you know that you'll Chris@50: // eventually wait on the promise somewhere. Chris@50: Chris@50: template Chris@50: void detach(ErrorFunc&& errorHandler); Chris@50: // Allows the promise to continue running in the background until it completes or the Chris@50: // `EventLoop` is destroyed. Be careful when using this: since you can no longer cancel this Chris@50: // promise, you need to make sure that the promise owns all the objects it touches or make sure Chris@50: // those objects outlive the EventLoop. Chris@50: // Chris@50: // `errorHandler` is a function that takes `kj::Exception&&`, like the second parameter to Chris@50: // `then()`, except that it must return void. Chris@50: // Chris@50: // This function exists mainly to implement the Cap'n Proto requirement that RPC calls cannot be Chris@50: // canceled unless the callee explicitly permits it. Chris@50: Chris@50: kj::String trace(); Chris@50: // Returns a dump of debug info about this promise. Not for production use. Requires RTTI. Chris@50: // This method does NOT consume the promise as other methods do. Chris@50: Chris@50: private: Chris@50: Promise(bool, Own<_::PromiseNode>&& node): PromiseBase(kj::mv(node)) {} Chris@50: // Second parameter prevent ambiguity with immediate-value constructor. Chris@50: Chris@50: template Chris@50: friend class Promise; Chris@50: friend class EventLoop; Chris@50: template Chris@50: friend Promise newAdaptedPromise(Params&&... adapterConstructorParams); Chris@50: template Chris@50: friend PromiseFulfillerPair newPromiseAndFulfiller(); Chris@50: template Chris@50: friend class _::ForkHub; Chris@50: friend class _::TaskSetImpl; Chris@50: friend Promise _::yield(); Chris@50: friend class _::NeverDone; Chris@50: template Chris@50: friend Promise> joinPromises(Array>&& promises); Chris@50: friend Promise joinPromises(Array>&& promises); Chris@50: }; Chris@50: Chris@50: template Chris@50: class ForkedPromise { Chris@50: // The result of `Promise::fork()` and `EventLoop::fork()`. Allows branches to be created. Chris@50: // Like `Promise`, this is a pass-by-move type. Chris@50: Chris@50: public: Chris@50: inline ForkedPromise(decltype(nullptr)) {} Chris@50: Chris@50: Promise addBranch(); Chris@50: // Add a new branch to the fork. The branch is equivalent to the original promise. Chris@50: Chris@50: private: Chris@50: Own<_::ForkHub<_::FixVoid>> hub; Chris@50: Chris@50: inline ForkedPromise(bool, Own<_::ForkHub<_::FixVoid>>&& hub): hub(kj::mv(hub)) {} Chris@50: Chris@50: friend class Promise; Chris@50: friend class EventLoop; Chris@50: }; Chris@50: Chris@50: constexpr _::Void READY_NOW = _::Void(); Chris@50: // Use this when you need a Promise that is already fulfilled -- this value can be implicitly Chris@50: // cast to `Promise`. Chris@50: Chris@50: constexpr _::NeverDone NEVER_DONE = _::NeverDone(); Chris@50: // The opposite of `READY_NOW`, return this when the promise should never resolve. This can be Chris@50: // implicitly converted to any promise type. You may also call `NEVER_DONE.wait()` to wait Chris@50: // forever (useful for servers). Chris@50: Chris@50: template Chris@50: PromiseForResult evalLater(Func&& func) KJ_WARN_UNUSED_RESULT; Chris@50: // Schedule for the given zero-parameter function to be executed in the event loop at some Chris@50: // point in the near future. Returns a Promise for its result -- or, if `func()` itself returns Chris@50: // a promise, `evalLater()` returns a Promise for the result of resolving that promise. Chris@50: // Chris@50: // Example usage: Chris@50: // Promise x = evalLater([]() { return 123; }); Chris@50: // Chris@50: // The above is exactly equivalent to: Chris@50: // Promise x = Promise(READY_NOW).then([]() { return 123; }); Chris@50: // Chris@50: // If the returned promise is destroyed before the callback runs, the callback will be canceled Chris@50: // (never called). Chris@50: // Chris@50: // If you schedule several evaluations with `evalLater` during the same callback, they are Chris@50: // guaranteed to be executed in order. Chris@50: Chris@50: template Chris@50: PromiseForResult evalNow(Func&& func) KJ_WARN_UNUSED_RESULT; Chris@50: // Run `func()` and return a promise for its result. `func()` executes before `evalNow()` returns. Chris@50: // If `func()` throws an exception, the exception is caught and wrapped in a promise -- this is the Chris@50: // main reason why `evalNow()` is useful. Chris@50: Chris@50: template Chris@50: Promise> joinPromises(Array>&& promises); Chris@50: // Join an array of promises into a promise for an array. Chris@50: Chris@50: // ======================================================================================= Chris@50: // Hack for creating a lambda that holds an owned pointer. Chris@50: Chris@50: template Chris@50: class CaptureByMove { Chris@50: public: Chris@50: inline CaptureByMove(Func&& func, MovedParam&& param) Chris@50: : func(kj::mv(func)), param(kj::mv(param)) {} Chris@50: Chris@50: template Chris@50: inline auto operator()(Params&&... params) Chris@50: -> decltype(kj::instance()(kj::instance(), kj::fwd(params)...)) { Chris@50: return func(kj::mv(param), kj::fwd(params)...); Chris@50: } Chris@50: Chris@50: private: Chris@50: Func func; Chris@50: MovedParam param; Chris@50: }; Chris@50: Chris@50: template Chris@50: inline CaptureByMove> mvCapture(MovedParam&& param, Func&& func) { Chris@50: // Hack to create a "lambda" which captures a variable by moving it rather than copying or Chris@50: // referencing. C++14 generalized captures should make this obsolete, but for now in C++11 this Chris@50: // is commonly needed for Promise continuations that own their state. Example usage: Chris@50: // Chris@50: // Own ptr = makeFoo(); Chris@50: // Promise promise = callRpc(); Chris@50: // promise.then(mvCapture(ptr, [](Own&& ptr, int result) { Chris@50: // return ptr->finish(result); Chris@50: // })); Chris@50: Chris@50: return CaptureByMove>(kj::fwd(func), kj::mv(param)); Chris@50: } Chris@50: Chris@50: // ======================================================================================= Chris@50: // Advanced promise construction Chris@50: Chris@50: template Chris@50: class PromiseFulfiller { Chris@50: // A callback which can be used to fulfill a promise. Only the first call to fulfill() or Chris@50: // reject() matters; subsequent calls are ignored. Chris@50: Chris@50: public: Chris@50: virtual void fulfill(T&& value) = 0; Chris@50: // Fulfill the promise with the given value. Chris@50: Chris@50: virtual void reject(Exception&& exception) = 0; Chris@50: // Reject the promise with an error. Chris@50: Chris@50: virtual bool isWaiting() = 0; Chris@50: // Returns true if the promise is still unfulfilled and someone is potentially waiting for it. Chris@50: // Returns false if fulfill()/reject() has already been called *or* if the promise to be Chris@50: // fulfilled has been discarded and therefore the result will never be used anyway. Chris@50: Chris@50: template Chris@50: bool rejectIfThrows(Func&& func); Chris@50: // Call the function (with no arguments) and return true. If an exception is thrown, call Chris@50: // `fulfiller.reject()` and then return false. When compiled with exceptions disabled, Chris@50: // non-fatal exceptions are still detected and handled correctly. Chris@50: }; Chris@50: Chris@50: template <> Chris@50: class PromiseFulfiller { Chris@50: // Specialization of PromiseFulfiller for void promises. See PromiseFulfiller. Chris@50: Chris@50: public: Chris@50: virtual void fulfill(_::Void&& value = _::Void()) = 0; Chris@50: // Call with zero parameters. The parameter is a dummy that only exists so that subclasses don't Chris@50: // have to specialize for . Chris@50: Chris@50: virtual void reject(Exception&& exception) = 0; Chris@50: virtual bool isWaiting() = 0; Chris@50: Chris@50: template Chris@50: bool rejectIfThrows(Func&& func); Chris@50: }; Chris@50: Chris@50: template Chris@50: Promise newAdaptedPromise(Params&&... adapterConstructorParams); Chris@50: // Creates a new promise which owns an instance of `Adapter` which encapsulates the operation Chris@50: // that will eventually fulfill the promise. This is primarily useful for adapting non-KJ Chris@50: // asynchronous APIs to use promises. Chris@50: // Chris@50: // An instance of `Adapter` will be allocated and owned by the returned `Promise`. A Chris@50: // `PromiseFulfiller&` will be passed as the first parameter to the adapter's constructor, Chris@50: // and `adapterConstructorParams` will be forwarded as the subsequent parameters. The adapter Chris@50: // is expected to perform some asynchronous operation and call the `PromiseFulfiller` once Chris@50: // it is finished. Chris@50: // Chris@50: // The adapter is destroyed when its owning Promise is destroyed. This may occur before the Chris@50: // Promise has been fulfilled. In this case, the adapter's destructor should cancel the Chris@50: // asynchronous operation. Once the adapter is destroyed, the fulfillment callback cannot be Chris@50: // called. Chris@50: // Chris@50: // An adapter implementation should be carefully written to ensure that it cannot accidentally Chris@50: // be left unfulfilled permanently because of an exception. Consider making liberal use of Chris@50: // `PromiseFulfiller::rejectIfThrows()`. Chris@50: Chris@50: template Chris@50: struct PromiseFulfillerPair { Chris@50: Promise<_::JoinPromises> promise; Chris@50: Own> fulfiller; Chris@50: }; Chris@50: Chris@50: template Chris@50: PromiseFulfillerPair newPromiseAndFulfiller(); Chris@50: // Construct a Promise and a separate PromiseFulfiller which can be used to fulfill the promise. Chris@50: // If the PromiseFulfiller is destroyed before either of its methods are called, the Promise is Chris@50: // implicitly rejected. Chris@50: // Chris@50: // Although this function is easier to use than `newAdaptedPromise()`, it has the serious drawback Chris@50: // that there is no way to handle cancellation (i.e. detect when the Promise is discarded). Chris@50: // Chris@50: // You can arrange to fulfill a promise with another promise by using a promise type for T. E.g. Chris@50: // `newPromiseAndFulfiller>()` will produce a promise of type `Promise` but the Chris@50: // fulfiller will be of type `PromiseFulfiller>`. Thus you pass a `Promise` to the Chris@50: // `fulfill()` callback, and the promises are chained. Chris@50: Chris@50: // ======================================================================================= Chris@50: // TaskSet Chris@50: Chris@50: class TaskSet { Chris@50: // Holds a collection of Promises and ensures that each executes to completion. Memory Chris@50: // associated with each promise is automatically freed when the promise completes. Destroying Chris@50: // the TaskSet itself automatically cancels all unfinished promises. Chris@50: // Chris@50: // This is useful for "daemon" objects that perform background tasks which aren't intended to Chris@50: // fulfill any particular external promise, but which may need to be canceled (and thus can't Chris@50: // use `Promise::detach()`). The daemon object holds a TaskSet to collect these tasks it is Chris@50: // working on. This way, if the daemon itself is destroyed, the TaskSet is detroyed as well, Chris@50: // and everything the daemon is doing is canceled. Chris@50: Chris@50: public: Chris@50: class ErrorHandler { Chris@50: public: Chris@50: virtual void taskFailed(kj::Exception&& exception) = 0; Chris@50: }; Chris@50: Chris@50: TaskSet(ErrorHandler& errorHandler); Chris@50: // `loop` will be used to wait on promises. `errorHandler` will be executed any time a task Chris@50: // throws an exception, and will execute within the given EventLoop. Chris@50: Chris@50: ~TaskSet() noexcept(false); Chris@50: Chris@50: void add(Promise&& promise); Chris@50: Chris@50: kj::String trace(); Chris@50: // Return debug info about all promises currently in the TaskSet. Chris@50: Chris@50: private: Chris@50: Own<_::TaskSetImpl> impl; Chris@50: }; Chris@50: Chris@50: // ======================================================================================= Chris@50: // The EventLoop class Chris@50: Chris@50: class EventPort { Chris@50: // Interfaces between an `EventLoop` and events originating from outside of the loop's thread. Chris@50: // All such events come in through the `EventPort` implementation. Chris@50: // Chris@50: // An `EventPort` implementation may interface with low-level operating system APIs and/or other Chris@50: // threads. You can also write an `EventPort` which wraps some other (non-KJ) event loop Chris@50: // framework, allowing the two to coexist in a single thread. Chris@50: Chris@50: public: Chris@50: virtual bool wait() = 0; Chris@50: // Wait for an external event to arrive, sleeping if necessary. Once at least one event has Chris@50: // arrived, queue it to the event loop (e.g. by fulfilling a promise) and return. Chris@50: // Chris@50: // This is called during `Promise::wait()` whenever the event queue becomes empty, in order to Chris@50: // wait for new events to populate the queue. Chris@50: // Chris@50: // It is safe to return even if nothing has actually been queued, so long as calling `wait()` in Chris@50: // a loop will eventually sleep. (That is to say, false positives are fine.) Chris@50: // Chris@50: // Returns true if wake() has been called from another thread. (Precisely, returns true if Chris@50: // no previous call to wait `wait()` nor `poll()` has returned true since `wake()` was last Chris@50: // called.) Chris@50: Chris@50: virtual bool poll() = 0; Chris@50: // Check if any external events have arrived, but do not sleep. If any events have arrived, Chris@50: // add them to the event queue (e.g. by fulfilling promises) before returning. Chris@50: // Chris@50: // This may be called during `Promise::wait()` when the EventLoop has been executing for a while Chris@50: // without a break but is still non-empty. Chris@50: // Chris@50: // Returns true if wake() has been called from another thread. (Precisely, returns true if Chris@50: // no previous call to wait `wait()` nor `poll()` has returned true since `wake()` was last Chris@50: // called.) Chris@50: Chris@50: virtual void setRunnable(bool runnable); Chris@50: // Called to notify the `EventPort` when the `EventLoop` has work to do; specifically when it Chris@50: // transitions from empty -> runnable or runnable -> empty. This is typically useful when Chris@50: // integrating with an external event loop; if the loop is currently runnable then you should Chris@50: // arrange to call run() on it soon. The default implementation does nothing. Chris@50: Chris@50: virtual void wake() const; Chris@50: // Wake up the EventPort's thread from another thread. Chris@50: // Chris@50: // Unlike all other methods on this interface, `wake()` may be called from another thread, hence Chris@50: // it is `const`. Chris@50: // Chris@50: // Technically speaking, `wake()` causes the target thread to cease sleeping and not to sleep Chris@50: // again until `wait()` or `poll()` has returned true at least once. Chris@50: // Chris@50: // The default implementation throws an UNIMPLEMENTED exception. Chris@50: }; Chris@50: Chris@50: class EventLoop { Chris@50: // Represents a queue of events being executed in a loop. Most code won't interact with Chris@50: // EventLoop directly, but instead use `Promise`s to interact with it indirectly. See the Chris@50: // documentation for `Promise`. Chris@50: // Chris@50: // Each thread can have at most one current EventLoop. To make an `EventLoop` current for Chris@50: // the thread, create a `WaitScope`. Async APIs require that the thread has a current EventLoop, Chris@50: // or they will throw exceptions. APIs that use `Promise::wait()` additionally must explicitly Chris@50: // be passed a reference to the `WaitScope` to make the caller aware that they might block. Chris@50: // Chris@50: // Generally, you will want to construct an `EventLoop` at the top level of your program, e.g. Chris@50: // in the main() function, or in the start function of a thread. You can then use it to Chris@50: // construct some promises and wait on the result. Example: Chris@50: // Chris@50: // int main() { Chris@50: // // `loop` becomes the official EventLoop for the thread. Chris@50: // MyEventPort eventPort; Chris@50: // EventLoop loop(eventPort); Chris@50: // Chris@50: // // Now we can call an async function. Chris@50: // Promise textPromise = getHttp("http://example.com"); Chris@50: // Chris@50: // // And we can wait for the promise to complete. Note that you can only use `wait()` Chris@50: // // from the top level, not from inside a promise callback. Chris@50: // String text = textPromise.wait(); Chris@50: // print(text); Chris@50: // return 0; Chris@50: // } Chris@50: // Chris@50: // Most applications that do I/O will prefer to use `setupAsyncIo()` from `async-io.h` rather Chris@50: // than allocate an `EventLoop` directly. Chris@50: Chris@50: public: Chris@50: EventLoop(); Chris@50: // Construct an `EventLoop` which does not receive external events at all. Chris@50: Chris@50: explicit EventLoop(EventPort& port); Chris@50: // Construct an `EventLoop` which receives external events through the given `EventPort`. Chris@50: Chris@50: ~EventLoop() noexcept(false); Chris@50: Chris@50: void run(uint maxTurnCount = maxValue); Chris@50: // Run the event loop for `maxTurnCount` turns or until there is nothing left to be done, Chris@50: // whichever comes first. This never calls the `EventPort`'s `sleep()` or `poll()`. It will Chris@50: // call the `EventPort`'s `setRunnable(false)` if the queue becomes empty. Chris@50: Chris@50: bool isRunnable(); Chris@50: // Returns true if run() would currently do anything, or false if the queue is empty. Chris@50: Chris@50: private: Chris@50: EventPort& port; Chris@50: Chris@50: bool running = false; Chris@50: // True while looping -- wait() is then not allowed. Chris@50: Chris@50: bool lastRunnableState = false; Chris@50: // What did we last pass to port.setRunnable()? Chris@50: Chris@50: _::Event* head = nullptr; Chris@50: _::Event** tail = &head; Chris@50: _::Event** depthFirstInsertPoint = &head; Chris@50: Chris@50: Own<_::TaskSetImpl> daemons; Chris@50: Chris@50: bool turn(); Chris@50: void setRunnable(bool runnable); Chris@50: void enterScope(); Chris@50: void leaveScope(); Chris@50: Chris@50: friend void _::detach(kj::Promise&& promise); Chris@50: friend void _::waitImpl(Own<_::PromiseNode>&& node, _::ExceptionOrValue& result, Chris@50: WaitScope& waitScope); Chris@50: friend class _::Event; Chris@50: friend class WaitScope; Chris@50: }; Chris@50: Chris@50: class WaitScope { Chris@50: // Represents a scope in which asynchronous programming can occur. A `WaitScope` should usually Chris@50: // be allocated on the stack and serves two purposes: Chris@50: // * While the `WaitScope` exists, its `EventLoop` is registered as the current loop for the Chris@50: // thread. Most operations dealing with `Promise` (including all of its methods) do not work Chris@50: // unless the thread has a current `EventLoop`. Chris@50: // * `WaitScope` may be passed to `Promise::wait()` to synchronously wait for a particular Chris@50: // promise to complete. See `Promise::wait()` for an extended discussion. Chris@50: Chris@50: public: Chris@50: inline explicit WaitScope(EventLoop& loop): loop(loop) { loop.enterScope(); } Chris@50: inline ~WaitScope() { loop.leaveScope(); } Chris@50: KJ_DISALLOW_COPY(WaitScope); Chris@50: Chris@50: private: Chris@50: EventLoop& loop; Chris@50: friend class EventLoop; Chris@50: friend void _::waitImpl(Own<_::PromiseNode>&& node, _::ExceptionOrValue& result, Chris@50: WaitScope& waitScope); Chris@50: }; Chris@50: Chris@50: } // namespace kj Chris@50: Chris@50: #include "async-inl.h" Chris@50: Chris@50: #endif // KJ_ASYNC_H_