Merge pull request #156 from boostorg/prepare_for_first_boost_release

Prepare for first boost release
boostorg · Oct 7, 2023 · ff73469 · ff73469
2 parents 11c9c1b + 548e3d4
commit ff73469
Show file tree

Hide file tree

Showing 41 changed files with 52 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -2,11 +2,9 @@
 
 Boost.Redis is a high-level [Redis](https://redis.io/) client library built on top of
 [Boost.Asio](https://www.boost.org/doc/libs/release/doc/html/boost_asio.html)
-that implements Redis plain text protocol
+that implements the Redis protocol
 [RESP3](https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md).
-It can multiplex any number of client
-requests, responses, and server pushes onto a single active socket
-connection to the Redis server.  The requirements for using Boost.Redis are:
+The requirements for using Boost.Redis are:
 
 * Boost. The library is included in Boost distributions starting with 1.84.
 * C++17 or higher.
@@ -82,8 +80,9 @@ them are
 * [Client-side caching](https://redis.io/docs/manual/client-side-caching/)
 
 The connection class supports server pushes by means of the
-`boost::redis::connection::async_receive` function, the coroutine shows how
-to used it
+`boost::redis::connection::async_receive` function, which can be
+called in the same connection that is being used to execute commands.
+The coroutine below shows how to used it
 
 ```cpp
 auto
@@ -92,14 +91,17 @@ receiver(std::shared_ptr<connection> conn) -> net::awaitable<void>
    request req;
    req.push("SUBSCRIBE", "channel");
 
+   generic_response resp;
+   conn->set_receive_response(resp);
+
    // Loop while reconnection is enabled
    while (conn->will_reconnect()) {
 
       // Reconnect to channels.
       co_await conn->async_exec(req, ignore, net::deferred);
 
       // Loop reading Redis pushes.
-      for (generic_response resp;;) {
+      for (;;) {
          error_code ec;
          co_await conn->async_receive(resp, net::redirect_error(net::use_awaitable, ec));
          if (ec)
@@ -108,7 +110,7 @@ receiver(std::shared_ptr<connection> conn) -> net::awaitable<void>
          // Use the response resp in some way and then clear it.
          ...
 
-         resp.value().clear();
+         consume_one(resp);
       }
    }
 }

diff --git a/example/sync_connection.hpp b/example/sync_connection.hpp
@@ -1,5 +1,5 @@
 
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis.hpp b/include/boost/redis.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/adapter/adapt.hpp b/include/boost/redis/adapter/adapt.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/adapter/detail/adapters.hpp b/include/boost/redis/adapter/detail/adapters.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/adapter/detail/response_traits.hpp b/include/boost/redis/adapter/detail/response_traits.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/adapter/detail/result_traits.hpp b/include/boost/redis/adapter/detail/result_traits.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/adapter/ignore.hpp b/include/boost/redis/adapter/ignore.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/adapter/result.hpp b/include/boost/redis/adapter/result.hpp
@@ -1,5 +1,5 @@
 
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/config.hpp b/include/boost/redis/config.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/connection.hpp b/include/boost/redis/connection.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/detail/connection_base.hpp b/include/boost/redis/detail/connection_base.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/detail/connector.hpp b/include/boost/redis/detail/connector.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/detail/handshaker.hpp b/include/boost/redis/detail/handshaker.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/detail/health_checker.hpp b/include/boost/redis/detail/health_checker.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/detail/helper.hpp b/include/boost/redis/detail/helper.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/detail/resolver.hpp b/include/boost/redis/detail/resolver.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/detail/runner.hpp b/include/boost/redis/detail/runner.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/detail/write.hpp b/include/boost/redis/detail/write.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/error.hpp b/include/boost/redis/error.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/ignore.hpp b/include/boost/redis/ignore.hpp
@@ -1,5 +1,5 @@
 
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/impl/connection.ipp b/include/boost/redis/impl/connection.ipp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/impl/error.ipp b/include/boost/redis/impl/error.ipp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/impl/ignore.ipp b/include/boost/redis/impl/ignore.ipp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/impl/logger.ipp b/include/boost/redis/impl/logger.ipp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/impl/request.ipp b/include/boost/redis/impl/request.ipp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/impl/response.ipp b/include/boost/redis/impl/response.ipp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/logger.hpp b/include/boost/redis/logger.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/operation.hpp b/include/boost/redis/operation.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/request.hpp b/include/boost/redis/request.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/resp3/impl/parser.ipp b/include/boost/redis/resp3/impl/parser.ipp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/resp3/impl/serialization.ipp b/include/boost/redis/resp3/impl/serialization.ipp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/resp3/impl/type.ipp b/include/boost/redis/resp3/impl/type.ipp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/resp3/node.hpp b/include/boost/redis/resp3/node.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/resp3/parser.hpp b/include/boost/redis/resp3/parser.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/resp3/serialization.hpp b/include/boost/redis/resp3/serialization.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/resp3/type.hpp b/include/boost/redis/resp3/type.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/response.hpp b/include/boost/redis/response.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/src.hpp b/include/boost/redis/src.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/include/boost/redis/usage.hpp b/include/boost/redis/usage.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022 Marcelo Zimbres Silva ([email protected])
+/* Copyright (c) 2018-2023 Marcelo Zimbres Silva ([email protected])
  *
  * Distributed under the Boost Software License, Version 1.0. (See
  * accompanying file LICENSE.txt)

diff --git a/meta/libraries.json b/meta/libraries.json
@@ -2,15 +2,15 @@
     "key": "redis",
     "name": "Redis",
     "authors": [
-        "Marcelo Zimbres"
+        "Marcelo Zimbres Silva"
     ],
     "description": "Redis async client library built on top of Boost.Asio.",
     "category": [
         "Concurrent",
         "IO"
     ],
     "maintainers": [
-        "Marcelo Zimbres <[email protected]>"
+        "Marcelo Zimbres Silva <[email protected]>"
     ],
     "cxxstd": "17"
-}
+}