esp32_https_server/docs/classhttpsserver_1_1HTTPSServer.html at develop · comod/esp32_https_server

History

201 lines (197 loc) · 19.9 KB

Raw

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>ESP32 HTTPS Server: httpsserver::HTTPSServer Class Reference</title>

$(document).ready(initResizable);

</script>

</head>

<body>

<tbody>

<div id="projectname">ESP32 HTTPS Server

</div>

</td>

</tr>

</tbody>

</table>

</div>

var searchBox = new SearchBox("searchBox", "search",false,'Search');

</script>

$(function() {

initMenu('',true,false,'search.php','Search');

$(document).ready(function() { init_search(); });

});

</script>

</div>

</div>

<div id="splitbar" style="-moz-user-select:none;"

class="ui-resizable-handle">

</div>

$(document).ready(function(){initNavTree('classhttpsserver_1_1HTTPSServer.html','');});

</script>

<div id="MSearchSelectWindow"

onmouseover="return searchBox.OnSearchSelectShow()"

onmouseout="return searchBox.OnSearchSelectHide()"

onkeydown="return searchBox.OnSearchSelectKey(event)">

</div>

name="MSearchResults" id="MSearchResults">

</iframe>

</div>

<a href="#pub-methods">Public Member Functions</a> |

<a href="classhttpsserver_1_1HTTPSServer-members.html">List of all members</a> </div>

<div class="title">httpsserver::HTTPSServer Class Reference</div> </div>

</div>

<p>Main implementation of the HTTP Server with TLS support. Use <a class="el" href="classhttpsserver_1_1HTTPServer.html" title="Main implementation for the plain HTTP server. Use HTTPSServer for TLS support. ">HTTPServer</a> for plain HTTP.

<p><code>#include <<a class="el" href="HTTPSServer_8hpp_source.html">HTTPSServer.hpp</a>></code></p>

Inheritance diagram for httpsserver::HTTPSServer:</div>

</map>

<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

Collaboration diagram for httpsserver::HTTPSServer:</div>

</map>

<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

Public Member Functions</h2></td></tr>

 </td><td class="memItemRight" valign="bottom"><b>HTTPSServer</b> (<a class="el" href="classhttpsserver_1_1SSLCert.html">SSLCert</a> *cert, const uint16_t portHTTPS=443, const uint8_t maxConnections=4, const in_addr_t bindAddress=0)</td></tr>

<tr class="inherit_header pub_methods_classhttpsserver_1_1HTTPServer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classhttpsserver_1_1HTTPServer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classhttpsserver_1_1HTTPServer.html">httpsserver::HTTPServer</a></td></tr>

 </td><td class="memItemRight" valign="bottom"><b>HTTPServer</b> (const uint16_t portHTTPS=80, const uint8_t maxConnections=8, const in_addr_t bindAddress=0)</td></tr>

<tr class="memitem:a1b1b6bce0b52348ca5b5664cf497e039 inherit pub_methods_classhttpsserver_1_1HTTPServer"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classhttpsserver_1_1HTTPServer.html#a1b1b6bce0b52348ca5b5664cf497e039">start</a> ()</td></tr>

bool </td><td class="memItemRight" valign="bottom"><b>isRunning</b> ()</td></tr>

<tr class="memitem:ac13d5333f3e4d0c1f6b8b257f4b562ed inherit pub_methods_classhttpsserver_1_1HTTPServer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhttpsserver_1_1HTTPServer.html#ac13d5333f3e4d0c1f6b8b257f4b562ed">setDefaultHeader</a> (std::string name, std::string value)</td></tr>

<tr class="inherit_header pub_methods_classhttpsserver_1_1ResourceResolver"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classhttpsserver_1_1ResourceResolver')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classhttpsserver_1_1ResourceResolver.html">httpsserver::ResourceResolver</a></td></tr>

<tr class="memitem:af7af69fbd2bd59abc82cd57129f0d4b1 inherit pub_methods_classhttpsserver_1_1ResourceResolver"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhttpsserver_1_1ResourceResolver.html#af7af69fbd2bd59abc82cd57129f0d4b1">registerNode</a> (<a class="el" href="classhttpsserver_1_1HTTPNode.html">HTTPNode</a> *node)</td></tr>

<tr class="memitem:a69687da9423b26b2cea4520cfdd89764 inherit pub_methods_classhttpsserver_1_1ResourceResolver"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhttpsserver_1_1ResourceResolver.html#a69687da9423b26b2cea4520cfdd89764">unregisterNode</a> (<a class="el" href="classhttpsserver_1_1HTTPNode.html">HTTPNode</a> *node)</td></tr>

