request.hpp

Go to the documentation of this file.

#pragma once
 
/// @file
/// @brief Valkey/Redis futures for storages::redis::Client and storages::redis::Transaction.
 
#include <iterator>
#include <memory>
#include <optional>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <vector>
 
#include <userver/compiler/impl/lifetime.hpp>
#include <userver/engine/awaitable.hpp>
#include <userver/formats/json/value.hpp>
#include <userver/storages/redis/exception.hpp>
#include <userver/storages/redis/fwd.hpp>
#include <userver/storages/redis/hexpiretime_reply.hpp>
#include <userver/storages/redis/hpexpiretime_reply.hpp>
#include <userver/storages/redis/pttl_reply.hpp>
#include <userver/storages/redis/reply_types.hpp>
#include <userver/storages/redis/request_data_base.hpp>
#include <userver/storages/redis/scan_tag.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace storages::redis {
 
template <ScanTag TScanTag>
class RequestScanData;
 
/// @brief Valkey or Redis future for a non-scan and non-eval responses.
///
/// Member functions of classes storages::redis::Client and storages::redis::Transaction that do send request to the
/// Redis return this type or storages::redis::ScanRequest.
template <typename ResultType, typename ReplyType>
class [[nodiscard]] Request final {
public:
    using Result = ResultType;
    using Reply = ReplyType;
 
    explicit Request(std::unique_ptr<RequestDataBase<ReplyType>>&& impl)
        : impl_(std::move(impl))
    {}
 
    /// Wait for the request to finish on Redis server, server or request errors (if any) are logged but not thrown.
    ///
    /// @throws Exceptions on misuse (for example, calling Wait() on a single result from a transaction before waiting
    /// for the transaction itself).
    void Wait() { impl_->Wait(); }
 
    /// Ignore the query result and do not wait for the Redis server to finish executing it
    void IgnoreResult() const noexcept {}
 
    /// Wait for the request to finish on Redis server and get the result
    /// @throws server or request related exceptions
    ReplyType Get(const std::string& request_description = {}) { return impl_->Get(request_description); }
 
    /// Satisfies @ref engine::Awaitable, for use with @ref engine::WaitAnyContext and friends.
    engine::AwaitableToken GetAwaitableToken() noexcept USERVER_IMPL_LIFETIME_BOUND {
        return impl_->GetAwaitableToken();
    }
 
    template <typename T1, typename T2>
    friend class RequestEval;
 
    template <typename T1, typename T2>
    friend class RequestEvalSha;
 
    template <ScanTag TScanTag>
    friend class RequestScanData;
 
    template <typename T1>
    friend class RequestGeneric;
 
private:
    ReplyPtr GetRaw() { return impl_->GetRaw(); }
 
    std::unique_ptr<RequestDataBase<ReplyType>> impl_;
};
 
/// @brief Redis future for a SCAN-like responses.
///
/// Member functions of classes storages::redis::Client and storages::redis::Transaction that do send SCAN-like request
/// to the Redis return this type or storages::redis::ScanRequest.
template <ScanTag TScanTag>
class ScanRequest final {
public:
    using ReplyElem = typename ScanReplyElem<TScanTag>::type;
 
    explicit ScanRequest(std::unique_ptr<RequestScanDataBase<TScanTag>>&& impl)
        : impl_(std::move(impl))
    {}
 
    template <typename T = std::vector<ReplyElem>>
    T GetAll(std::string request_description) {
        SetRequestDescription(std::move(request_description));
        return GetAll<T>();
    }
 
    template <typename T = std::vector<ReplyElem>>
    T GetAll() {
        return T{begin(), end()};
    }
 
    void SetRequestDescription(std::string request_description) {
        impl_->SetRequestDescription(std::move(request_description));
    }
 
    class Iterator {
    public:
        using iterator_category = std::input_iterator_tag;
        using difference_type = ptrdiff_t;
        using value_type = ReplyElem;
        using reference = value_type&;
        using pointer = value_type*;
 
        explicit Iterator(ScanRequest* stream)
            : stream_(stream)
        {
            if (stream_ && !stream_->HasMore()) {
                stream_ = nullptr;
            }
        }
 
        class ReplyElemHolder {
        public:
            ReplyElemHolder(value_type reply_elem)
                : reply_elem_(std::move(reply_elem))
            {}
 
            value_type& operator*() { return reply_elem_; }
 
        private:
            value_type reply_elem_;
        };
 
        ReplyElemHolder operator++(int) {
            ReplyElemHolder old_value(stream_->Current());
            ++*this;
            return old_value;
        }
 
        Iterator& operator++() {
            stream_->Get();
            if (!stream_->HasMore()) {
                stream_ = nullptr;
            }
            return *this;
        }
 
        reference operator*() const { return stream_->Current(); }
 
        pointer operator->() const { return &**this; }
 
        bool operator==(const Iterator& rhs) const { return stream_ == rhs.stream_; }
 
    private:
        ScanRequest* stream_;
    };
 
    Iterator begin() { return Iterator(this); }
    Iterator end() { return Iterator(nullptr); }
 
    class GetAfterEofException : public Exception {
    public:
        using Exception::Exception;
    };
 
private:
    ReplyElem& Current() { return impl_->Current(); }
 
    ReplyElem Get() { return impl_->Get(); }
 
    bool HasMore() { return !impl_->Eof(); }
 
    friend class Iterator;
 
    std::unique_ptr<RequestScanDataBase<TScanTag>> impl_;
};
 
