如何在Boost Asio上组合strand包装器和优先级包装器

Question

我想在同一时间内使用Boost.Asio的链和优先包装。

在编写代码之前，我已阅读以下信息：

Boost asio priority and strand

boost::asio and Active Object

http://thread.gmane.org/gmane.comp.lib.boost.asio.user/3531

Why do I need strand per connection when using boost::asio?

我想使用包装器方法，因为我想使用各种异步API，例如async_read，async_write和async_connect。 根据{{​​3}}，似乎可以组合优先级包装器和链包装器。

所以我根据以下示例编写了代码：

http://thread.gmane.org/gmane.comp.lib.boost.asio.user/3531

这是我的代码：

#include <iostream>
#include <functional>
#include <queue>
#include <vector>
#include <thread>
#include <mutex>

#include <boost/asio.hpp>
#include <boost/optional.hpp>

#define ENABLE_STRAND 1
#define ENABLE_PRIORITY 1

class handler_priority_queue {
public:
    template <typename Handler>
    void add(int priority, Handler&& handler) {
        std::cout << "add(" << priority << ")" << std::endl;
        std::lock_guard<std::mutex> g(mtx_);
        handlers_.emplace(priority, std::forward<Handler>(handler));
    }

    void execute_all() {
        auto top = [&]() -> boost::optional<queued_handler> {
            std::lock_guard<std::mutex> g(mtx_);
            if (handlers_.empty()) return boost::none;
            boost::optional<queued_handler> opt = handlers_.top();
            handlers_.pop();
            return opt;
        };
        while (auto h_opt = top()) {
            h_opt.get().execute();
        }
    }

    template <typename Handler>
    class wrapped_handler {
    public:
        wrapped_handler(handler_priority_queue& q, int p, Handler h)
            : queue_(q), priority_(p), handler_(std::move(h))
        {
        }

        template <typename... Args>
        void operator()(Args&&... args) {
            std::cout << "operator() " << std::endl;
            handler_(std::forward<Args>(args)...);
        }

        //private:
        handler_priority_queue& queue_;
        int priority_;
        Handler handler_;
    };

    template <typename Handler>
    wrapped_handler<Handler> wrap(int priority, Handler&& handler) {
        return wrapped_handler<Handler>(*this, priority, std::forward<Handler>(handler));
    }

private:
    class queued_handler {
    public:
        template <typename Handler>
        queued_handler(int p, Handler&& handler)
            : priority_(p), function_(std::forward<Handler>(handler))
        {
            std::cout << "queued_handler()" << std::endl;
        }

        void execute() {
            std::cout << "execute(" << priority_ << ")" << std::endl;
            function_();
        }

        friend bool operator<(
            queued_handler const& lhs,
            queued_handler const & rhs) {
            return lhs.priority_ < rhs.priority_;
        }

    private:
        int priority_;
        std::function<void()> function_;
    };

    std::priority_queue<queued_handler> handlers_;
    std::mutex mtx_;
};

// Custom invocation hook for wrapped handlers.
template <typename Function, typename Handler>
void asio_handler_invoke(Function&& f,
                         handler_priority_queue::wrapped_handler<Handler>* h) {
    std::cout << "asio_handler_invoke " << std::endl;
    h->queue_.add(h->priority_, std::forward<Function>(f));
}

//----------------------------------------------------------------------

int main() {
    int const num_of_threads = 4;
    int const num_of_tasks = 5;

    boost::asio::io_service ios;
    boost::asio::strand strand(ios);


    handler_priority_queue pq;

    for (int i = 0; i != num_of_tasks; ++i) {
        ios.post(
#if ENABLE_STRAND
            strand.wrap(
#endif
#if ENABLE_PRIORITY
                pq.wrap(
                    i,
#endif
                    [=] {
                        std::cout << "[called] " << i << "," << std::this_thread::get_id() << std::endl;
                    }
#if ENABLE_PRIORITY
                )
#endif
#if ENABLE_STRAND
            )
#endif
        );
    }

    std::vector<std::thread> pool;
    for (int i = 0; i != num_of_threads; ++i) {
        pool.emplace_back([&]{
                std::cout << "before run_one()" << std::endl;
                while (ios.run_one()) {
                    std::cout << "before poll_one()" << std::endl;
                    while (ios.poll_one())
                        ;
                    std::cout << "before execute_all()" << std::endl;
                    pq.execute_all();
                }
            }
        );
    }
    for (auto& t : pool) t.join();
}

包装器由以下宏启用：

#define ENABLE_STRAND 1
#define ENABLE_PRIORITY 1

