-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathConfiguringServer.html
More file actions
150 lines (148 loc) · 10.4 KB
/
ConfiguringServer.html
File metadata and controls
150 lines (148 loc) · 10.4 KB
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
<!-- HTML header for doxygen 1.9.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kourier: Configuring Server</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Noto+Sans:ital,wght@0,100..900;1,100..900&family=Noto+Sans+Mono:wght@100..900&display=swap" rel="stylesheet">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.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">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Kourier<span id="projectnumber"> 1.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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 -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('ConfiguringServer.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">Configuring Server</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="el" href="classKourier_1_1HttpServer.html">HttpServer</a> provides the <a class="el" href="classKourier_1_1HttpServer.html#a0b295e5fb420a826be8f3b931476632d">setServerOption</a> and <a class="el" href="classKourier_1_1HttpServer.html#ab20cdaa2ef7e46dfe07b22ba5fe33e6b">serverOption</a> methods that you can use to configure and check the server's configuration.</p>
<p>The <a class="el" href="classKourier_1_1HttpServer.html#aa236ac45bbe9e480b4748c345087e424">ServerOption</a> enum describes the server options that you can configure. Default, minimum, and maximum values for these options are shown in the table below, and you can call <a class="el" href="classKourier_1_1HttpServer.html#ab6df1c2998a2019aba5d3e7ecfb54fce">errorMessage</a> to get a description of the error if <a class="el" href="classKourier_1_1HttpServer.html#a0b295e5fb420a826be8f3b931476632d">setServerOption</a> returns false.</p>
<p><a class="el" href="classKourier_1_1HttpServer.html">HttpServer</a> applies the configuration you set when it starts. If you change any configuration for an already running server, <a class="el" href="classKourier_1_1HttpServer.html">HttpServer</a> will only use it the next time it starts.</p>
<p>You can call <a class="el" href="classKourier_1_1HttpServer.html#acdf94d6c0ff17a9f77f0437f75b86695">HttpServer::setTlsConfiguration</a> to configure TLS encryption for <a class="el" href="classKourier_1_1HttpServer.html">HttpServer</a> according to a given <a class="el" href="classKourier_1_1TlsConfiguration.html">TlsConfiguration</a>.</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Option </th><th class="markdownTableHeadNone">Default Value </th><th class="markdownTableHeadNone">Min Value </th><th class="markdownTableHeadNone">Max Value </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">WorkerCount </td><td class="markdownTableBodyNone">QThread::idealThreadCount() </td><td class="markdownTableBodyNone">1 (0 sets max value) </td><td class="markdownTableBodyNone">QThread::idealThreadCount() </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">TcpServerBacklogSize </td><td class="markdownTableBodyNone">4096 </td><td class="markdownTableBodyNone">1 </td><td class="markdownTableBodyNone">std::numeric_limits<int>::max() </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">IdleTimeoutInSecs </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">std::numeric_limits<int>::max() </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">RequestTimeoutInSecs </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">0 </td><td class="markdownTableBodyNone">std::numeric_limits<int>::max() </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">MaxHeaderNameSize </td><td class="markdownTableBodyNone">1024 </td><td class="markdownTableBodyNone">1 (0 sets max value) </td><td class="markdownTableBodyNone">std::numeric_limits<uint16_t>::max() </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">MaxTrailerNameSize </td><td class="markdownTableBodyNone">1024 </td><td class="markdownTableBodyNone">1 (0 sets max value) </td><td class="markdownTableBodyNone">std::numeric_limits<uint16_t>::max() </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">MaxHeaderValueSize </td><td class="markdownTableBodyNone">8192 </td><td class="markdownTableBodyNone">1 (0 sets max value) </td><td class="markdownTableBodyNone">std::numeric_limits<uint16_t>::max() </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">MaxTrailerValueSize </td><td class="markdownTableBodyNone">8192 </td><td class="markdownTableBodyNone">1 (0 sets max value) </td><td class="markdownTableBodyNone">std::numeric_limits<uint16_t>::max() </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">MaxHeaderLineCount </td><td class="markdownTableBodyNone">64 </td><td class="markdownTableBodyNone">1 (0 sets max value) </td><td class="markdownTableBodyNone">128 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">MaxTrailerLineCount </td><td class="markdownTableBodyNone">64 </td><td class="markdownTableBodyNone">1 (0 sets max value) </td><td class="markdownTableBodyNone">128 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">MaxUrlSize </td><td class="markdownTableBodyNone">8192 </td><td class="markdownTableBodyNone">1 (0 sets max value) </td><td class="markdownTableBodyNone">std::numeric_limits<int64_t>::max() </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">MaxChunkMetadataSize </td><td class="markdownTableBodyNone">1024 </td><td class="markdownTableBodyNone">1 (0 sets max value) </td><td class="markdownTableBodyNone">std::numeric_limits<int64_t>::max() </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">MaxRequestSize </td><td class="markdownTableBodyNone">32MB (2<sup>25</sup>) </td><td class="markdownTableBodyNone">1 (0 sets max value) </td><td class="markdownTableBodyNone">std::numeric_limits<int64_t>::max() </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">MaxBodySize </td><td class="markdownTableBodyNone">32MB (2<sup>25</sup>) </td><td class="markdownTableBodyNone">1 (0 sets max value) </td><td class="markdownTableBodyNone">std::numeric_limits<int64_t>::max() </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">MaxConnectionCount </td><td class="markdownTableBodyNone">std::numeric_limits<int64_t>::max() </td><td class="markdownTableBodyNone">1 (0 sets max value) </td><td class="markdownTableBodyNone">std::numeric_limits<int64_t>::max() </td></tr>
</table>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.6-->
<!-- start footer part -->
</body>
</html>