Orbit Framework 2.0.0
A high-performance asynchronous C++20 HTTP server framework.
Loading...
Searching...
No Matches
DistributedRateLimiter.hpp
Go to the documentation of this file.
1#pragma once
3#include <string>
4#include <chrono>
5#include <functional>
6#include <memory>
10
11namespace orbit::middleware {
12
22public:
24 using KeyFunction = std::function<std::string(const http::HttpRequest&)>;
25
37 DistributedRateLimiter(const std::string& redis_host, int redis_port, size_t max_requests,
38 std::chrono::seconds window, KeyFunction key = nullptr,
39 bool allow_when_unavailable = false);
40
47 bool operator()(http::HttpRequest& req, std::shared_ptr<http::ResponseWriter> writer);
48
49private:
51 std::chrono::seconds window_;
54 std::unique_ptr<database::RedisClient> redis_;
55};
56
58inline auto distributed_rate_limit(const std::string& redis_host, int redis_port, size_t max_requests,
59 std::chrono::seconds window,
61 bool allow_when_unavailable = false) {
62 return [limiter = std::make_shared<DistributedRateLimiter>(redis_host, redis_port, max_requests, window,
63 std::move(key), allow_when_unavailable)]
64 (http::HttpRequest& req, std::shared_ptr<http::ResponseWriter> writer) -> bool {
65 return (*limiter)(req, writer);
66 };
67}
68
69} // namespace middleware
Fixed-window rate limiter shared across instances through Redis.
Definition DistributedRateLimiter.hpp:21
bool operator()(http::HttpRequest &req, std::shared_ptr< http::ResponseWriter > writer)
Middleware execution operator.
DistributedRateLimiter(const std::string &redis_host, int redis_port, size_t max_requests, std::chrono::seconds window, KeyFunction key=nullptr, bool allow_when_unavailable=false)
Constructs a new Distributed Rate Limiter.
KeyFunction key_
Definition DistributedRateLimiter.hpp:52
bool allow_when_unavailable_
Definition DistributedRateLimiter.hpp:53
std::chrono::seconds window_
Definition DistributedRateLimiter.hpp:51
size_t max_requests_
Definition DistributedRateLimiter.hpp:50
std::function< std::string(const http::HttpRequest &)> KeyFunction
Identifies the client; defaults to req.client_ip (see RateLimitOptions::key).
Definition DistributedRateLimiter.hpp:24
std::unique_ptr< database::RedisClient > redis_
Definition DistributedRateLimiter.hpp:54
Definition HttpRequest.hpp:19
auto distributed_rate_limit(const std::string &redis_host, int redis_port, size_t max_requests, std::chrono::seconds window, DistributedRateLimiter::KeyFunction key=nullptr, bool allow_when_unavailable=false)
Creates a DistributedRateLimiter middleware; see its constructor for parameters.
Definition DistributedRateLimiter.hpp:58
Represents an incoming HTTP request.
Definition HttpRequest.hpp:54