boost/redis
2
0
Fork 0
mirror of https://github.com/boostorg/redis.git synced 2026-01-19 04:42:09 +00:00
Code Issues Projects Releases Wiki Activity

Adds changelog, fixes CI file, improvements in the docs.

Browse Source
This commit is contained in:
Marcelo Zimbres
2022-07-30 09:31:11 +02:00
parent e0041ac7ae
commit 8728914109
4 changed files with 123 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/ci.yml vendored
View File

@@ -25,6 +25,8 @@ jobs:
run: sudo apt install automake
- name: Install compiler
run: sudo apt-get install -y ${{ matrix.compiler }}
- name: Install Redis
run: sudo apt-get install -y redis-server
- name: Install boost
uses: MarkusJx/install-boost@v2.3.0
id: install-boost

29
CHANGELOG.md Normal file
View File

@@ -0,0 +1,29 @@
# Changelog
## v0.2.2
* `connection::async_read_push` has been renamed to `async_receive`.
* The `aedis` directory has been moved to `include` to look more
similar to Boost libraries. Users should now replace `-I/aedis-path`
with `-I/aedis-path/include` to the compiler flags.
* Adds experimental `sync_wrapper`. This class offers a thread-safe
and blocking API on top of the connection `class`. It is meant to
satisfy users that can't make their code asynchronous.
* Fixes a bug in the `connection::async_exec(host, port)` overload
that was causing crashes on reconnect.
* Fixes the executor usage in the connection class. Before theses
changes it was only supporting `any_io_executor`.
* Fixes build in clang the compilers.
* Many simplifications in the `chat_room` example.
* Makes make improvements in the documentation.
##v0.2.1
* Bugfixes and improvements in the documentation.

169
include/aedis.hpp
View File

@@ -78,29 +78,105 @@
}
@endcode
See echo_server.cpp for a more complex example. The \c connection
class also supports server-side pushes on the same connection
where commands are executed, a typical subscriber will look like
See echo_server.cpp for a more complex example. Server-side
pushes are supported on the same connection where commands are
executed, a typical subscriber will look like
@code
net::awaitable<void> reader(std::shared_ptr<connection> db)
{
try {
for (std::vector<node<std::string>> resp;;) {
co_await db->async_read_push(adapt(resp));
...
for (std::vector<node<std::string>> resp;;) {
co_await db->async_receive(adapt(resp));
// Handle message
// Handle message
resp.clear();
}
} catch (std::exception const& e) {
std::cerr << "Reader: " << e.what() << std::endl;
resp.clear();
}
}
@endcode
See subscriber.cpp for a complete example.
\subsection using-aedis Installation
To install and use Aedis you will need
- Boost 1.78 or greater.
- C++17. Some examples require C++20 with coroutine support.
- Redis 6 or higher. Optionally also redis-cli and Redis Sentinel.
For a simple installation run
```
# Clone the repository and checkout the lastest release tag.
$ git clone --branch v0.2.1 https://github.com/mzimbres/aedis.git
$ cd aedis
# Build an example
$ g++ -std=c++17 -pthread examples/intro.cpp -I./include -I/path/boost_1_79_0/include/
```
For a proper full installation on the system run
```
# Download and unpack the latest release
$ wget https://github.com/mzimbres/aedis/releases/download/v0.2.1/aedis-0.2.1.tar.gz
$ tar -xzvf aedis-0.2.1.tar.gz
# Configure, build and install
$ ./configure --prefix=/opt/aedis-0.2.1 --with-boost=/opt/boost_1_78_0
$ sudo make install
```
To build examples and tests
```
$ make
```
@subsubsection using_aedis Using Aedis
When writing you own applications include the following header
```cpp
#include <aedis/src.hpp>
```
in no more than one source file in your applications.
@subsubsection sup-comp Supported compilers
Aedis has been tested with the following compilers
- Tested with gcc: 12, 11.
- Tested with clang: 14, 13, 11.
\subsubsection Developers
To generate the build system clone the repository and run
```
# git clone https://github.com/mzimbres/aedis.git
$ autoreconf -i
```
After that you will have a configure script that you can run as
explained above, for example, to use a compiler other that the
system compiler run
```
$ CXX=clang++-14 CXXFLAGS="-g" ./configure --with-boost=...
```
To generate release tarballs run
```
$ make distcheck
```
\section requests Requests
Redis requests are composed of one of more Redis commands (in
@@ -381,82 +457,13 @@
@li echo_server.cpp: A simple TCP echo server that users coroutines.
@li chat_room.cpp: A simple chat room that uses coroutines.
\section using-aedis Installation
To install and use Aedis you will need
- Boost 1.78 or greater.
- C++17. Some examples require C++20 with coroutine support.
- Redis server. Optionally also redis-cli and Redis Sentinel.
If you all you want is to test some examples without a full installation
```
# Find the latest release tag in https://github.com/mzimbres/aedis/releases
$ git clone --depth 1 --branch v0.2.1 https://github.com/mzimbres/aedis.git
$ cd aedis
$ g++ -std=c++17 -pthread examples/intro.cpp -I./include -I/opt/boost_1_79_0/include/
```
For a proper installation
```
# Download and unpack the latest release
$ wget https://github.com/mzimbres/aedis/releases/download/vversion/aedis-version.tar.gz
$ tar -xzvf aedis-version.tar.gz
# Configure build and install
$ ./configure --prefix=/opt/aedis-version --with-boost=/opt/boost_1_78_0
$ make # optional
$ sudo make install
```
When writing you own applications include the following header
```cpp
#include <aedis/src.hpp>
```
in exactly one source file in your applications.
@subsection sup-comp Supported compilers
Aedis has been tested with the following compilers
- Tested with gcc: 12, 11.
- Tested with clang: 14, 13, 11.
\subsection Developers
To generate the build system clone the repository and run
```
# git clone https://github.com/mzimbres/aedis.git
$ autoreconf -i
```
After that you will have a configure script that you can run as
explained above, for example, to use a compiler other that the
system compiler run
```
$ CXX=clang++-14 CXXFLAGS="-g" ./configure --with-boost=...
```
To generate release tarballs run
```
$ make distcheck
```
\section why-aedis Why Aedis
At the time of this writing there are seventeen Redis clients
listed in the [official](https://redis.io/docs/clients/#cpp) list.
With so many clients available it is not unlikely that users are
asking themselves why yet another one. In this section I will try
to compare Aedis to the most popular clients and why we need
to compare Aedis with the most popular clients and why we need
Aedis. Notice however that this is ongoing work as comparing
client objectively is difficult and time consuming.

4
include/aedis/experimental/sync_wrapper.hpp
View File

@@ -62,6 +62,10 @@ auto async_failover(
} // detail
/** @brief Blocking wrapper for the conenction class.
* @ingroup any
*
* This class offers a synchronous API on top of the connection
* class.
*/
template <class Connection>
class sync_wrapper {