forked from userver-framework/userver-framework.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
298 lines (296 loc) · 13.8 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta property="og:image" content="logo_in_circle.png"/>
<meta property="og:image:alt" content="userver logo"/>
<link rel="icon" href="favicon.svg">
<title>userver: userver</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<link rel="stylesheet" href="doxygen-like.css">
<script src="highlight.pack.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><a id='logo-anchor' href="index.html"><img alt="Logo" src="logo.svg"/></a></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a class="titlelink" href="index.html">userver
</a>
</div>
<div id="projectbrief"><a class="titlelink" href="index.html">C++ Async Framework (beta)</a></div>
</td>
<td style="float: right; padding-right: 15px; padding-top: 15px;">
<a href="https://github.com/userver-framework/" rel="noopener" target="_blank" class="titlelink">
<img src="github_logo.svg" style="filter: invert(100%);" alt="Github"/>
</a>
<a href="https://t.me/userver_en" rel="noopener" id='telegram_channel' target="_blank" class="titlelink">
<img src="telegram_logo.svg" alt="Telegram"/>
</a>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">userver </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p ><a class="anchor" id="md_en_landing"></a>
<script type="text/javascript">
document.body.style.backgroundColor = 'black';
document.getElementById('titlearea').style.display = 'none';
document.getElementsByClassName('header')[0].style.display = 'none';
</script>
</p>
<div class="landing-description">The C++ Asynchronous Framework</div><p >
<div class="landing-logo" id='landing_logo_id'>
<a href="d6/d2f/md_en_index.html"><img src='logo.svg' alt='userver logo big'/></a>
</div>
</p>
<hr />
<div class="landing-text"> 🐙 userver is the modern open source asynchronous framework with a rich set of abstractions for fast and comfortable creation of C++ microservices, services and utilities. The problem of efficient I/O interactions is solved transparently for the developers:</div><div class="landing-text"> <pre style="padding: 20px; color: silver;white-space: pre-wrap; word-wrap: break-word;">
std::size_t Ins(storages::postgres::Transaction& tr, std::string_view key) {
<span style="color: darkgoldenrod">// Asynchronous execution of the SQL query in transaction. Current thread</span>
<span style="color: darkgoldenrod">// handles other requests while the response from the DB is being received:</span>
<span style="color: #008000">auto</span> res = tr.Execute(<span style="color: darkgreen">"INSERT INTO keys VALUES ($1)"</span>, key);
<span style="color: #008000">return</span> res.RowsAffected();
}
</pre> </div><hr />
<div class="landing-container"> <div class="landing-intro-center"> Micro-services based on userver served more than a billion requests while you were reading this sentence. </div> </div><hr />
<div class="landing-container"> <div class="landing-intro-left"> Technologies for debugging and memory profiling a running production service. </div> <div class="landing-intro-right"> Write <a class="el" href="d9/d72/md_en_userver_tutorial_hello_service.html">your first toy C++ service</a>, evolve it into a <a class="el" href="d6/d08/md_en_userver_tutorial_production_service.html">production ready service</a>. </div> </div><div class="landing-container"> <div class="landing-intro-left"> Efficient asynchronous drivers for databases (MongoDB, PostgreSQL, Redis, ClickHouse, ...) and data transfer protocols (HTTP, GRPC, TCP, ...), tasks construction and cancellation. </div> <div class="landing-intro-right"> Functionality to <a class="el" href="dd/d2c/md_en_schemas_dynamic_configs.html">change the service configuration</a> on-the-fly. Adjust options of the deadline propagation, timeouts, congestion-control without a restart. </div> </div><div class="landing-container"> <div class="landing-intro-left"> Rich set of high-level components for caches, tasks, distributed locking, logging, tracing, statistics, metrics, <a class="el" href="db/dd7/md_en_userver_formats.html">JSON/YAML/BSON</a>. </div> <div class="landing-intro-right"> Comprehensive set of asynchronous low-level synchronization primitives and OS abstractions. </div> </div><hr />
<div class="landing-container"> <div class="landing-intro-center"> Speed of C++, simplicity of Python, coroutine model of Go. </div></div><div class="landing-container"> <div class="landing-intro-center"> Dive into <a class="el" href="d6/d2f/md_en_index.html">the documentation</a> for more details.</div></div><div class="landing-container"><div class="landing-intro-center">
<a href="https://github.com/userver-framework/" rel="noopener" target="_blank" class="titlelink">
<img src="github_logo.svg" width="48" height="48" style="filter: invert(100%);" alt="Github"/>
</a>
<a href="https://t.me/userver_en" rel="noopener" id='telegram_channel' target="_blank" class="titlelink">
<img src="telegram_logo.svg" width="48" height="48" alt="Telegram"/>
</a>
</div></div><div class="landing-container"></div> </div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer"><small>
Generated on Fri Sep 23 2022 12:32:33 for userver by <a href="http://www.doxygen.org/index.html">Doxygen</a> 1.9.5
</small></address>
<script type="text/javascript">
const LOWER_CASE_TRANSLITTERATION_MAPPING = {
"а":"a", "б":"b", "в":"v", "г":"g", "д":"d", "е":"e", "ё":"jo", "ж":"zh",
"з":"z", "и":"i", "й":"jj", "к":"k", "л":"l", "м":"m", "н":"n", "о":"o",
"п":"p", "р":"r", "с":"s", "т":"t", "у":"u", "ф":"f", "х":"x", "ц":"c",
"ч":"ch", "ш":"sh", "щ":"shh", "ъ":"\'", "ы":"y", "ь":"\'", "э":"je",
"ю":"ju", "я":"ja"
};
const DOXYGEN_DIAMOND_STRING = '◆\u00A0' // ◆
function make_id(raw_id) {
return raw_id.toLowerCase().split('').map(function (char) {
return LOWER_CASE_TRANSLITTERATION_MAPPING[char] || char;
}).join('').replace(/\W/g, '');
}
const html_escape = function () {
const p = document.createElement('p');
return function (text) {
p.textContent = text;
return p.innerHTML;
};
}();
function draw_toc() {
let headers = $(':header');
if (headers.length === 0) {
return;
}
let sidenav_content = '<div id="mySidenav" class="sidenav">';
sidenav_content += '<h2>Table of contents</h2>';
headers.each(function() {
let index = parseInt(this.nodeName.substring(1)) - 1;
const header = $(this);
let id = header.attr('id');
if (!id) {
id = make_id(header.text())
header.attr('id', id);
}
let header_text = header.text()
if (header_text.startsWith(DOXYGEN_DIAMOND_STRING)) {
++index;
header_text = header_text.substring(DOXYGEN_DIAMOND_STRING.length);
}
sidenav_content += ''
+ '<a href="#' + id + '" style="padding-left: ' + index * 15 + 'px">'
+ '• ' + html_escape(header_text)
+ '</a>'
;
header.append(' <a class="hoverlink" href="#' + id + '">🔗</a>')
});
sidenav_content += '</div>';
$(sidenav_content).insertAfter('.header');
}
function highlight_code() {
if (window.location.href.indexOf("pp_source") !== -1
|| window.location.href.indexOf("cpp-example") !== -1) {
// Header listing is already nicely highlighted by Doxygen
return;
}
hljs.configure({
tabReplace: ' ' // 4 spaces
});
hljs.registerAliases('sh', {languageName: 'shell'});
hljs.registerAliases('bash', {languageName: 'shell'});
hljs.registerAliases('yml', {languageName: 'yaml'});
hljs.registerAliases('plain', {languageName: 'plaintext'});
hljs.registerAliases('tskv', {languageName: 'plaintext'});
$(".fragment").each(function() {
const node = $(this);
let data = '';
let language = '';
let requires_higlighting = true;
node.children('div.line').each(function(i) {
line = $(this).text();
// Doxygen 1.8.11 workaround to remove line numbers.
// No line numbers added in Doxygen 1.8.13
line = line.replace(/^ *\d+\xA0/, '');
if (i === 0) {
line = line.trimLeft().replace(/^# /, '');
if (line === 'autodetect') {
return true;
} else if (hljs.getLanguage(line)) {
language = line;
return true;
} else {
requires_higlighting = false;
return false;
}
}
data += line + '\n';
});
if (requires_higlighting === false) {
return;
}
if (language !== '') {
data = hljs.highlight(language, data).value;
} else {
data = hljs.highlightAuto(data).value;
}
node.replaceWith('<div class="fragment"><pre>' + data + '</pre></div>');
});
}
function setup_if_landing() {
if (document.getElementById('landing_logo_id') === null) {
return false;
}
$(function() {
const main_nav = $('#main-nav');
main_nav.addClass('main-nav-landing');
main_nav.append('<hr>');
});
return true;
}
function sticky_menu() {
const main_nav = $('#main-nav');
const menu_y_position = 94;
const search_results_window = $('#MSearchResultsWindow');
const search_select_window = $('#MSearchSelectWindow');
var menu_is_sticky = false;
const stick = function () {
if ($(this).scrollTop() > menu_y_position) {
if (menu_is_sticky) return;
search_results_window.addClass('stickySearchResults');
search_select_window.addClass('stickySearchResults');
main_nav.addClass('stickyHeader');
// Prevent page quick movement as the menu sticks to the top
document.body.style.paddingTop = '36px';
menu_is_sticky = true;
} else {
if (!menu_is_sticky) return;
search_results_window.removeClass('stickySearchResults');
search_select_window.removeClass('stickySearchResults');
// 'top' property of the results window is computed by Doxygen JS
// and it may give bad results if the computation is invoked at the
// middle of the page.
//
// Hiding the window. Doxygen will recompute and show it on new
// user input.
search_results_window.hide();
main_nav.removeClass('stickyHeader');
document.body.style.paddingTop = '0px';
menu_is_sticky = false;
}
};
stick(); // on page refresh draw the menu on the right position
$(window).on("scroll", stick);
}
function telegram_channel_language() {
if (/^ru/.test(navigator.language)) {
const channel = $('#telegram_channel');
if (channel) {
channel.attr('href', 'https://t.me/userver_ru');
}
}
}
// We do not use $(function() { ... }); because
// * all the elements (except menue parts) are already parsed up above
// * skipping it speedups page load
// * with it Firefox does not scroll to a JS generated anchor links
telegram_channel_language();
if (!setup_if_landing()) {
draw_toc();
highlight_code();
sticky_menu();
}
</script>
</body>
</html>