当两个宏都启用时，我得到以下结果：

before run_one()
asio_handler_invoke
add(0)
queued_handler()
before poll_one()
asio_handler_invoke
add(1)
queued_handler()
asio_handler_invoke
add(2)
queued_handler()
asio_handler_invoke
add(3)
queued_handler()
asio_handler_invoke
add(4)
queued_handler()
before execute_all()
execute(4)
execute(3)
execute(2)
execute(1)
execute(0)
before run_one()
before run_one()
before run_one()

我希望我得到

[called] priority,thread_id

输出为

[called] 1,140512649541376

但我没有得到它。

似乎在函数execute()中调用了function_()，但未调用wrapped_handler::operator()。 （函数execute()在我的代码中从pq.execute_all();调用。）

void execute() {
    std::cout << "execute(" << priority_ << ")" << std::endl;
    function_(); // It is called.
}

template <typename Handler>
class wrapped_handler {
public:

    template <typename... Args>
    void operator()(Args&&... args) { // It is NOT called
        std::cout << "operator() " << std::endl;
        handler_(std::forward<Args>(args)...);
    }

我在调用function_()后跟踪了序列。

调用以下函数：

http://www.boost.org/doc/libs/1_63_0/doc/html/boost_asio/example/cpp03/invocation/prioritised_handlers.cpp https://github.com/boostorg/asio/blob/boost-1.63.0/include/boost/asio/detail/wrapped_handler.hpp#L191 https://github.com/boostorg/asio/blob/boost-1.63.0/include/boost/asio/detail/wrapped_handler.hpp#L76 https://github.com/boostorg/asio/blob/boost-1.63.0/include/boost/asio/strand.hpp#L158 https://github.com/boostorg/asio/blob/boost-1.63.0/include/boost/asio/detail/impl/strand_service.hpp#L55

然后在函数bool strand_service::do_dispatch(implementation_type& impl, operation* op)中，不调用操作op，而是将其推入以下行的队列中：

https://github.com/boostorg/asio/blob/boost-1.63.0/include/boost/asio/detail/impl/strand_service.ipp#L94

我不确定为什么将function_()发送给strand_service。我认为我的代码中的链包装器已经在以下方面解开了：

template <typename Function, typename Handler>
void asio_handler_invoke(Function&& f,
                         handler_priority_queue::wrapped_handler<Handler>* h) {
    std::cout << "asio_handler_invoke " << std::endl;
    h->queue_.add(h->priority_, std::forward<Function>(f));
}

如果我只启用优先级包装器，我得到以下结果。 看起来像我预期的那样工作。

before run_one()
asio_handler_invoke
add(0)
queued_handler()
before poll_one()
asio_handler_invoke
add(1)
queued_handler()
asio_handler_invoke
add(2)
queued_handler()
asio_handler_invoke
add(3)
queued_handler()
asio_handler_invoke
add(4)
queued_handler()
before execute_all()
execute(4)
operator()
[called] 4,140512649541376
execute(3)
operator()
[called] 3,140512649541376
execute(2)
operator()
[called] 2,140512649541376
execute(1)
operator()
[called] 1,140512649541376
execute(0)
operator()
[called] 0,140512649541376
before run_one()
before run_one()
before run_one()

如果我只启用了stra包装器，我得到了以下结果。 似乎按我的预期工作。

before run_one()
[called] 0,140127385941760
before poll_one()
[called] 1,140127385941760
[called] 2,140127385941760
[called] 3,140127385941760
[called] 4,140127385941760
before execute_all()
before run_one()
before run_one()
before run_one()

有什么想法吗？

Answer 1

我解决了这个问题。

  

我不确定为什么将function_（）分派给strand_service。我认为我的代码中的链包装器已经在以下方面解开了：

template <typename Function, typename Handler>
void asio_handler_invoke(Function&& f,
                         handler_priority_queue::wrapped_handler<Handler>* h) {
    std::cout << "asio_handler_invoke " << std::endl;
    h->queue_.add(h->priority_, std::forward<Function>(f));
}

参数f是原始处理程序。这意味着优先队列包装和绞线包装处理程序。股线包装在外面。因此，在调用f时，会将其分派给strand_service。这个过程发生在同一个strand_service中，因此不会调用处理程序。

要解决此问题，请将h->handler_添加到优先级排队而不是f，如下所示：

// Custom invocation hook for wrapped handlers.
template <typename Function, typename Handler>
void asio_handler_invoke(Function&& f,
                         handler_priority_queue::wrapped_handler<Handler>* h) {
    std::cout << "asio_handler_invoke " << std::endl;
    h->queue_.add(h->priority_, h->handler_);
}

handler_是类模板wrapped_handler的成员变量。它包含未包装的处理程序。

以下是完整的代码：

#include <iostream>
#include <functional>
#include <queue>
#include <vector>
#include <thread>
#include <mutex>

#include <boost/asio.hpp>
#include <boost/optional.hpp>

#define ENABLE_STRAND 1
#define ENABLE_PRIORITY 1

class handler_priority_queue {
public:
    template <typename Handler>
    void add(int priority, Handler&& handler) {
        std::cout << "add(" << priority << ")" << std::endl;
        std::lock_guard<std::mutex> g(mtx_);
        handlers_.emplace(priority, std::forward<Handler>(handler));
    }

