Adds support for corosio

CMakeLists.txt

@@ -78,6 +78,11 @@ if (BOOST_REDIS_MAIN_PROJECT)
     json
     endian
     compat
+    url
+    filesystem
+    scope
+    capy
+    corosio
   )
 
   foreach(dep IN LISTS deps)
@@ -90,6 +95,9 @@ if (BOOST_REDIS_MAIN_PROJECT)
     INTERFACE
       Boost::system
       Boost::asio
+      Boost::capy
+      Boost::corosio
+      Boost::corosio_openssl
       Threads::Threads
       OpenSSL::Crypto
       OpenSSL::SSL
@@ -118,6 +126,9 @@ else()
       Boost::mp11
       Boost::system
       Boost::throw_exception
+      Boost::capy
+      Boost::corosio
+      Boost::corosio_openssl
       Threads::Threads
       OpenSSL::Crypto
       OpenSSL::SSL
@@ -130,7 +141,7 @@ if (BOOST_REDIS_MAIN_PROJECT)
 endif()
 
 # Most tests require a running Redis server, so we only run them if we're the main project
-if(BOOST_REDIS_MAIN_PROJECT AND BUILD_TESTING)
+# if(BOOST_REDIS_MAIN_PROJECT AND BUILD_TESTING)
   # Tests and common utilities
   add_subdirectory(test)
 
@@ -139,4 +150,4 @@ if(BOOST_REDIS_MAIN_PROJECT AND BUILD_TESTING)
 
   # Examples
   add_subdirectory(example)
-endif()
+# endif()

benchmarks/CMakeLists.txt

@@ -1,6 +1,6 @@
 
 add_library(benchmarks_options INTERFACE)
-target_link_libraries(benchmarks_options INTERFACE boost_redis_src)
+target_link_libraries(benchmarks_options INTERFACE boost_redis_asio)
 target_link_libraries(benchmarks_options INTERFACE boost_redis_project_options)
 target_compile_features(benchmarks_options INTERFACE cxx_std_20)
 

doc/modules/ROOT/pages/cancellation.adoc

@@ -52,7 +52,7 @@ error after sending the request, but before receiving a response?
 
 In this situation there is no way to know if the request was processed by the server or not.
 By default, the library will consider the request as failed,
-and `async_exec` will complete with an `asio::error::operation_aborted`
+and `async_exec` will complete with an `capy::error::canceled`
 error code.
 
 Some requests can be executed several times and result in the same outcome

doc/modules/ROOT/pages/pushes.adoc

@@ -15,6 +15,12 @@ The most common case is
 https://redis.io/docs/latest/develop/pubsub/[Pub/Sub messages]
 triggered by `PUBLISH`. The following example shows a typical receiver:
 
+[tabs]
+========
+Asio::
++
+--
+
 [source,cpp]
 ----
 auto receiver(std::shared_ptr<connection> conn) -> asio::awaitable<void>
@@ -62,6 +68,67 @@ auto receiver(std::shared_ptr<connection> conn) -> asio::awaitable<void>
    }
 }
 ----
+--
+
+Corosio::
++
+--
+
+[source,cpp]
+----
+capy::io_task<> receiver(co_connection& conn)
+{
+   generic_flat_response resp;
+   conn.set_receive_response(resp);
+
+   // Subscribe to the channel 'mychannel'. You can add any number of channels here.
+   request req;
+   req.subscribe({"mychannel"});
+   auto [sub_ec] = co_await conn.exec(req);
+   if (sub_ec) {
+      std::cerr << "Error subscribing: " << sub_ec << std::endl;
+      co_return {};
+   }
+
+   // You're now subscribed to 'mychannel'. Pushes sent over this channel will be stored
+   // in resp. If the connection encounters a network error and reconnects to the server,
+   // it will automatically subscribe to 'mychannel' again. This is transparent to the user.
+   // You need to use the specialized request::subscribe() function (instead of request::push)
+   // to enable this behavior.
+
+   // Loop to read Redis push messages. The loop terminates when receive() reports an error
+   // (e.g. cancellation when the surrounding when_any cascade tears down the run loop).
+   while (true) {
+      // Wait for pushes
+      auto [ec] = co_await conn.receive();
+
+      // Check for errors and cancellations
+      if (ec) {
+         std::cerr << "Error during receive: " << ec << std::endl;
+         co_return {};
+      }
+
+      // This can happen if a SUBSCRIBE command errored (e.g. insufficient permissions)
+      if (resp.has_error()) {
+         std::cerr << "The receive response contains an error: " << resp.error().diagnostic
+                   << std::endl;
+         co_return {};
+      }
+
+      // The response must be consumed without suspending the
+      // coroutine i.e. without the use of async operations.
+      for (push_view elem : push_parser(resp.value())) {
+         std::cout << "Received message from channel " << elem.channel << ": " << elem.payload
+                   << "\n";
+      }
+
+      resp.value().clear();
+   }
+}
+----
+--
+
+========
 
 Summary of the steps:
 

