Classes | |
struct | boost::redis::address |
Address of a Redis server. More... | |
class | boost::redis::any_adapter |
A type-erased reference to a response. More... | |
class | boost::redis::basic_connection< Executor > |
A SSL connection to the Redis server. More... | |
struct | boost::redis::resp3::basic_node< String > |
A node in the response tree. More... | |
struct | boost::redis::config |
Configure parameters used by the connection classes. More... | |
class | boost::redis::connection |
A basic_connection that type erases the executor. More... | |
struct | boost::redis::adapter::error |
Stores any resp3 error. More... | |
struct | boost::redis::adapter::ignore |
An adapter that ignores responses. More... | |
struct | boost::redis::logger |
Defines logging configuration. More... | |
class | boost::redis::request |
Creates Redis requests. More... | |
struct | boost::redis::usage |
Connection usage information. More... | |
Typedefs | |
using | boost::redis::generic_response = adapter::result<std::vector<resp3::node>> |
A generic response to a request. | |
using | boost::redis::ignore_t = std::decay_t<decltype(std::ignore)> |
Type used to ignore responses. | |
using | boost::redis::resp3::node = basic_node<std::string> |
A node in the response tree that owns its data. | |
using | boost::redis::resp3::node_view = basic_node<std::string_view> |
A node view in the response tree. | |
template<class... Ts> | |
using | boost::redis::response = std::tuple<adapter::result<Ts>...> |
Response with compile-time size. | |
template<class Value > | |
using | boost::redis::adapter::result = system::result<Value, error> |
Stores response to individual Redis commands. | |
Enumerations | |
enum class | boost::redis::error |
Generic errors. More... | |
enum class | boost::redis::logger::level |
Syslog-like log levels. More... | |
enum class | boost::redis::operation |
Connection operations that can be cancelled. More... | |
enum class | boost::redis::resp3::type |
RESP3 data types. More... | |
Functions | |
auto | boost::redis::resp3::operator<< (std::ostream &os, type t) -> std::ostream & |
Writes the type to the output stream. | |
auto | boost::redis::resp3::to_string (type t) noexcept -> char const * |
Converts the data type to a string. | |
Variables | |
ignore_t | boost::redis::ignore |
Global ignore object. | |
This page contains the documentation of the Aedis high-level API.
struct boost::redis::address |
struct boost::redis::config |
struct boost::redis::usage |
using boost::redis::generic_response = adapter::result<std::vector<resp3::node>> |
A generic response to a request.
This response type can store any type of RESP3 data structure. It contains the pre-order view of the response tree.
Definition at line 35 of file response.hpp.
using boost::redis::ignore_t = std::decay_t<decltype(std::ignore)> |
Type used to ignore responses.
For example
will ignore the first and third responses. RESP3 errors won't be ignore but will cause async_exec
to complete with an error.
Definition at line 30 of file ignore.hpp.
|
strong |
Generic errors.
|
strong |
Syslog-like log levels.
Enumerator | |
---|---|
disabled | Disabled. |
emerg | Emergency. |
alert | Alert. |
crit | Critical. |
err | Error. |
warning | Warning. |
notice | Notice. |
info | Info. |
debug | Debug. |
Definition at line 24 of file logger.hpp.
|
strong |
Connection operations that can be cancelled.
The operations listed below can be passed to the boost::redis::connection::cancel
member function.
Definition at line 18 of file operation.hpp.
|
strong |
RESP3 data types.
The RESP3 specification can be found at https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md.
auto boost::redis::resp3::operator<< | ( | std::ostream & | os, |
type | t ) -> std::ostream & |
Writes the type to the output stream.
os | Output stream. |
t | RESP3 type. |
|
noexcept |
Converts the data type to a string.
t | RESP3 type. |