    void execute_all() {
        auto top = [&]() -> boost::optional<queued_handler> {
            std::lock_guard<std::mutex> g(mtx_);
            if (handlers_.empty()) return boost::none;
            boost::optional<queued_handler> opt = handlers_.top();
            handlers_.pop();
            return opt;
        };
        while (auto h_opt = top()) {
            h_opt.get().execute();
        }
    }

    template <typename Handler>
    class wrapped_handler {
    public:
        template <typename HandlerArg>
        wrapped_handler(handler_priority_queue& q, int p, HandlerArg&& h)
            : queue_(q), priority_(p), handler_(std::forward<HandlerArg>(h))
        {
        }

        template <typename... Args>
        void operator()(Args&&... args) {
            std::cout << "operator() " << std::endl;
            handler_(std::forward<Args>(args)...);
        }

        //private:
        handler_priority_queue& queue_;
        int priority_;
        Handler handler_;
    };

    template <typename Handler>
    wrapped_handler<Handler> wrap(int priority, Handler&& handler) {
        return wrapped_handler<Handler>(*this, priority, std::forward<Handler>(handler));
    }

private:
    class queued_handler {
    public:
        template <typename Handler>
        queued_handler(int p, Handler&& handler)
            : priority_(p), function_(std::forward<Handler>(handler))
        {
            std::cout << "queued_handler()" << std::endl;
        }

        void execute() {
            std::cout << "execute(" << priority_ << ")" << std::endl;
            function_();
        }

        friend bool operator<(
            queued_handler const& lhs,
            queued_handler const & rhs) {
            return lhs.priority_ < rhs.priority_;
        }

    private:
        int priority_;
        std::function<void()> function_;
    };

    std::priority_queue<queued_handler> handlers_;
    std::mutex mtx_;
};

// Custom invocation hook for wrapped handlers.
template <typename Function, typename Handler>
void asio_handler_invoke(Function&& f,
                         handler_priority_queue::wrapped_handler<Handler>* h) {
    std::cout << "asio_handler_invoke " << std::endl;
    h->queue_.add(h->priority_, h->handler_);
}

//----------------------------------------------------------------------

int main() {
    int const num_of_threads = 4;
    int const num_of_tasks = 5;

    boost::asio::io_service ios;
    boost::asio::strand strand(ios);


    handler_priority_queue pq;

    for (int i = 0; i != num_of_tasks; ++i) {
        ios.post(
#if ENABLE_STRAND
            strand.wrap(
#endif
#if ENABLE_PRIORITY
                pq.wrap(
                    i,
#endif
                    [=] {
                        std::cout << "[called] " << i << "," << std::this_thread::get_id() << std::endl;
                    }
#if ENABLE_STRAND
                )
#endif
#if ENABLE_PRIORITY
            )
#endif
        );
    }

    std::vector<std::thread> pool;
    for (int i = 0; i != num_of_threads; ++i) {
        pool.emplace_back([&]{
                std::cout << "before run_one()" << std::endl;
                while (ios.run_one()) {
                    std::cout << "before poll_one()" << std::endl;
                    while (ios.poll_one())
                        ;
                    std::cout << "before execute_all()" << std::endl;
                    pq.execute_all();
                }
            }
        );
    }
    for (auto& t : pool) t.join();
}

这是一个输出：

before run_one()
asio_handler_invoke
add(0)
queued_handler()
before poll_one()
asio_handler_invoke
add(1)
queued_handler()
asio_handler_invoke
add(2)
queued_handler()
asio_handler_invoke
add(3)
queued_handler()
asio_handler_invoke
add(4)
queued_handler()
before execute_all()
execute(4)
[called] 4,139903315736320
execute(3)
[called] 3,139903315736320
execute(2)
[called] 2,139903315736320
execute(1)
[called] 1,139903315736320
execute(0)
[called] 0,139903315736320
before run_one()
before run_one()
before run_one()