Skip to content

Commit ba784ac

Browse files
committed
Update manual reference page
1 parent 553d423 commit ba784ac

1 file changed

Lines changed: 131 additions & 23 deletions

File tree

doc/modules/ROOT/pages/reference.adoc

Lines changed: 131 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
// Distributed under the Boost Software License, Version 1.0. (See accompanying
55
// file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
66
//
7-
// Official repository: https://github.com/boostorg/url
7+
// Official repository: https://github.com/boostorg/http
88
//
99

1010

@@ -17,14 +17,16 @@
1717

1818
| *Types (1/2)*
1919

20+
cpp:boost::http::application[application]
21+
22+
cpp:boost::http::datastore[datastore]
23+
2024
cpp:boost::http::fields[fields]
2125

2226
cpp:boost::http::fields_base[fields_base]
2327

2428
cpp:boost::http::file[file]
2529

26-
cpp:boost::http::file_source[file_source]
27-
2830
cpp:boost::http::header_limits[header_limits]
2931

3032
cpp:boost::http::message_base[message_base]
@@ -33,12 +35,20 @@ cpp:boost::http::metadata[metadata]
3335

3436
cpp:boost::http::parser[parser]
3537

38+
cpp:boost::http::parser_config[parser_config]
39+
40+
cpp:boost::http::parser_config_impl[parser_config_impl]
41+
42+
cpp:boost::http::polystore[polystore]
43+
3644
cpp:boost::http::request[request]
3745

3846
cpp:boost::http::request_base[request_base]
3947

4048
cpp:boost::http::request_parser[request_parser]
4149

50+
| *Types (2/2)*
51+
4252
cpp:boost::http::response[response]
4353

4454
cpp:boost::http::response_base[response_base]
@@ -47,26 +57,32 @@ cpp:boost::http::response_parser[response_parser]
4757

4858
cpp:boost::http::serializer[serializer]
4959

50-
| **Types (2/2)**
60+
cpp:boost::http::serializer_config[serializer_config]
5161

52-
cpp:boost::http::source[source]
62+
cpp:boost::http::serializer_config_impl[serializer_config_impl]
5363

5464
cpp:boost::http::static_request[static_request]
5565

5666
cpp:boost::http::static_response[static_response]
5767

5868
cpp:boost::http::string_body[string_body]
5969

60-
**Functions**
70+
*Type Aliases*
6171

62-
cpp:boost::http::combine_field_values[combine_field_values]
72+
cpp:boost::http::shared_parser_config[shared_parser_config]
6373

64-
cpp:boost::http::install_parser_service[install_parser_service]
74+
cpp:boost::http::shared_serializer_config[shared_serializer_config]
6575

66-
cpp:boost::http::install_serializer_service[install_serializer_service]
76+
*Functions*
77+
78+
cpp:boost::http::combine_field_values[combine_field_values]
6779

6880
cpp:boost::http::int_to_status[int_to_status]
6981

82+
cpp:boost::http::make_parser_config[make_parser_config]
83+
84+
cpp:boost::http::make_serializer_config[make_serializer_config]
85+
7086
cpp:boost::http::obsolete_reason[obsolete_reason]
7187

7288
cpp:boost::http::string_to_field[string_to_field]
@@ -77,9 +93,7 @@ cpp:boost::http::to_status_class[to_status_class]
7793

7894
cpp:boost::http::to_string[to_string]
7995

80-
// cpp:boost::http::operator<<[operator<<]
81-
82-
| **Constants**
96+
| *Constants*
8397

8498
cpp:boost::http::condition[condition]
8599

@@ -101,11 +115,29 @@ cpp:boost::http::status_class[status_class]
101115

102116
cpp:boost::http::version[version]
103117

104-
**Type Traits**
118+
|===
105119

106-
cpp:boost::http::is_source[is_source]
120+
[width=100%]
121+
|===
122+
3+| *Grammar* | *RFC*
123+
124+
| *Types*
107125