void </td><td class="memItemRight" valign="bottom"><b>setDefaultNode</b> (<a class="el" href="classhttpsserver_1_1HTTPNode.html">HTTPNode</a> *node)</td></tr>

void </td><td class="memItemRight" valign="bottom"><b>resolveNode</b> (const std::string &method, const std::string &url, <a class="el" href="classhttpsserver_1_1ResolvedResource.html">ResolvedResource</a> &resolvedResource, <a class="el" href="namespacehttpsserver.html#a2dcb10ebf7a4b0511b3ca52d4af865ff">HTTPNodeType</a> nodeType)</td></tr>

<tr class="memitem:a1f931501aebe03f04b84fb8bf074c4f3 inherit pub_methods_classhttpsserver_1_1ResourceResolver"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhttpsserver_1_1ResourceResolver.html#a1f931501aebe03f04b84fb8bf074c4f3">addMiddleware</a> (const <a class="el" href="namespacehttpsserver.html#a52016b2f3eb2452288ddae01a9f5633b">HTTPSMiddlewareFunction</a> *mwFunction)</td></tr>

<tr class="memitem:ae28a9f9e98343d5be423d60b8ad7ce56 inherit pub_methods_classhttpsserver_1_1ResourceResolver"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhttpsserver_1_1ResourceResolver.html#ae28a9f9e98343d5be423d60b8ad7ce56">removeMiddleware</a> (const <a class="el" href="namespacehttpsserver.html#a52016b2f3eb2452288ddae01a9f5633b">HTTPSMiddlewareFunction</a> *mwFunction)</td></tr>

<tr class="memitem:ad49926626868ac54d013090883686d8f inherit pub_methods_classhttpsserver_1_1ResourceResolver"><td class="memItemLeft" align="right" valign="top">const std::vector< <a class="el" href="namespacehttpsserver.html#a52016b2f3eb2452288ddae01a9f5633b">HTTPSMiddlewareFunction</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classhttpsserver_1_1ResourceResolver.html#ad49926626868ac54d013090883686d8f">getMiddleware</a> ()</td></tr>

</table><table class="memberdecls">

Additional Inherited Members</h2></td></tr>

<tr class="inherit_header pro_attribs_classhttpsserver_1_1HTTPServer"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classhttpsserver_1_1HTTPServer')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classhttpsserver_1_1HTTPServer.html">httpsserver::HTTPServer</a></td></tr>

const uint16_t </td><td class="memItemRight" valign="bottom"><b>_port</b></td></tr>

const uint8_t </td><td class="memItemRight" valign="bottom"><b>_maxConnections</b></td></tr>

const in_addr_t </td><td class="memItemRight" valign="bottom"><b>_bindAddress</b></td></tr>

<a class="el" href="classhttpsserver_1_1HTTPConnection.html">HTTPConnection</a> ** </td><td class="memItemRight" valign="bottom"><b>_connections</b></td></tr>

boolean </td><td class="memItemRight" valign="bottom"><b>_running</b></td></tr>

int </td><td class="memItemRight" valign="bottom"><b>_socket</b></td></tr>

sockaddr_in </td><td class="memItemRight" valign="bottom"><b>_sock_addr</b></td></tr>

<a class="el" href="classhttpsserver_1_1HTTPHeaders.html">HTTPHeaders</a> </td><td class="memItemRight" valign="bottom"><b>_defaultHeaders</b></td></tr>

</table>

<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

<div class="textblock"><p>Main implementation of the HTTP Server with TLS support. Use <a class="el" href="classhttpsserver_1_1HTTPServer.html" title="Main implementation for the plain HTTP server. Use HTTPSServer for TLS support. ">HTTPServer</a> for plain HTTP. </p>

</div><hr/>The documentation for this class was generated from the following files:<ul>

<li>/home/frank/Projekte/esp32/https_server/esp32_https_server/src/<a class="el" href="HTTPSServer_8hpp_source.html">HTTPSServer.hpp</a></li>

<li>/home/frank/Projekte/esp32/https_server/esp32_https_server/src/HTTPSServer.cpp</li>

</ul>

</div>

</div>

<ul>

<li class="navelem"><a class="el" href="namespacehttpsserver.html">httpsserver</a></li><li class="navelem"><a class="el" href="classhttpsserver_1_1HTTPSServer.html">HTTPSServer</a></li>

<li class="footer">Generated by

</ul>

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

classhttpsserver_1_1HTTPSServer.html

Latest commit

History

classhttpsserver_1_1HTTPSServer.html

File metadata and controls