Orbit Framework 2.0.0
A high-performance asynchronous C++20 HTTP server framework.
Loading...
Searching...
No Matches
QuicHttp3Session.hpp
Go to the documentation of this file.
1#pragma once
3
4#include <nghttp3/nghttp3.h>
5#include <deque>
6#include <memory>
7#include <string>
8#include <unordered_map>
9#include <vector>
13
14namespace orbit::server {
15
16class QuicConnection;
17class Http3ResponseWriter;
18
19namespace quic::detail {
20
30public:
32 void push(std::string chunk);
34 size_t hand_out(nghttp3_vec* vec, size_t n);
36 void ack(uint64_t bytes);
38 bool has_unsent() const { return handed_out_ < chunks_.size(); }
40 size_t held() const { return chunks_.size(); }
41
42private:
43 std::deque<std::string> chunks_;
44 size_t handed_out_ = 0; // chunks at the front given to nghttp3
45 uint64_t front_acked_ = 0; // acknowledged bytes of chunks_.front()
46};
47
50 std::vector<std::string> storage;
51 std::vector<nghttp3_nv> nvs;
52};
53
57
58} // namespace quic::detail
59
62 int64_t stream_id;
64 std::string path; // :path as received (decoded at dispatch)
65 std::string body;
66 std::string cookie; // all cookie fields joined (they may arrive split)
67 bool headers_complete = false;
68 bool dispatched = false;
69 bool body_too_large = false;
70
72 bool streaming = false; // body produced by write_chunk() until end()
73 bool ended = false;
74 int file_fd = -1; // file body: bytes [file_offset, file_end)
75 int64_t file_offset = 0;
76 int64_t file_end = 0;
77 std::weak_ptr<Http3ResponseWriter> writer; // for is_open() / on_close() (#197)
78
79 explicit Http3Stream(int64_t id) : stream_id(id) {}
81};
82
91public:
96 explicit QuicHttp3Session(QuicConnection& quic_conn);
98
103 bool init();
104
109 nghttp3_conn* get_conn() const { return httpconn_; }
110
113 nghttp3_ssize process_stream_data(int64_t stream_id, const uint8_t* data, size_t datalen, bool fin);
114
118 void submit_response(int64_t stream_id, http::HttpResponse& response, bool has_body, bool streaming = false);
119 void submit_data(int64_t stream_id, std::string_view chunk);
120 void end_stream(int64_t stream_id);
121
122private:
124 nghttp3_conn* httpconn_{nullptr};
125 std::unordered_map<int64_t, std::shared_ptr<Http3Stream>> streams_;
126
127 // nghttp3 callbacks
128 static int on_acked_stream_data(nghttp3_conn *conn, int64_t stream_id, uint64_t datalen, void *conn_user_data, void *stream_user_data);
129 static int on_stream_close(nghttp3_conn *conn, int64_t stream_id, uint64_t app_error_code, void *conn_user_data, void *stream_user_data);
130 static int on_recv_data(nghttp3_conn *conn, int64_t stream_id, const uint8_t *data, size_t datalen, void *conn_user_data, void *stream_user_data);
131 static int on_deferred_consume(nghttp3_conn *conn, int64_t stream_id, size_t consumed, void *conn_user_data, void *stream_user_data);
132 static int on_begin_headers(nghttp3_conn *conn, int64_t stream_id, void *conn_user_data, void *stream_user_data);
133 static int on_recv_header(nghttp3_conn *conn, int64_t stream_id, int32_t token, nghttp3_rcbuf *name, nghttp3_rcbuf *value, uint8_t flags, void *conn_user_data, void *stream_user_data);
134 static int on_end_headers(nghttp3_conn *conn, int64_t stream_id, int fin, void *conn_user_data, void *stream_user_data);
135 static int on_end_stream(nghttp3_conn *conn, int64_t stream_id, void *conn_user_data, void *stream_user_data);
136 static nghttp3_ssize read_data(nghttp3_conn *conn, int64_t stream_id, nghttp3_vec *vec, size_t veccnt, uint32_t *pflags, void *conn_user_data, void *stream_user_data);
137
138 std::shared_ptr<Http3Stream> get_or_create_stream(int64_t stream_id);
139 void handle_request(std::shared_ptr<Http3Stream> stream);
140 void submit_status(int64_t stream_id, http::HttpStatus status);
141};
142
150public:
151 Http3ResponseWriter(std::weak_ptr<QuicConnection> conn, int64_t stream_id, network::Proactor& proactor,
152 concurrency::ThreadPool& thread_pool, bool suppress_body = false);
153
154 void add_interceptor(Interceptor interceptor) override;
155 void set_header(const std::string& key, const std::string& value) override;
156 network::Proactor& proactor() override { return proactor_; }
158
159 void send(http::HttpResponse&& response) override;
160 void send_headers(http::HttpResponse& response) override;
161 void write_chunk(std::string_view chunk) override;
162 void end() override;
163 void send_sse_event(std::string_view data, std::string_view event = "", std::string_view id = "") override;
164 void upgrade_to_raw_stream(std::function<void(std::string_view)> on_data, std::function<void()> on_close) override;
165 void read_body_stream(std::function<void(std::string_view)> on_data, std::function<void()> on_end) override;
166
167private:
168 std::weak_ptr<QuicConnection> conn_;
169 int64_t stream_id_;
172 std::unordered_map<std::string, std::string> default_headers_;
173 std::vector<Interceptor> interceptors_;
174 bool headers_sent_{false};
175 bool suppress_body_{false}; // HEAD request: headers only
176
177 // The request body, kept alive by owner, for read_body_stream().
178 std::shared_ptr<void> body_owner_;
179 std::string_view body_;
180
183 template <typename Fn> void with_session(Fn&& fn);
184
185 friend class QuicHttp3Session;
186};
187
188} // namespace server
Definition ThreadPool.hpp:13
Represents an HTTP response to be sent to a client.
Definition HttpResponse.hpp:107
Abstract interface for writing HTTP responses.
Definition ResponseWriter.hpp:23
void on_close(std::function< void()> callback)
Runs callback once when the writer closes (see is_open()), or right away if it already has.
std::function< void(HttpResponse &)> Interceptor
Definition ResponseWriter.hpp:27
Definition Proactor.hpp:9
ResponseWriter for HTTP/3 streams.
Definition QuicHttp3Session.hpp:149
Http3ResponseWriter(std::weak_ptr< QuicConnection > conn, int64_t stream_id, network::Proactor &proactor, concurrency::ThreadPool &thread_pool, bool suppress_body=false)
void add_interceptor(Interceptor interceptor) override
Adds an interceptor to modify the response before it is sent.
std::unordered_map< std::string, std::string > default_headers_
Definition QuicHttp3Session.hpp:172
std::weak_ptr< QuicConnection > conn_
Definition QuicHttp3Session.hpp:168
void end() override
Ends a chunked response stream.
void set_header(const std::string &key, const std::string &value) override
Adds a default header that will be included in the final response.
concurrency::ThreadPool & thread_pool_
Definition QuicHttp3Session.hpp:171
std::vector< Interceptor > interceptors_
Definition QuicHttp3Session.hpp:173
void send_sse_event(std::string_view data, std::string_view event="", std::string_view id="") override
Sends a Server-Sent Events (SSE) message.
void send_headers(http::HttpResponse &response) override
Sends only the HTTP headers.
concurrency::ThreadPool & thread_pool() override
Gets the thread pool to offload blocking tasks.
Definition QuicHttp3Session.hpp:157
void read_body_stream(std::function< void(std::string_view)> on_data, std::function< void()> on_end) override
Asynchronously streams the incoming HTTP request body.
void upgrade_to_raw_stream(std::function< void(std::string_view)> on_data, std::function< void()> on_close) override
Upgrades the connection to a raw bi-directional byte stream.
bool headers_sent_
Definition QuicHttp3Session.hpp:174
network::Proactor & proactor_
Definition QuicHttp3Session.hpp:170
std::shared_ptr< void > body_owner_
Definition QuicHttp3Session.hpp:178
void apply_response_hooks(http::HttpResponse &response)
void write_chunk(std::string_view chunk) override
Streams a chunk of data (for Chunked Transfer Encoding).
std::string_view body_
Definition QuicHttp3Session.hpp:179
int64_t stream_id_
Definition QuicHttp3Session.hpp:169
network::Proactor & proactor() override
Gets the underlying Proactor to dispatch async operations.
Definition QuicHttp3Session.hpp:156
bool suppress_body_
Definition QuicHttp3Session.hpp:175
void with_session(Fn &&fn)
Runs fn on the session with the connection locked, then flushes.
void send(http::HttpResponse &&response) override
Sends a complete HTTP response.
Represents a single QUIC connection.
Definition QuicConnection.hpp:62
Manages an HTTP/3 session over a QUIC connection.
Definition QuicHttp3Session.hpp:90
void end_stream(int64_t stream_id)
void handle_request(std::shared_ptr< Http3Stream > stream)
nghttp3_conn * httpconn_
Definition QuicHttp3Session.hpp:124
std::shared_ptr< Http3Stream > get_or_create_stream(int64_t stream_id)
static int on_end_headers(nghttp3_conn *conn, int64_t stream_id, int fin, void *conn_user_data, void *stream_user_data)
nghttp3_conn * get_conn() const
Gets the underlying nghttp3 connection.
Definition QuicHttp3Session.hpp:109
std::unordered_map< int64_t, std::shared_ptr< Http3Stream > > streams_
Definition QuicHttp3Session.hpp:125
static int on_end_stream(nghttp3_conn *conn, int64_t stream_id, void *conn_user_data, void *stream_user_data)
void submit_status(int64_t stream_id, http::HttpStatus status)
bool init()
Initializes the HTTP/3 session.
void submit_response(int64_t stream_id, http::HttpResponse &response, bool has_body, bool streaming=false)
static nghttp3_ssize read_data(nghttp3_conn *conn, int64_t stream_id, nghttp3_vec *vec, size_t veccnt, uint32_t *pflags, void *conn_user_data, void *stream_user_data)
static int on_stream_close(nghttp3_conn *conn, int64_t stream_id, uint64_t app_error_code, void *conn_user_data, void *stream_user_data)
static int on_recv_header(nghttp3_conn *conn, int64_t stream_id, int32_t token, nghttp3_rcbuf *name, nghttp3_rcbuf *value, uint8_t flags, void *conn_user_data, void *stream_user_data)
static int on_begin_headers(nghttp3_conn *conn, int64_t stream_id, void *conn_user_data, void *stream_user_data)
nghttp3_ssize process_stream_data(int64_t stream_id, const uint8_t *data, size_t datalen, bool fin)
static int on_recv_data(nghttp3_conn *conn, int64_t stream_id, const uint8_t *data, size_t datalen, void *conn_user_data, void *stream_user_data)
void submit_data(int64_t stream_id, std::string_view chunk)
QuicConnection & quic_conn_
Definition QuicHttp3Session.hpp:123
QuicHttp3Session(QuicConnection &quic_conn)
Constructs a QuicHttp3Session.
static int on_acked_stream_data(nghttp3_conn *conn, int64_t stream_id, uint64_t datalen, void *conn_user_data, void *stream_user_data)
static int on_deferred_consume(nghttp3_conn *conn, int64_t stream_id, size_t consumed, void *conn_user_data, void *stream_user_data)
Response body bytes handed to nghttp3, kept until the peer ACKs them.
Definition QuicHttp3Session.hpp:29
void ack(uint64_t bytes)
Frees chunks whose bytes are all acknowledged.
size_t handed_out_
Definition QuicHttp3Session.hpp:44
size_t held() const
Chunks still held (not yet handed out, or not yet acknowledged).
Definition QuicHttp3Session.hpp:40
size_t hand_out(nghttp3_vec *vec, size_t n)
Points up to n vecs at chunks not handed out yet; returns how many.
std::deque< std::string > chunks_
Definition QuicHttp3Session.hpp:43
void push(std::string chunk)
Appends a chunk to send. Empty chunks are ignored.
uint64_t front_acked_
Definition QuicHttp3Session.hpp:45
bool has_unsent() const
True if some chunk has not been handed out yet.
Definition QuicHttp3Session.hpp:38
HttpStatus
Standard HTTP status codes.
Definition HttpResponse.hpp:17
Http3HeaderBlock build_response_headers(const http::HttpResponse &response)
Definition Http2Session.hpp:18
Represents an incoming HTTP request.
Definition HttpRequest.hpp:54
One request/response exchange on an HTTP/3 stream.
Definition QuicHttp3Session.hpp:61
bool headers_complete
Definition QuicHttp3Session.hpp:67
bool body_too_large
Definition QuicHttp3Session.hpp:69
std::string cookie
Definition QuicHttp3Session.hpp:66
Http3Stream(int64_t id)
Definition QuicHttp3Session.hpp:79
std::string path
Definition QuicHttp3Session.hpp:64
int64_t stream_id
Definition QuicHttp3Session.hpp:62
int64_t file_end
Definition QuicHttp3Session.hpp:76
std::string body
Definition QuicHttp3Session.hpp:65
quic::detail::SentChunks chunks
Definition QuicHttp3Session.hpp:71
bool dispatched
Definition QuicHttp3Session.hpp:68
std::weak_ptr< Http3ResponseWriter > writer
Definition QuicHttp3Session.hpp:77
int file_fd
Definition QuicHttp3Session.hpp:74
bool ended
Definition QuicHttp3Session.hpp:73
bool streaming
Definition QuicHttp3Session.hpp:72
http::HttpRequest request
Definition QuicHttp3Session.hpp:63
int64_t file_offset
Definition QuicHttp3Session.hpp:75
Owns the strings an nghttp3_nv list points into.
Definition QuicHttp3Session.hpp:49
std::vector< std::string > storage
Definition QuicHttp3Session.hpp:50
std::vector< nghttp3_nv > nvs
Definition QuicHttp3Session.hpp:51