108-
| **Grammar**
126+
cpp:boost::http::media_type[media_type]
127+
128+
cpp:boost::http::mime_type[mime_type]
129+
130+
cpp:boost::http::parameter[parameter]
131+
132+
cpp:boost::http::quoted_token_view[quoted_token_view]
133+
134+
cpp:boost::http::upgrade_protocol[upgrade_protocol]
135+
136+
| *Rules*
137+
138+
cpp:boost::http::list_rule[list_rule]
139+
140+
cpp:boost::http::media_type_rule[media_type_rule]
109141

110142
cpp:boost::http::parameter_rule[parameter_rule]
111143

@@ -117,20 +149,96 @@ cpp:boost::http::upgrade_protocol_rule[upgrade_protocol_rule]
117149

118150
cpp:boost::http::upgrade_rule[upgrade_rule]
119151

120-
**Types**
152+
| *Constants*
121153

122-
cpp:boost::http::upgrade_protocol[upgrade_protocol]
154+
cpp:boost::http::tchars[tchars]
123155

124-
cpp:boost::http::parameter[parameter]
156+
|===
125157

126-
cpp:boost::http::quoted_token_view[quoted_token_view]
158+
[width=100%]
159+
|===
160+
3+| *Server* | *RFC*
127161

128-
**Functions**
162+
| *Router Types*
129163

130-
cpp:boost::http::list_rule[list_rule]
164+
cpp:boost::http::basic_router[basic_router]
131165

132-
**Constants**
166+
cpp:boost::http::flat_router[flat_router]
133167

134-
cpp:boost::http::tchars[tchars]
168+
cpp:boost::http::route_params[route_params]
169+
170+
cpp:boost::http::route_params_base[route_params_base]
171+
172+
cpp:boost::http::route_result[route_result]
173+
174+
cpp:boost::http::route_task[route_task]
175+
176+
cpp:boost::http::route_what[route_what]
177+
178+
cpp:boost::http::router[router]
179+
180+
cpp:boost::http::router_options[router_options]
181+
182+
*Router Constants*
183+
184+
cpp:boost::http::route_close[route_close]
185+
186+
cpp:boost::http::route_done[route_done]
187+
188+
cpp:boost::http::route_next[route_next]
189+
190+
cpp:boost::http::route_next_route[route_next_route]
191+
192+
*Router Functions*
193+
194+
cpp:boost::http::route_error[route_error]
195+
196+
| *Middleware*
197+
198+
cpp:boost::http::cors[cors]
199+
200+
cpp:boost::http::cors_options[cors_options]
201+
202+
cpp:boost::http::serve_static[serve_static]
203+
204+
cpp:boost::http::serve_static_options[serve_static_options]
205+
206+
cpp:boost::http::dotfiles_policy[dotfiles_policy]
207+
208+
*File Serving*
209+
210+
cpp:boost::http::send_file_info[send_file_info]
211+
212+
cpp:boost::http::send_file_options[send_file_options]
213+
214+
cpp:boost::http::send_file_result[send_file_result]
215+
216+
cpp:boost::http::send_file_init[send_file_init]
217+
218+
cpp:boost::http::format_http_date[format_http_date]
219+
220+
*Caching*
221+
222+
cpp:boost::http::etag[etag]
223+
224+
cpp:boost::http::etag_options[etag_options]
225+
226+
cpp:boost::http::is_fresh[is_fresh]
227+
228+
| *Utilities*
229+
230+
`mime_types::`cpp:boost::http::mime_types::lookup[lookup]
231+
232+
`mime_types::`cpp:boost::http::mime_types::extension[extension]
233+
234+
`mime_types::`cpp:boost::http::mime_types::charset[charset]
235+
236+
`mime_types::`cpp:boost::http::mime_types::content_type[content_type]
237+
238+
`statuses::`cpp:boost::http::statuses::is_empty[is_empty]
239+
240+
`statuses::`cpp:boost::http::statuses::is_redirect[is_redirect]
241+
242+
`statuses::`cpp:boost::http::statuses::is_retry[is_retry]
135243

136244
|===

0 commit comments

Comments
 (0)