template <typename ReturnType, typename... Args>class Function
Defined at line 36 of file ../../sdk/lib/async_patterns/cpp/function.h
An asynchronous |Function| that will always execute on the async dispatcher
associated with a |Receiver|. Invoking this function translates to posting a
task to the destination dispatcher. It will not block the caller.
The receiver may not necessarily receive the function call. The call will be
a no-op if:
- The |Receiver| object goes out of scope.
- The async dispatcher of the |Receiver| shuts down.
A function can be invoked many times, and distributed to many senders. It is
akin to a multi-producer, single-consumer, uni-directional channel. Calls
posted to the same |Receiver| will be processed in the order they are made,
regardless which |Function|s and |Callback|s they are made from.
Public Methods
auto operator() (Args... args)Schedules the call to be asynchronously run on the receiver's
dispatcher.
See |async_patterns::BindForSending| for detailed requirements on |args|.
This operator returns a pending call. You may either:
- Make a fire-and-forget call, by discarding the returned object, or
- Get a promise carrying the return value of the function by calling
`promise()` on the object, yielding a |fpromise::promise
<ReturnType
>|, or
- Call `Then()` on the object and pass a |Callback
<void
(ReturnType)>|
See |async_patterns::PendingCall| for details.
Example:
async_patterns::Function
<int
(std::string)> parse = ...;
// Ignore the returned integer.
parse(std::string("abc"));
// Get a promise that will resolve when the function is asynchronously
// executed on the receiver's async dispatcher.
fpromise::promise
<int
> promise = parse(std::string("abc")).promise();
Defined at line 64 of file ../../sdk/lib/async_patterns/cpp/function.h
auto ignore_result ()Returns a functor that performs the same actions as this |Function|, but returns
void, instead of potentially a promise object. This is useful when converting the
|Function| into a |fit::function
<void
(ReturnType)|.
Defined at line 75 of file ../../sdk/lib/async_patterns/cpp/function.h
Friends
template <typename Owner>class Receiver