Refactor io_service to io_context across the codebase (#2)

* Refactor io_service to io_context across the codebase for Boost compatibility

* Test against Boost 1.65

* Replace io_context.hpp with Boost's asio/io_context.hpp and update references across the codebase

* Remove testing against versions lower than 1.68

* Refactor documentation to reflect use of io_context

* Refactor code and documentation to reflect use of io_context

Author: jp-pino

.github/workflows/cmake-superbuild/CMakeLists.txt

@@ -24,10 +24,11 @@ endif ()
 include(ExternalProject)
 
 
-set(BOOST_189 "https://archives.boost.io/release/1.87.0/source/boost_1_87_0.tar.bz2")
+set(BOOST_189 "https://archives.boost.io/release/1.89.0/source/boost_1_89_0.tar.bz2")
 set(BOOST_187 "https://archives.boost.io/release/1.87.0/source/boost_1_87_0.tar.bz2")
 set(BOOST_186 "https://archives.boost.io/release/1.86.0/source/boost_1_86_0.tar.bz2")
 set(BOOST_184 "https://archives.boost.io/release/1.84.0/source/boost_1_84_0.tar.bz2")
+set(BOOST_181 "https://archives.boost.io/release/1.81.0/source/boost_1_81_0.tar.bz2")
 set(BOOST_177 "https://archives.boost.io/release/1.77.0/source/boost_1_77_0.tar.bz2")
 set(BOOST_176 "https://archives.boost.io/release/1.76.0/source/boost_1_76_0.tar.bz2")
 set(BOOST_174 "https://archives.boost.io/release/1.74.0/source/boost_1_74_0.tar.bz2")

.github/workflows/cmake.yml

@@ -52,6 +52,10 @@ jobs:
             system_packages_ubuntu: 
             system_packages_macos: 
             extra_cmake_args: -DCMAKE_POLICY_DEFAULT_CMP0167=NEW
+          - url: BOOST_181
+            system_packages_ubuntu: 
+            system_packages_macos: 
+            extra_cmake_args: -DCMAKE_POLICY_DEFAULT_CMP0167=NEW
           - url: BOOST_176
             system_packages_ubuntu: 
             system_packages_macos: 

AzmqCPack.cmake

@@ -8,8 +8,8 @@ in general, and Asio in particular.
 
 The main abstraction exposed by the library is azmq::socket which
 provides an Asio style socket interface to the underlying zeromq socket
-and interfaces with Asio's io_service().  The socket implementation
-participates in the io_service's reactor for asynchronous IO and
+and interfaces with Asio's io_context().  The socket implementation
+participates in the io_context's reactor for asynchronous IO and
 may be freely mixed with other Asio socket types (raw TCP/UDP/Serial/etc.).")
 set(CPACK_PACKAGE_VERSION               "1.1.0")
 

README.md

@@ -9,8 +9,8 @@ in general, and Asio in particular.
 
 The main abstraction exposed by the library is azmq::socket which
 provides an Asio style socket interface to the underlying zeromq socket
-and interfaces with Asio's io_service().  The socket implementation
-participates in the io_service's reactor for asynchronous IO and
+and interfaces with Asio's io_context().  The socket implementation
+participates in the io_context's reactor for asynchronous IO and
 may be freely mixed with other Asio socket types (raw TCP/UDP/Serial/etc.).
 
 ## Building and installation
@@ -82,13 +82,13 @@ http://zeromq.org/intro:read-the-manual
 namespace asio = boost::asio;
 
 int main(int argc, char** argv) {
-    asio::io_service ios;
-    azmq::sub_socket subscriber(ios);
+    asio::io_context ioc;
+    azmq::sub_socket subscriber(ioc);
     subscriber.connect("tcp://192.168.55.112:5556");
     subscriber.connect("tcp://192.168.55.201:7721");
     subscriber.set_option(azmq::socket::subscribe("NASDAQ"));
 
-    azmq::pub_socket publisher(ios);
+    azmq::pub_socket publisher(ioc);
     publisher.bind("ipc://nasdaq-feed");
 
     std::array<char, 256> buf;

azmq/actor.hpp

@@ -12,7 +12,7 @@
 #include "socket.hpp"
 #include "detail/actor_service.hpp"
 
-#include "io_service.hpp"
+#include <boost/asio/io_context.hpp>
 
 #include <functional>
 
@@ -25,7 +25,7 @@ AZMQ_V1_INLINE_NAMESPACE_BEGIN
     using last_error = detail::actor_service::last_error;
 
     /** \brief create an actor bound to one end of a pipe (pair of inproc sockets)
-     *  \param peer io_service to associate the peer (caller) end of the pipe
+     *  \param peer io_context to associate the peer (caller) end of the pipe
      *  \param f Function accepting socket& as the first parameter and a
      *           number of additional args
      *  \returns peer socket
@@ -35,15 +35,15 @@ AZMQ_V1_INLINE_NAMESPACE_BEGIN
      *  will be attached to the lifetime of the returned socket and will run
      *  until it is destroyed.
      *
-     *  \remark Each actor has an associated io_service and the supplied socket
-     *  will be created on this io_service. The actor may access this by calling
-     *  get_io_service() on the supplied socket.
+     *  \remark Each actor has an associated io_context and the supplied socket
+     *  will be created on this io_context. The actor may access this by calling
+     *  get_io_context() on the supplied socket.
      *
-     *  \remark The associated io_service is configured to stop the spawned actor
+     *  \remark The associated io_context is configured to stop the spawned actor
      *  on SIG_KILL and SIG_TERM.
      *
      *  \remark Termination:
-     *      well behaved actors should ultimately call run() on the io_service
+     *      well behaved actors should ultimately call run() on the io_context
      *      associated with the supplied socket. This allows the 'client' end of
      *      the socket's lifetime to cleanly signal termination. If for some
      *      reason, this is not possible, the caller should set the 'detached'
@@ -54,20 +54,20 @@ AZMQ_V1_INLINE_NAMESPACE_BEGIN
      *      message.
      *
      *      Also note, the default signal handling for the background thread is
-     *      designed to call stop() on the associated io_service, so not calling
+     *      designed to call stop() on the associated io_context, so not calling
      *      run() in your handler means you are responsible for catching these
      *      signals in some other way.
      */
     template<typename Function, typename... Args>
-    socket spawn(boost::asio::io_service & peer, bool defer_start, Function && f, Args&&... args) {
+    socket spawn(boost::asio::io_context & peer, bool defer_start, Function && f, Args&&... args) {
         auto& t = boost::asio::use_service<detail::actor_service>(peer);
         return t.make_pipe(defer_start, std::bind(std::forward<Function>(f),
                                                   std::placeholders::_1,
                                                   std::forward<Args>(args)...));
     }
 
     template<typename Function, typename... Args>
-    socket spawn(boost::asio::io_service & peer, Function && f, Args&&... args) {
+    socket spawn(boost::asio::io_context & peer, Function && f, Args&&... args) {
         auto& t = boost::asio::use_service<detail::actor_service>(peer);
         return t.make_pipe(false, std::bind(std::forward<Function>(f),
                                             std::placeholders::_1,

azmq/context.hpp

@@ -12,7 +12,7 @@
 #include "detail/socket_service.hpp"
 #include "option.hpp"
 #include "error.hpp"
-#include "io_service.hpp"
+#include <boost/asio/io_context.hpp>
 #include <zmq.h>
 
 namespace azmq {
@@ -27,10 +27,10 @@ AZMQ_V1_INLINE_NAMESPACE_BEGIN
      *  \remark Must be called before any sockets are created
      */
     template<typename Option>
-    boost::system::error_code set_option(boost::asio::io_service & io_service,
+    boost::system::error_code set_option(boost::asio::io_context & io_context,
                                          const Option & option,
                                          boost::system::error_code & ec) {
-        return boost::asio::use_service<detail::socket_service>(io_service).set_option(option, ec);
+        return boost::asio::use_service<detail::socket_service>(io_context).set_option(option, ec);
     }
 
     /** \brief set options on the zeromq context.
@@ -39,9 +39,9 @@ AZMQ_V1_INLINE_NAMESPACE_BEGIN
      *  \remark Must be called before any sockets are created
      */
     template<typename Option>
-    void set_option(boost::asio::io_service & io_service, const Option & option) {
+    void set_option(boost::asio::io_context & io_context, const Option & option) {
         boost::system::error_code ec;
-        if (set_option(io_service, option, ec))
+        if (set_option(io_context, option, ec))
             throw boost::system::system_error(ec);
     }
 
@@ -51,10 +51,10 @@ AZMQ_V1_INLINE_NAMESPACE_BEGIN
      *  \param ec boost::system::error_code
      */
     template<typename Option>
-    boost::system::error_code get_option(boost::asio::io_service & io_service,
+    boost::system::error_code get_option(boost::asio::io_context & io_context,
                                          Option & option,
                                          boost::system::error_code & ec) {
-        return boost::asio::use_service<detail::socket_service>(io_service).get_option(option, ec);
+        return boost::asio::use_service<detail::socket_service>(io_context).get_option(option, ec);
     }
 
     /** \brief get option from zeromq context
@@ -63,9 +63,9 @@ AZMQ_V1_INLINE_NAMESPACE_BEGIN
      *  \param ec boost::system::error_code
      */
     template<typename Option>
-    void get_option(boost::asio::io_service & io_service, Option & option) {
+    void get_option(boost::asio::io_context & io_context, Option & option) {
         boost::system::error_code ec;
-        if (get_option(io_service, option))
+        if (get_option(io_context, option))
             throw boost::system::system_error(ec);
     }
 AZMQ_V1_INLINE_NAMESPACE_END

azmq/detail/actor_service.hpp

@@ -24,9 +24,6 @@
 #include <boost/asio/signal_set.hpp>
 #include <boost/container/flat_map.hpp>
 
-#if BOOST_VERSION < 107000
-#   define AZMQ_DETAIL_USE_IO_SERVICE 1
-#endif
 
 #include <string>
 #include <vector>
@@ -42,12 +39,9 @@ namespace detail {
     public:
         inline static std::string get_uri(const char* pfx);
 
-#ifdef AZMQ_DETAIL_USE_IO_SERVICE
-        actor_service(boost::asio::io_service & ios)
-#else
-        actor_service(boost::asio::io_context & ios)
-#endif
-            : azmq::detail::service_base<actor_service>(ios)
+        actor_service(boost::asio::io_context & ioc)
+
+            : azmq::detail::service_base<actor_service>(ioc)
         { }
 
         void shutdown() override { }
@@ -59,21 +53,13 @@ namespace detail {
 
         template<typename T>
         socket make_pipe(bool defer_start, T&& data) {
-#ifdef AZMQ_DETAIL_USE_IO_SERVICE
-            return make_pipe(get_io_service(), defer_start, std::forward<T>(data));
-#else
             return make_pipe(get_io_context(), defer_start, std::forward<T>(data));
-#endif
         }
 
         template<typename T>
-#ifdef AZMQ_DETAIL_USE_IO_SERVICE
-        static socket make_pipe(boost::asio::io_service & ios, bool defer_start, T&& data) {
-#else
-        static socket make_pipe(boost::asio::io_context & ios, bool defer_start, T&& data) {
-#endif
+        static socket make_pipe(boost::asio::io_context & ioc, bool defer_start, T&& data) {
             auto p = std::make_shared<model<T>>(std::forward<T>(data));
-            auto res = p->peer_socket(ios);
+            auto res = p->peer_socket(ioc);
             associate_ext(res, handler(std::move(p), defer_start));
             return std::move(res);
         }
@@ -82,7 +68,7 @@ namespace detail {
         struct concept_ {
             using ptr = std::shared_ptr<concept_>;
 
-            boost::asio::io_service io_service_;
+            boost::asio::io_context io_context_;
             boost::asio::signal_set signals_;
             pair_socket socket_;
             thread_t thread_;
@@ -95,8 +81,8 @@ namespace detail {
             std::exception_ptr last_error_;
 
             concept_()
-                : signals_(io_service_, SIGINT, SIGTERM)
-                , socket_(io_service_)
+                : signals_(io_context_, SIGINT, SIGTERM)
+                , socket_(io_context_)
                 , ready_(false)
                 , stopped_(true)
             {
@@ -105,11 +91,7 @@ namespace detail {
 
             virtual ~concept_() = default;
 
-#ifdef AZMQ_DETAIL_USE_IO_SERVICE
-            pair_socket peer_socket(boost::asio::io_service & peer) {
-#else
             pair_socket peer_socket(boost::asio::io_context & peer) {
-#endif
                 pair_socket res(peer);
                 auto uri = socket_.endpoint();
                 BOOST_ASSERT_MSG(!uri.empty(), "uri empty");
@@ -121,7 +103,7 @@ namespace detail {
 
             void stop() {
                 if (!joinable()) return;
-                io_service_.stop();
+                io_context_.stop();
                 thread_.join();
             }
 
@@ -165,7 +147,7 @@ namespace detail {
             static void run(ptr p) {
                 lock_type l { p->mutex_ };
                 p->signals_.async_wait([p](boost::system::error_code const&, int) {
-                    p->io_service_.stop();
+                    p->io_context_.stop();
                 });
                 p->stopped_ = false;
                 p->thread_ = thread_t([p] {
@@ -200,7 +182,7 @@ namespace detail {
                 , defer_start_(defer_start)
             { }
 
-            void on_install(boost::asio::io_service&, void*) {
+            void on_install(boost::asio::io_context&, void*) {
                 if (defer_start_) return;
                 defer_start_ = false;
                 concept_::run(p_);

azmq/detail/basic_io_object.hpp

@@ -9,7 +9,7 @@
 #ifndef AZMQ_DETAIL_BASIC_IO_OBJECT_HPP__
 #define AZMQ_DETAIL_BASIC_IO_OBJECT_HPP__
 
-#include "../io_service.hpp"
+#include <boost/asio/io_context.hpp>
 #include <boost/asio/basic_io_object.hpp>
 
 namespace azmq {
@@ -41,8 +41,8 @@ namespace detail {
         friend class core_access<Service>;
 
     public:
-        basic_io_object(boost::asio::io_service& ios)
-            : boost::asio::basic_io_object<Service>(ios)
+        basic_io_object(boost::asio::io_context& ioc)
+            : boost::asio::basic_io_object<Service>(ioc)
         { }
     };
 } // namespace detail

azmq/detail/reactor_op.hpp

@@ -9,10 +9,10 @@
 #ifndef AZMQ_DETAIL_REACTOR_OP_HPP_
 #define AZMQ_DETAIL_REACTOR_OP_HPP_
 
-#include "../io_service.hpp"
 #include "../message.hpp"
 #include "socket_ops.hpp"
 
+#include <boost/asio/io_context.hpp>
 #include <boost/optional.hpp>
 
 namespace azmq {

azmq/detail/receive_op.hpp

@@ -10,14 +10,14 @@
 #define AZMQ_DETAIL_RECEIVE_OP_HPP_
 
 #include "../error.hpp"
-#include "../io_service.hpp"
 #include "../message.hpp"
 #include "socket_ops.hpp"
 #include "reactor_op.hpp"
 
 #include <boost/version.hpp>
 #include <boost/asio/dispatch.hpp>
 #include <boost/asio/executor_work_guard.hpp>
+#include <boost/asio/io_context.hpp>
 #if BOOST_VERSION >= 107900
 #include <boost/asio/recycling_allocator.hpp>
 #include <boost/asio/bind_allocator.hpp>