English

Echo __example__

English

This example develops an initiating function called [*echo]. The operation will read up to the first newline on a stream, and then write the same line including the newline back on the stream. First we define the input parameters and results, then declare our initiation function. For our echo operation the only inputs are the stream and the completion token. The output is the error code which is usually included in all completion handler signatures.

English

Now that we have a declaration, we will define the body of the function. We want to achieve the following goals: perform static type checking on the input parameters, set up the return value as per __N3747__, and launch the composed operation by constructing an intermediate, stateful completion handler and invoking it.

English

The initiating function contains a few relatively simple parts. There is the customization of the return value type, static type checking, building the return value type using the helper, and creating and launching the `echo_op` composed operation object.

English

The implementation strategy is to make the composed object meet the requirements of a completion handler by being movable, and by making it invocable so it can be used as a continuation for the asynchronous operations it launches. Rather than using `std::bind` or `boost::bind`, which destroys the type information and therefore breaks the associators, we will simply pass `std::move(*this)` as the completion handler parameter for any operations that we initiate. For the move to work correctly, care must be taken to ensure that no access to data members are made after the move takes place. Here is the complete implementation of our composed operation:

English

There are some common mistakes that should be avoided when writing composed operations:

English

* Type erasing the final handler. This will cause undefined behavior.

English

* Forgetting to include a return statement after calling an

English

* Calling a synchronous function by accident. In general composed

English

* Forgetting to provide `executor_type` and `get_executor` for the

English

* Forgetting to create an object of type __executor_work_guard__ with the

English

* For operations which complete immediately (i.e. without calling an

English

The listing for a complete, runnable version of this example is in [path_link example/echo-op/echo_op.cpp echo_op.cpp].