forked from fhessel/esp32_https_server
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHTTPServer_8hpp_source.html
More file actions
108 lines (106 loc) · 17.2 KB
/
HTTPServer_8hpp_source.html
File metadata and controls
108 lines (106 loc) · 17.2 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
<!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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ESP32 HTTPS Server: /home/frank/Projekte/esp32/https_server/esp32_https_server/src/HTTPServer.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></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>
<script type="text/javascript">
$(document).ready(initResizable);
</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" />
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ESP32 HTTPS Server
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
$(document).ready(function(){initNavTree('HTTPServer_8hpp_source.html','');});
</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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">HTTPServer.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef SRC_HTTPSERVER_HPP_</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define SRC_HTTPSERVER_HPP_</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Standard library</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// Arduino stuff</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <Arduino.h></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// Required for sockets</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "lwip/netdb.h"</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#undef read</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "lwip/sockets.h"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "lwip/inet.h"</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// Internal includes</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "HTTPSServerConstants.hpp"</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "HTTPHeaders.hpp"</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "HTTPHeader.hpp"</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "ResourceNode.hpp"</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "ResourceResolver.hpp"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "ResolvedResource.hpp"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "HTTPConnection.hpp"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span><a class="code" href="namespacehttpsserver.html">httpsserver</a> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classhttpsserver_1_1HTTPServer.html"> 30</a></span> <span class="keyword">class </span><a class="code" href="classhttpsserver_1_1HTTPServer.html">HTTPServer</a> : <span class="keyword">public</span> <a class="code" href="classhttpsserver_1_1ResourceResolver.html">ResourceResolver</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="classhttpsserver_1_1HTTPServer.html">HTTPServer</a>(<span class="keyword">const</span> uint16_t portHTTPS = 80, <span class="keyword">const</span> uint8_t maxConnections = 8, <span class="keyword">const</span> in_addr_t bindAddress = 0);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">virtual</span> ~<a class="code" href="classhttpsserver_1_1HTTPServer.html">HTTPServer</a>();</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  uint8_t <a class="code" href="classhttpsserver_1_1HTTPServer.html#a1b1b6bce0b52348ca5b5664cf497e039">start</a>();</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">void</span> <a class="code" href="classhttpsserver_1_1HTTPServer.html#ae96f6b161cebff36b697aa946c2464ca">stop</a>();</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">bool</span> isRunning();</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> <a class="code" href="classhttpsserver_1_1HTTPServer.html#af8f68f5ff6ad101827bcc52217249fe2">loop</a>();</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">void</span> <a class="code" href="classhttpsserver_1_1HTTPServer.html#ac13d5333f3e4d0c1f6b8b257f4b562ed">setDefaultHeader</a>(std::string name, std::string value);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// Static configuration. Port, keys, etc. ====================</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// Certificate that should be used (includes private key)</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">const</span> uint16_t _port;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Max parallel connections that the server will accept</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">const</span> uint8_t _maxConnections;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// Address to bind to (0 = all interfaces)</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">const</span> in_addr_t _bindAddress;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// The array of connections that are currently active</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classhttpsserver_1_1HTTPConnection.html">HTTPConnection</a> ** _connections;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// Status of the server: Are we running, or not?</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">boolean</span> _running;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// The server socket</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">int</span> _socket;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// The server socket address, that our service is bound to</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  sockaddr_in _sock_addr;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// Headers that are included in every response</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="classhttpsserver_1_1HTTPHeaders.html">HTTPHeaders</a> _defaultHeaders;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// Setup functions</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">virtual</span> uint8_t <a class="code" href="classhttpsserver_1_1HTTPServer.html#a260d87b61b11b5145b126c2e122f7811">setupSocket</a>();</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> teardownSocket();</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// Helper functions</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> createConnection(<span class="keywordtype">int</span> idx);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> };</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> }</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#endif </span><span class="comment">/* SRC_HTTPSERVER_HPP_ */</span><span class="preprocessor"></span></div><div class="ttc" id="classhttpsserver_1_1HTTPServer_html_af8f68f5ff6ad101827bcc52217249fe2"><div class="ttname"><a href="classhttpsserver_1_1HTTPServer.html#af8f68f5ff6ad101827bcc52217249fe2">httpsserver::HTTPServer::loop</a></div><div class="ttdeci">void loop()</div><div class="ttdef"><b>Definition:</b> HTTPServer.cpp:99</div></div>
<div class="ttc" id="classhttpsserver_1_1HTTPServer_html"><div class="ttname"><a href="classhttpsserver_1_1HTTPServer.html">httpsserver::HTTPServer</a></div><div class="ttdoc">Main implementation for the plain HTTP server. Use HTTPSServer for TLS support. </div><div class="ttdef"><b>Definition:</b> HTTPServer.hpp:30</div></div>
<div class="ttc" id="classhttpsserver_1_1HTTPHeaders_html"><div class="ttname"><a href="classhttpsserver_1_1HTTPHeaders.html">httpsserver::HTTPHeaders</a></div><div class="ttdoc">Groups and manages a set of HTTPHeader instances. </div><div class="ttdef"><b>Definition:</b> HTTPHeaders.hpp:18</div></div>
<div class="ttc" id="classhttpsserver_1_1HTTPServer_html_a260d87b61b11b5145b126c2e122f7811"><div class="ttname"><a href="classhttpsserver_1_1HTTPServer.html#a260d87b61b11b5145b126c2e122f7811">httpsserver::HTTPServer::setupSocket</a></div><div class="ttdeci">virtual uint8_t setupSocket()</div><div class="ttdef"><b>Definition:</b> HTTPServer.cpp:170</div></div>
<div class="ttc" id="classhttpsserver_1_1HTTPServer_html_ac13d5333f3e4d0c1f6b8b257f4b562ed"><div class="ttname"><a href="classhttpsserver_1_1HTTPServer.html#ac13d5333f3e4d0c1f6b8b257f4b562ed">httpsserver::HTTPServer::setDefaultHeader</a></div><div class="ttdeci">void setDefaultHeader(std::string name, std::string value)</div><div class="ttdef"><b>Definition:</b> HTTPServer.cpp:91</div></div>
<div class="ttc" id="classhttpsserver_1_1ResourceResolver_html"><div class="ttname"><a href="classhttpsserver_1_1ResourceResolver.html">httpsserver::ResourceResolver</a></div><div class="ttdoc">This class is used internally to resolve a string URL to the corresponding HTTPNode. </div><div class="ttdef"><b>Definition:</b> ResourceResolver.hpp:22</div></div>
<div class="ttc" id="classhttpsserver_1_1HTTPServer_html_ae96f6b161cebff36b697aa946c2464ca"><div class="ttname"><a href="classhttpsserver_1_1HTTPServer.html#ae96f6b161cebff36b697aa946c2464ca">httpsserver::HTTPServer::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdef"><b>Definition:</b> HTTPServer.cpp:54</div></div>
<div class="ttc" id="classhttpsserver_1_1HTTPConnection_html"><div class="ttname"><a href="classhttpsserver_1_1HTTPConnection.html">httpsserver::HTTPConnection</a></div><div class="ttdoc">Represents a single open connection for the plain HTTPServer, without TLS. </div><div class="ttdef"><b>Definition:</b> HTTPConnection.hpp:37</div></div>
<div class="ttc" id="classhttpsserver_1_1HTTPServer_html_a1b1b6bce0b52348ca5b5664cf497e039"><div class="ttname"><a href="classhttpsserver_1_1HTTPServer.html#a1b1b6bce0b52348ca5b5664cf497e039">httpsserver::HTTPServer::start</a></div><div class="ttdeci">uint8_t start()</div><div class="ttdef"><b>Definition:</b> HTTPServer.cpp:35</div></div>
<div class="ttc" id="namespacehttpsserver_html"><div class="ttname"><a href="namespacehttpsserver.html">httpsserver</a></div><div class="ttdef"><b>Definition:</b> ConnectionContext.cpp:3</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>HTTPServer.hpp</b></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>