esp32_https_server/docs/classhttpsserver_1_1HTTPRequest.html at master · fhessel/esp32_https_server

History

191 lines (185 loc) · 12.7 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

<!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::HTTPRequest 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_1HTTPRequest.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_1HTTPRequest-members.html">List of all members</a> </div>

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

</div>

<p>Represents the request stream for an HTTP request.

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

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

 </td><td class="memItemRight" valign="bottom"><b>HTTPRequest</b> (<a class="el" href="classhttpsserver_1_1ConnectionContext.html">ConnectionContext</a> *con, <a class="el" href="classhttpsserver_1_1HTTPHeaders.html">HTTPHeaders</a> *headers, <a class="el" href="classhttpsserver_1_1HTTPNode.html">HTTPNode</a> *resolvedNode, std::string method, <a class="el" href="classhttpsserver_1_1ResourceParameters.html">ResourceParameters</a> *params, std::string requestString)</td></tr>

std::string </td><td class="memItemRight" valign="bottom"><b>getHeader</b> (std::string const &name)</td></tr>

void </td><td class="memItemRight" valign="bottom"><b>setHeader</b> (std::string const &name, std::string const &value)</td></tr>

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

std::string </td><td class="memItemRight" valign="bottom"><b>getRequestString</b> ()</td></tr>

std::string </td><td class="memItemRight" valign="bottom"><b>getMethod</b> ()</td></tr>

std::string </td><td class="memItemRight" valign="bottom"><b>getTag</b> ()</td></tr>

IPAddress </td><td class="memItemRight" valign="bottom"><b>getClientIP</b> ()</td></tr>

size_t </td><td class="memItemRight" valign="bottom"><b>readChars</b> (char *buffer, size_t length)</td></tr>

size_t </td><td class="memItemRight" valign="bottom"><b>readBytes</b> (byte *buffer, size_t length)</td></tr>

size_t </td><td class="memItemRight" valign="bottom"><b>getContentLength</b> ()</td></tr>

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

<tr class="memitem:a4cf913006633555d142f23ab7fa5e876"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhttpsserver_1_1HTTPRequest.html#a4cf913006633555d142f23ab7fa5e876">discardRequestBody</a> ()</td></tr>

<a class="el" href="classhttpsserver_1_1ResourceParameters.html">ResourceParameters</a> * </td><td class="memItemRight" valign="bottom"><b>getParams</b> ()</td></tr>

<a class="el" href="classhttpsserver_1_1HTTPHeaders.html">HTTPHeaders</a> * </td><td class="memItemRight" valign="bottom"><b>getHTTPHeaders</b> ()</td></tr>

std::string </td><td class="memItemRight" valign="bottom"><b>getBasicAuthUser</b> ()</td></tr>

std::string </td><td class="memItemRight" valign="bottom"><b>getBasicAuthPassword</b> ()</td></tr>

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

void </td><td class="memItemRight" valign="bottom"><b>setWebsocketHandler</b> (<a class="el" href="classhttpsserver_1_1WebsocketHandler.html">WebsocketHandler</a> *wsHandler)</td></tr>

</table>

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

<div class="textblock"><p>Represents the request stream for an HTTP request. </p>

</div><h2 class="groupheader">Member Function Documentation</h2>

<h2 class="memtitle"><span class="permalink"><a href="#a4cf913006633555d142f23ab7fa5e876">◆ </a></span>discardRequestBody()</h2>

<tr>

<td class="memname">void httpsserver::HTTPRequest::discardRequestBody </td>

</tr>

</table>

</div><div class="memdoc">

<p>This function will drop whatever is remaining of the request body </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="HTTPRequest_8hpp_source.html">HTTPRequest.hpp</a></li>

<li>/home/frank/Projekte/esp32/https_server/esp32_https_server/src/HTTPRequest.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_1HTTPRequest.html">HTTPRequest</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_1HTTPRequest.html

Latest commit

History

classhttpsserver_1_1HTTPRequest.html

File metadata and controls