Global namespace

Namespaces

Name

boost

boost namespace

Namespaces

Name

redis

boost::redis namespace

Namespaces

Name

adapter

resp3

Types

Name

Description

address

Address of a Redis server.

any_adapter

A type‐erased reference to a response.

basic_connection

A SSL connection to the Redis server.

config

Configure parameters used by the connection classes.

connection

A basic_connection that type erases the executor.

logger

Defines logging configuration.

push_parser

A range that parses Pub/Sub messages from a sequence of RESP3 nodes.

push_view

A Pub/Sub message received from the server.

request

Represents a Redis request.

sentinel_config

Configuration values to use when using Sentinel.

usage

Connection usage information.

Type Aliases

Name

Description

generic_flat_response

Similar to boost::redis::generic_response but stores data contiguously.

generic_response

A generic response to a request

ignore_t

Type used to ignore responses.

response

Response with compile‐time size.

Enums

Name

Description

error

Generic errors.

operation

Connection operations that can be cancelled.

role

Identifies the possible roles of a Redis server.

Functions

Name

Description

consume_one

consume_one overloads

make_error_code

Creates a error_code object from an error.

operator==

Compares two addresses for equality.

operator!=

Compares two addresses for inequality.

Variables

Name

Description

ignore

Global ignore object.

boost::redis::adapter namespace

Types

Name

Description

error

Stores any resp3 error.

ignore

An adapter that ignores responses.

Type Aliases

Name

Description

result

Stores response to individual Redis commands.

Functions

Name

Description

adapt2

Adapts a type to be used as the response to an individual command.

boost_redis_adapt

Adapts a type to be used as a response.

throw_exception_from_error

Allows using error with boost::system::result.

operator==

Compares two error objects for equality

operator!=

Compares two error objects for difference

boost::redis::resp3 namespace

Types

Name

Description

add_bulk_impl

basic_node

A node in the response tree.

bulk_counter

flat_tree

A generic response that stores data contiguously.

parser

Type Aliases

Name

Description

basic_tree

A RESP3 tree that owns its data.

node

A node in the response tree that owns its data.

node_view

A node in the response tree that does not own its data.

tree

A RESP3 tree that owns its data.

view_tree

A RESP3 tree whose data are std::string_views.

Enums

Name

Description

type

RESP3 data types.

Functions

Name

Description

add_blob

add_bulk

add_header

add_separator

boost_redis_to_bulk

Adds a bulk to the request.

element_multiplicity

is_aggregate

Checks whether the data type is an aggregate.

parse

to_code

to_string

Converts the data type to a string.

to_type

operator<<

Writes the type to the output stream.

operator==

Equality operators

operator!=

Inequality operators

Created with MrDocs