doc/modules/ROOT/pages/reference.adoc

@@ -23,6 +23,8 @@ xref:reference:boost/redis/connection.adoc[`connection`]
 
 xref:reference:boost/redis/basic_connection.adoc[`basic_connection`]
 
+xref:reference:boost/redis/co_connection.adoc[`co_connection`]
+
 xref:reference:boost/redis/address.adoc[`address`]
 
 xref:reference:boost/redis/role.adoc[`role`]

doc/mrdocs.cpp

@@ -8,3 +8,4 @@
 #define BOOST_ALLOW_DEPRECATED  // avoid mrdocs errors with the BOOST_DEPRECATED macro
 
 #include <boost/redis.hpp>
+#include <boost/redis/co_connection.hpp>

doc/package.json

@@ -1,5 +1,6 @@
 {
   "dependencies": {
+    "@asciidoctor/tabs": "^1.0.0-beta.6",
     "@cppalliance/antora-cpp-reference-extension": "^0.1.0",
     "antora": "^3.1.10"
   }

doc/redis-playbook.yml

@@ -25,6 +25,8 @@ asciidoc:
   attributes:
     # Scrolling problems appear without this
     page-pagination: ''
+  extensions:
+    - '@asciidoctor/tabs'
 
 content:
   sources:

example/CMakeLists.txt

@@ -1,10 +1,8 @@
 add_library(examples_main STATIC main.cpp)
-target_link_libraries(examples_main PRIVATE boost_redis_project_options)
+target_link_libraries(examples_main PUBLIC boost_redis_asio)
 
 function(make_example EXAMPLE_NAME)
   add_executable(${EXAMPLE_NAME} ${EXAMPLE_NAME}.cpp)
-  target_link_libraries(${EXAMPLE_NAME} PRIVATE boost_redis_src)
-  target_link_libraries(${EXAMPLE_NAME} PRIVATE boost_redis_project_options)
   if (ARGN)
     target_link_libraries(${EXAMPLE_NAME} PRIVATE ${ARGN})
   endif()
@@ -15,20 +13,30 @@ function(make_testable_example EXAMPLE_NAME)
   add_test(${EXAMPLE_NAME} ${EXAMPLE_NAME} $ENV{BOOST_REDIS_TEST_SERVER} 6379)
 endfunction()
 
-make_testable_example(cpp17_intro)
-make_testable_example(cpp17_intro_sync)
+make_testable_example(cpp17_intro        boost_redis_asio)
+make_testable_example(cpp17_intro_sync   boost_redis_asio)
 
 make_testable_example(cpp20_intro        examples_main)
+make_testable_example(corosio_intro      boost_redis_corosio)
 make_testable_example(cpp20_containers   examples_main)
+make_testable_example(corosio_containers boost_redis_corosio)
 make_testable_example(cpp20_json         examples_main Boost::json Boost::container_hash)
+make_testable_example(corosio_json       boost_redis_corosio Boost::json Boost::container_hash)
 make_testable_example(cpp20_unix_sockets examples_main)
+make_testable_example(corosio_unix_sockets boost_redis_corosio)
 make_testable_example(cpp20_timeouts     examples_main)
+make_testable_example(corosio_timeouts   boost_redis_corosio)
 make_testable_example(cpp20_sentinel     examples_main)
+make_testable_example(corosio_sentinel   boost_redis_corosio)
 
-make_example(cpp20_subscriber  examples_main)
-make_example(cpp20_streams     examples_main)
-make_example(cpp20_echo_server examples_main)
-make_example(cpp20_intro_tls   examples_main)
+make_example(cpp20_subscriber   examples_main)
+make_example(corosio_subscriber boost_redis_corosio)
+make_example(cpp20_streams      examples_main)
+make_example(corosio_streams    boost_redis_corosio)
+make_example(cpp20_echo_server  examples_main)
+make_example(corosio_echo_server boost_redis_corosio)
+make_example(cpp20_intro_tls    examples_main)
+make_example(corosio_intro_tls  boost_redis_corosio)
 
 # We test the protobuf example only on gcc.
 if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
@@ -48,7 +56,8 @@ endif()
 # We build and test the spdlog integration example only if the library is found
 find_package(spdlog)
 if (spdlog_FOUND)
-  make_testable_example(cpp17_spdlog spdlog::spdlog)
+  make_testable_example(cpp17_spdlog   spdlog::spdlog)
+  make_testable_example(corosio_spdlog spdlog::spdlog boost_redis_corosio)
 else()
   message(STATUS "Skipping the spdlog example because the spdlog package couldn't be found")
 endif()