/// @name Valkey/Redis futures aliases
/// @{
using RequestAppend = Request<size_t>;
using RequestBitop = Request<size_t>;
using RequestDbsize = Request<size_t>;
using RequestDecr = Request<int64_t>;
using RequestDel = Request<size_t>;
using RequestUnlink = Request<size_t>;
using RequestGenericCommon = Request<ReplyData>;
using RequestEvalCommon = Request<ReplyData>;
using RequestEvalShaCommon = Request<ReplyData>;
using RequestScriptLoad = Request<std::string>;
using RequestExec = Request<ReplyData, void>;
using RequestExists = Request<size_t>;
using RequestExpire = Request<ExpireReply>;
using RequestGeoadd = Request<size_t>;
using RequestGeopos = Request<std::vector<std::optional<Point>>>;
using RequestGeoradius = Request<std::vector<GeoPoint>>;
using RequestGeosearch = Request<std::vector<GeoPoint>>;
using RequestGet = Request<std::optional<std::string>>;
using RequestGetdel = Request<std::optional<std::string>>;
using RequestGetset = Request<std::optional<std::string>>;
using RequestHdel = Request<size_t>;
using RequestHexists = Request<size_t>;
using RequestHget = Request<std::optional<std::string>>;
using RequestHgetall = Request<std::unordered_map<std::string, std::string>>;
using RequestHincrby = Request<int64_t>;
using RequestHincrbyfloat = Request<double>;
using RequestHkeys = Request<std::vector<std::string>>;
using RequestHlen = Request<size_t>;
using RequestHmget = Request<std::vector<std::optional<std::string>>>;
using RequestHmset = Request<StatusOk, void>;
using RequestHscan = ScanRequest<ScanTag::kHscan>;
using RequestHset = Request<HsetReply>;
using RequestHsetnx = Request<size_t, bool>;
using RequestHvals = Request<std::vector<std::string>>;
using RequestIncr = Request<int64_t>;
using RequestKeys = Request<std::vector<std::string>>;
using RequestLindex = Request<std::optional<std::string>>;
using RequestLlen = Request<size_t>;
using RequestLpop = Request<std::optional<std::string>>;
using RequestLpush = Request<size_t>;
using RequestLpushx = Request<size_t>;
using RequestLrange = Request<std::vector<std::string>>;
using RequestLrem = Request<size_t>;
using RequestLtrim = Request<StatusOk, void>;
using RequestMget = Request<std::vector<std::optional<std::string>>>;
using RequestMset = Request<StatusOk, void>;
using RequestPersist = Request<PersistReply>;
using RequestPexpire = Request<ExpireReply>;
using RequestPing = Request<StatusPong, void>;
using RequestPingMessage = Request<std::string>;
using RequestPublish = Request<size_t>;
using RequestRename = Request<StatusOk, void>;
using RequestRpop = Request<std::optional<std::string>>;
using RequestRpush = Request<size_t>;
using RequestRpushx = Request<size_t>;
using RequestSadd = Request<size_t>;
using RequestScan = ScanRequest<ScanTag::kScan>;
using RequestScard = Request<size_t>;
using RequestSet = Request<StatusOk, void>;
using RequestSetIfExist = Request<std::optional<StatusOk>, bool>;
using RequestSetIfNotExist = Request<std::optional<StatusOk>, bool>;
using RequestSetIfNotExistOrGet = Request<std::optional<std::string>>;
using RequestSetOptions = Request<SetReply>;
using RequestSetex = Request<StatusOk, void>;
using RequestSetAndGetPrevious = Request<std::optional<std::string>>;
using RequestSismember = Request<size_t>;
using RequestSmembers = Request<std::unordered_set<std::string>>;
using RequestSrandmember = Request<std::optional<std::string>>;
using RequestSrandmembers = Request<std::vector<std::string>>;
using RequestSrem = Request<size_t>;
using RequestSscan = ScanRequest<ScanTag::kSscan>;
using RequestStrlen = Request<size_t>;
using RequestTime = Request<std::chrono::system_clock::time_point>;
using RequestTtl = Request<TtlReply>;
using RequestType = Request<KeyType>;
using RequestZadd = Request<size_t>;
using RequestZaddIncr = Request<double>;
using RequestZaddIncrExisting = Request<std::optional<double>>;
using RequestZcard = Request<size_t>;
using RequestZcount = Request<size_t>;
using RequestZrange = Request<std::vector<std::string>>;
using RequestZrangeWithScores = Request<std::vector<MemberScore>>;
using RequestZrangebyscore = Request<std::vector<std::string>>;
using RequestZrangebyscoreWithScores = Request<std::vector<MemberScore>>;
using RequestZrem = Request<size_t>;
using RequestZremrangebyrank = Request<size_t>;
using RequestZremrangebyscore = Request<size_t>;
using RequestZscan = ScanRequest<ScanTag::kZscan>;
using RequestZscore = Request<std::optional<double>>;
 
// Hash field expiration commands
using RequestHexpire = Request<std::vector<HexpireReply>>;
using RequestHexpiretime = Request<std::vector<HexpiretimeReply>>;
using RequestHpexpiretime = Request<std::vector<HpexpiretimeReply>>;
using RequestHttl = Request<std::vector<TtlReply>>;
using RequestHpttl = Request<std::vector<PttlReply>>;
using RequestHpersist = Request<std::vector<HpersistReply>>;
using RequestHgetex = Request<std::vector<std::optional<std::string>>>;
using RequestHsetex = Request<HsetexReply>;
 
// JSON module commands
using RequestJsonSet = Request<StatusOk, void>;
using RequestJsonSetIfExist = Request<std::optional<StatusOk>, bool>;
using RequestJsonSetIfNotExist = Request<std::optional<StatusOk>, bool>;
using RequestJsonGet = Request<std::optional<formats::json::Value>>;
using RequestJsonMget = Request<std::vector<std::optional<formats::json::Value>>>;
using RequestJsonMset = Request<StatusOk, void>;
/// @}
 
}  // namespace storages::redis
 
USERVER_NAMESPACE_END