...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Classes | |
struct | boost::redis::address |
Address of a Redis server. 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... | |
class | boost::redis::detail::connection_base< Executor > |
Base class for high level Redis asynchronous connections. More... | |
struct | boost::redis::adapter::error |
Stores any resp3 error. More... | |
struct | boost::redis::adapter::ignore |
An adapter that ignores responses. More... | |
class | boost::redis::logger |
Logger class. 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. More... | |
using | boost::redis::ignore_t = std::decay_t< decltype(std::ignore)> |
Type used to ignore responses. More... | |
using | boost::redis::resp3::node = basic_node< std::string > |
A node 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 | |
boost::redis::logger::logger (level l=level::disabled) | |
Constructor. More... | |
void | boost::redis::logger::on_connect (system::error_code const &ec, asio::ip::tcp::endpoint const &ep) |
Called when the connect operation completes. More... | |
void | boost::redis::logger::on_connection_lost (system::error_code const &ec) |
Called when the connection is lost. More... | |
void | boost::redis::logger::on_hello (system::error_code const &ec, generic_response const &resp) |
Called when the HELLO request completes. More... | |
void | boost::redis::logger::on_read (system::error_code const &ec, std::size_t n) |
Called when the read operation completes. More... | |
void | boost::redis::logger::on_resolve (system::error_code const &ec, asio::ip::tcp::resolver::results_type const &res) |
Called when the resolve operation completes. More... | |
void | boost::redis::logger::on_run (system::error_code const &reader_ec, system::error_code const &writer_ec) |
Called when the run operation completes. More... | |
void | boost::redis::logger::on_runner (system::error_code const &run_all_ec, system::error_code const &health_check_ec, system::error_code const &hello_ec) |
Called when the runner operation completes. More... | |
void | boost::redis::logger::on_ssl_handshake (system::error_code const &ec) |
Called when the ssl handshake operation completes. More... | |
void | boost::redis::logger::on_write (system::error_code const &ec, std::string const &payload) |
Called when the write operation completes. More... | |
auto | boost::redis::resp3::operator<< (std::ostream &os, type t) -> std::ostream & |
Writes the type to the output stream. More... | |
void | boost::redis::logger::set_prefix (std::string_view prefix) |
Sets a prefix to every log message. More... | |
auto | boost::redis::resp3::to_string (type t) noexcept -> char const * |
Converts the data type to a string. More... | |
Variables | |
ignore_t | boost::redis::ignore |
Global ignore object. More... | |
This page contains the documentation of the Aedis high-level API.
struct boost::redis::address |
Address of a Redis server.
Definition at line 20 of file config.hpp.
Class Members | ||
---|---|---|
string | host = "127.0.0.1" | Redis host. |
string | port = "6379" | Redis port. |
struct boost::redis::config |
Configure parameters used by the connection classes.
Definition at line 30 of file config.hpp.
Class Members | ||
---|---|---|
address | addr = address{"127.0.0.1", "6379"} | Address of the Redis server. |
string | clientname = "Boost.Redis" | Client name parameter of the HELLO command. |
duration | connect_timeout = std::chrono::seconds{10} | Time the connect operation is allowed to last. |
optional< int > | database_index = 0 | Database that will be passed to the SELECT command. |
string | health_check_id = "Boost.Redis" |
Message used by the health-checker in boost::redis::connection::async_run . |
duration | health_check_interval = std::chrono::seconds{2} |
Health checks interval. To disable health-checks pass zero as duration. |
string | log_prefix = "(Boost.Redis) " |
Logger prefix, see boost::redis::logger . |
string | password |
Password passed to the HELLO command. If left empty HELLO will be sent without authentication parameters. |
duration | reconnect_wait_interval = std::chrono::seconds{1} |
Time waited before trying a reconnection. To disable reconnection pass zero as duration. |
duration | resolve_timeout = std::chrono::seconds{10} | Time the resolve operation is allowed to last. |
duration | ssl_handshake_timeout = std::chrono::seconds{10} | Time the SSL handshake operation is allowed to last. |
bool | use_ssl = false | Uses SSL instead of a plain connection. |
string | username = "default" |
Username passed to the HELLO command. If left empty HELLO will be sent without authentication parameters. |
struct boost::redis::usage |
Connection usage information.
using boost::redis::generic_response = typedef 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 = typedef 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 31 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 32 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.
Enumerator | |
---|---|
resolve | Resolve operation. |
connect | Connect operation. |
ssl_handshake | SSL handshake operation. |
exec | Refers to |
run | Refers to |
receive | Refers to |
reconnection | Cancels reconnection. |
health_check | Health check operation. |
all | Refers to all operations. |
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.
|
inline |
void boost::redis::logger::on_connect | ( | system::error_code const & | ec, |
asio::ip::tcp::endpoint const & | ep | ||
) |
Called when the connect operation completes.
ec | Error returned by the connect operation. |
ep | Endpoint to which the connection connected. |
void boost::redis::logger::on_connection_lost | ( | system::error_code const & | ec | ) |
Called when the connection is lost.
ec | Error returned when the connection is lost. |
void boost::redis::logger::on_hello | ( | system::error_code const & | ec, |
generic_response const & | resp | ||
) |
Called when the HELLO
request completes.
ec | Error code returned by the async_exec operation. |
resp | Response sent by the Redis server. |
void boost::redis::logger::on_read | ( | system::error_code const & | ec, |
std::size_t | n | ||
) |
Called when the read operation completes.
ec | Error code returned by the read operation. |
n | Number of bytes read. |
void boost::redis::logger::on_resolve | ( | system::error_code const & | ec, |
asio::ip::tcp::resolver::results_type const & | res | ||
) |
Called when the resolve operation completes.
ec | Error returned by the resolve operation. |
res | Resolve results. |
void boost::redis::logger::on_run | ( | system::error_code const & | reader_ec, |
system::error_code const & | writer_ec | ||
) |
Called when the run operation completes.
reader_ec | Error code returned by the read operation. |
writer_ec | Error code returned by the write operation. |
void boost::redis::logger::on_runner | ( | system::error_code const & | run_all_ec, |
system::error_code const & | health_check_ec, | ||
system::error_code const & | hello_ec | ||
) |
Called when the runner operation completes.
run_all_ec | Error code returned by the run_all operation. |
health_check_ec | Error code returned by the health checker operation. |
hello_ec | Error code returned by the health checker operation. |
void boost::redis::logger::on_ssl_handshake | ( | system::error_code const & | ec | ) |
Called when the ssl handshake operation completes.
ec | Error returned by the handshake operation. |
void boost::redis::logger::on_write | ( | system::error_code const & | ec, |
std::string const & | payload | ||
) |
Called when the write operation completes.
ec | Error code returned by the write operation. |
payload | The payload written to the socket. |
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. |
|
inline |
Sets a prefix to every log message.
prefix | The prefix. |
Definition at line 138 of file logger.hpp.
|
noexcept |
Converts the data type to a string.
t | RESP3 type. |