boost::redis::request :: Boost.Redis

# boost::redis::request

Represents a Redis request.

## Synopsis

Declared in `<boost/redis/request.hpp>`

    class request;

## Description

A request is composed of one or more Redis commands and is referred to in the redis documentation as a pipeline. See for more info.

For example:

    request r;
    r.push("SET", "k1", "some_value");
    r.push("SET", "k2", "other_value");
    r.push("GET", "k3");

Uses a `std::string` for internal storage.

## Types

Name | Description
`config` | Request configuration options.

## Member Functions

Name | Description
`request` [constructor] | Constructor
`get_expected_responses` | Returns the number of responses expected for this request.
`get_commands` | Returns the number of commands contained in this request.
`clear` | Clears the request preserving allocated memory.
`reserve` | Calls `std::string::reserve` on the internal storage.
`get_config` | Returns a reference to the config object.
`push` | Appends a new command to the end of the request.
`push_range` | Appends a new command to the end of the request.
`append` | Appends the commands in another request to the end of the request.
`subscribe` | Appends a SUBSCRIBE command to the end of the request.
`unsubscribe` | Appends an UNSUBSCRIBE command to the end of the request.
`psubscribe` | Appends a PSUBSCRIBE command to the end of the request.
`punsubscribe` | Appends a PUNSUBSCRIBE command to the end of the request.
`hello` | `hello` overloads
`hello_setname` | `hello_setname` overloads

## Friends

Name | Description
--- | ---
`boost::redis::detail::request_access` |

## Non-Member Functions

Name | Description
`resp3::boost_redis_to_bulk` | Adds a bulk to the request.

Created with MrDocs