boost-asiofutureboost-thread

asio use_future instead of yield[ec]


i want to make container of futures ,each future is void result of a task so that i could use wait_for_any on the container ,each task is coroutine which i currently implement using yield_context,and inside this coroutine there initiating function which returns ec and result where i use ec to analyze result.and then another coroutine is called passes same yield_context .
i want to know how to make this design.
and if i ll use use_future ,how can i pass error code to ec not throwing it unless there is no way except throwing it ,in this case i ll put try and catch around async initiating functions.
all these tasks will be posted ,spawned ... on asio io_service .
this is my main parts of code:
this is the spawn of task

boost::asio::spawn(GetServiceReference(), boost::bind(&HTTPRequest::Execute, boost::placeholders::_1, m_HttpClient_request_name, Get_mHTTPClient_Responses_Map()));

and this is the coroutine using yield_context

void HTTPRequest::Execute(boost::asio::yield_context yield_r, std::string request_name, std::map<std::string, boost::shared_ptr<HTTPResponse>>& mHTTPClient_Responses_Map)
{
    resolver_iterator iterator_connect = boost::asio::async_connect(mSock, iterator_resolve, yield_r[ec]);
}

and inside Execute we use ec to analyze

if (ec == boost::system::errc::errc_t::success){}

and here we start another coroutine passing same yield_context

SendRequest(yield_r);
}

i want to change this so i have container of futures for all spawned Execute,i do not care about results of Execute because i put them to member class Response.
But i need result in future so that i can use wait_any on the container .


Solution

  • If you can change your implementation, use the async_result pattern.

    This makes it so you can use your method with any of the approaches (completion handler, yield context or use_future).

    I reproduce the self-contained example from here for inspiration:

    Comprehensive Demo

    Showing how to use it with with

    Live On Coliru

    #define BOOST_COROUTINES_NO_DEPRECATION_WARNING 
    #include <iostream>
    #include <boost/asio.hpp>
    #include <boost/asio/spawn.hpp>
    #include <boost/asio/use_future.hpp>
    
    using boost::system::error_code;
    namespace asio = boost::asio;
    
    template <typename Token>
    auto async_meaning_of_life(bool success, Token&& token)
    {
    #if BOOST_VERSION >= 106600
        using result_type = typename asio::async_result<std::decay_t<Token>, void(error_code, int)>;
        typename result_type::completion_handler_type handler(std::forward<Token>(token));
    
        result_type result(handler);
    #else
        typename asio::handler_type<Token, void(error_code, int)>::type
                     handler(std::forward<Token>(token));
    
        asio::async_result<decltype (handler)> result (handler);
    #endif
    
        if (success)
            handler(error_code{}, 42);
        else
            handler(asio::error::operation_aborted, 0);
    
        return result.get ();
    }
    
    void using_yield_ec(asio::yield_context yield) {
        for (bool success : { true, false }) {
            boost::system::error_code ec;
            auto answer = async_meaning_of_life(success, yield[ec]);
            std::cout << __FUNCTION__ << ": Result: " << ec.message() << "\n";
            std::cout << __FUNCTION__ << ": Answer: " << answer << "\n";
        }
    }
    
    void using_yield_catch(asio::yield_context yield) {
        for (bool success : { true, false }) 
        try {
            auto answer = async_meaning_of_life(success, yield);
            std::cout << __FUNCTION__ << ": Answer: " << answer << "\n";
        } catch(boost::system::system_error const& e) {
            std::cout << __FUNCTION__ << ": Caught: " << e.code().message() << "\n";
        }
    }
    
    void using_future() {
        for (bool success : { true, false }) 
        try {
            auto answer = async_meaning_of_life(success, asio::use_future);
            std::cout << __FUNCTION__ << ": Answer: " << answer.get() << "\n";
        } catch(boost::system::system_error const& e) {
            std::cout << __FUNCTION__ << ": Caught: " << e.code().message() << "\n";
        }
    }
    
    void using_handler() {
        for (bool success : { true, false })
            async_meaning_of_life(success, [](error_code ec, int answer) {
                std::cout << "using_handler: Result: " << ec.message() << "\n";
                std::cout << "using_handler: Answer: " << answer << "\n";
            });
    }
    
    int main() {
        asio::io_service svc;
    
        spawn(svc, using_yield_ec);
        spawn(svc, using_yield_catch);
        std::thread work([] {
                using_future();
                using_handler();
            });
    
        svc.run();
        work.join();
    }
    

    Prints:

    using_yield_ec: Result: Success
    using_yield_ec: Answer: 42
    using_yield_ec: Result: Operation canceled
    using_yield_ec: Answer: 0
    using_future: Answer: 42
    using_yield_catch: Answer: 42
    using_yield_catch: Caught: Operation canceled
    using_future: Caught: Operation canceled
    using_handler: Result: Success
    using_handler: Answer: 42
    using_handler: Result: Operation canceled
    using_handler: Answer: 0
    

    Note: for simplicity I have not added output synchronization, so the output can become intermingled depending on runtime execution order