mirror of
https://github.com/seigler/dash-docs
synced 2025-07-27 17:56:16 +00:00
971 lines
49 KiB
HTML
971 lines
49 KiB
HTML
<!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.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Dash Core: src/httpserver.cpp File Reference</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">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(initResizable);
|
|
/* @license-end */</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="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Dash Core
|
|
 <span id="projectnumber">0.12.2.1</span>
|
|
</div>
|
|
<div id="projectbrief">P2P Digital Currency</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('httpserver_8cpp.html','');});
|
|
/* @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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">httpserver.cpp File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include "<a class="el" href="httpserver_8h_source.html">httpserver.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="chainparamsbase_8h_source.html">chainparamsbase.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="compat_8h_source.html">compat.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="util_8h_source.html">util.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="netbase_8h_source.html">netbase.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="rpc_2protocol_8h_source.html">rpc/protocol.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="sync_8h_source.html">sync.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="ui__interface_8h_source.html">ui_interface.h</a>"</code><br />
|
|
<code>#include <stdio.h></code><br />
|
|
<code>#include <stdlib.h></code><br />
|
|
<code>#include <string.h></code><br />
|
|
<code>#include <sys/types.h></code><br />
|
|
<code>#include <sys/stat.h></code><br />
|
|
<code>#include <signal.h></code><br />
|
|
<code>#include <event2/event.h></code><br />
|
|
<code>#include <event2/http.h></code><br />
|
|
<code>#include <event2/thread.h></code><br />
|
|
<code>#include <event2/buffer.h></code><br />
|
|
<code>#include <event2/util.h></code><br />
|
|
<code>#include <event2/keyvalq_struct.h></code><br />
|
|
<code>#include <boost/algorithm/string/case_conv.hpp></code><br />
|
|
<code>#include <boost/foreach.hpp></code><br />
|
|
<code>#include <boost/scoped_ptr.hpp></code><br />
|
|
</div>
|
|
<p><a href="httpserver_8cpp_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classHTTPWorkItem.html">HTTPWorkItem</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWorkQueue.html">WorkQueue< WorkItem ></a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWorkQueue_1_1ThreadCounter.html">WorkQueue< WorkItem >::ThreadCounter</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structHTTPPathHandler.html">HTTPPathHandler</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a795675e9eb8d63782e86260f101ae72d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a795675e9eb8d63782e86260f101ae72d">EVENT_LOG_WARN</a>   _EVENT_LOG_WARN</td></tr>
|
|
<tr class="separator:a795675e9eb8d63782e86260f101ae72d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:aca09409a61fe2c1fd1d5f790d16c470f"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#aca09409a61fe2c1fd1d5f790d16c470f">ClientAllowed</a> (const <a class="el" href="classCNetAddr.html">CNetAddr</a> &netaddr)</td></tr>
|
|
<tr class="separator:aca09409a61fe2c1fd1d5f790d16c470f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacd2d2cfef18c714ba497b03c398751f"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#aacd2d2cfef18c714ba497b03c398751f">InitHTTPAllowList</a> ()</td></tr>
|
|
<tr class="separator:aacd2d2cfef18c714ba497b03c398751f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47bc8fd4902feb3836d637ced2680cec"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a47bc8fd4902feb3836d637ced2680cec">RequestMethodString</a> (<a class="el" href="classHTTPRequest.html#a1afe92e9caad997b8f88f0cb07dcc5aa">HTTPRequest::RequestMethod</a> m)</td></tr>
|
|
<tr class="separator:a47bc8fd4902feb3836d637ced2680cec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b457f5c4b63d1a0f5b60116d81768af"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a1b457f5c4b63d1a0f5b60116d81768af">http_request_cb</a> (struct evhttp_request *req, void *arg)</td></tr>
|
|
<tr class="separator:a1b457f5c4b63d1a0f5b60116d81768af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb66dc77121923d7441b7ce325840895"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#acb66dc77121923d7441b7ce325840895">http_reject_request_cb</a> (struct evhttp_request *req, void *)</td></tr>
|
|
<tr class="separator:acb66dc77121923d7441b7ce325840895"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33c0888317562ee0e8f639bd2d45d57c"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a33c0888317562ee0e8f639bd2d45d57c">ThreadHTTP</a> (struct event_base *<a class="el" href="torcontrol_8cpp.html#ab1a154f7530a81e9dd1d63fc6b98a5c7">base</a>, struct evhttp *http)</td></tr>
|
|
<tr class="separator:a33c0888317562ee0e8f639bd2d45d57c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33003026ae72aa806c85add6d8efcb4a"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a33003026ae72aa806c85add6d8efcb4a">HTTPBindAddresses</a> (struct evhttp *http)</td></tr>
|
|
<tr class="separator:a33003026ae72aa806c85add6d8efcb4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3326ebcf9203a92612664e59a82e2f0a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a3326ebcf9203a92612664e59a82e2f0a">HTTPWorkQueueRun</a> (<a class="el" href="classWorkQueue.html">WorkQueue</a>< <a class="el" href="classHTTPClosure.html">HTTPClosure</a> > *queue)</td></tr>
|
|
<tr class="separator:a3326ebcf9203a92612664e59a82e2f0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1552258172bcee1047134108caaead4"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#ac1552258172bcee1047134108caaead4">libevent_log_cb</a> (int severity, const char *msg)</td></tr>
|
|
<tr class="separator:ac1552258172bcee1047134108caaead4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6808b08438e29d81ba310ebded4ba648"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a6808b08438e29d81ba310ebded4ba648">InitHTTPServer</a> ()</td></tr>
|
|
<tr class="separator:a6808b08438e29d81ba310ebded4ba648"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e82ea63cb4e1de19d8acdfbb654f8b2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a9e82ea63cb4e1de19d8acdfbb654f8b2">StartHTTPServer</a> ()</td></tr>
|
|
<tr class="separator:a9e82ea63cb4e1de19d8acdfbb654f8b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a02b6576090c9fde2eed21b9aa7dc0c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a0a02b6576090c9fde2eed21b9aa7dc0c">InterruptHTTPServer</a> ()</td></tr>
|
|
<tr class="separator:a0a02b6576090c9fde2eed21b9aa7dc0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad95d08d62c15b43d52fdba7b7ecaa0aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#ad95d08d62c15b43d52fdba7b7ecaa0aa">StopHTTPServer</a> ()</td></tr>
|
|
<tr class="separator:ad95d08d62c15b43d52fdba7b7ecaa0aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4843a79312705c8a4188de88cebb5a2d"><td class="memItemLeft" align="right" valign="top">struct event_base * </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a4843a79312705c8a4188de88cebb5a2d">EventBase</a> ()</td></tr>
|
|
<tr class="separator:a4843a79312705c8a4188de88cebb5a2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a742caf2e32b30e73ba316f6f66356094"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a742caf2e32b30e73ba316f6f66356094">httpevent_callback_fn</a> (evutil_socket_t, short, void *data)</td></tr>
|
|
<tr class="separator:a742caf2e32b30e73ba316f6f66356094"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a43a4c24762a6af819e364b55820323ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a43a4c24762a6af819e364b55820323ed">RegisterHTTPHandler</a> (const std::string &<a class="el" href="rest_8cpp.html#a5b41c5ae4505891e6c53e26df197e02b">prefix</a>, bool exactMatch, const <a class="el" href="httpserver_8h.html#a90b0a9a188f591e83851dad2b701088f">HTTPRequestHandler</a> &<a class="el" href="rest_8cpp.html#adb9b9c46c5f6a9f59301a2b7313a96d8">handler</a>)</td></tr>
|
|
<tr class="separator:a43a4c24762a6af819e364b55820323ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42d2567faa003c410a310a9c4e36ebdc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a42d2567faa003c410a310a9c4e36ebdc">UnregisterHTTPHandler</a> (const std::string &<a class="el" href="rest_8cpp.html#a5b41c5ae4505891e6c53e26df197e02b">prefix</a>, bool exactMatch)</td></tr>
|
|
<tr class="separator:a42d2567faa003c410a310a9c4e36ebdc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:ad7a8724de9862347e233e9989bb5d2d5"><td class="memItemLeft" align="right" valign="top">static const size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#ad7a8724de9862347e233e9989bb5d2d5">MAX_HEADERS_SIZE</a> = 8192</td></tr>
|
|
<tr class="separator:ad7a8724de9862347e233e9989bb5d2d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5522823075f10647b77372d0b060f2da"><td class="memItemLeft" align="right" valign="top">static struct event_base * </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a5522823075f10647b77372d0b060f2da">eventBase</a> = 0</td></tr>
|
|
<tr class="memdesc:a5522823075f10647b77372d0b060f2da"><td class="mdescLeft"> </td><td class="mdescRight">libevent event loop <a href="#a5522823075f10647b77372d0b060f2da">More...</a><br /></td></tr>
|
|
<tr class="separator:a5522823075f10647b77372d0b060f2da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06877f3f79d254676c5a550708c915c2"><td class="memItemLeft" align="right" valign="top">struct evhttp * </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a06877f3f79d254676c5a550708c915c2">eventHTTP</a> = 0</td></tr>
|
|
<tr class="memdesc:a06877f3f79d254676c5a550708c915c2"><td class="mdescLeft"> </td><td class="mdescRight">HTTP server. <a href="#a06877f3f79d254676c5a550708c915c2">More...</a><br /></td></tr>
|
|
<tr class="separator:a06877f3f79d254676c5a550708c915c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac95cd1cda418414ceb45f0adb40b7422"><td class="memItemLeft" align="right" valign="top">static std::vector< <a class="el" href="classCSubNet.html">CSubNet</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#ac95cd1cda418414ceb45f0adb40b7422">rpc_allow_subnets</a></td></tr>
|
|
<tr class="memdesc:ac95cd1cda418414ceb45f0adb40b7422"><td class="mdescLeft"> </td><td class="mdescRight">List of subnets to allow RPC connections from. <a href="#ac95cd1cda418414ceb45f0adb40b7422">More...</a><br /></td></tr>
|
|
<tr class="separator:ac95cd1cda418414ceb45f0adb40b7422"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a225ae3b669082bab57a195168ea36d7a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classWorkQueue.html">WorkQueue</a>< <a class="el" href="classHTTPClosure.html">HTTPClosure</a> > * </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a225ae3b669082bab57a195168ea36d7a">workQueue</a> = 0</td></tr>
|
|
<tr class="memdesc:a225ae3b669082bab57a195168ea36d7a"><td class="mdescLeft"> </td><td class="mdescRight">Work queue for handling longer requests off the event loop thread. <a href="#a225ae3b669082bab57a195168ea36d7a">More...</a><br /></td></tr>
|
|
<tr class="separator:a225ae3b669082bab57a195168ea36d7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0d357530f123f4ecfc6635abc5de5c8"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="structHTTPPathHandler.html">HTTPPathHandler</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#ae0d357530f123f4ecfc6635abc5de5c8">pathHandlers</a></td></tr>
|
|
<tr class="memdesc:ae0d357530f123f4ecfc6635abc5de5c8"><td class="mdescLeft"> </td><td class="mdescRight">Handlers for (sub)paths. <a href="#ae0d357530f123f4ecfc6635abc5de5c8">More...</a><br /></td></tr>
|
|
<tr class="separator:ae0d357530f123f4ecfc6635abc5de5c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41153da092439dd95528d2707da29c33"><td class="memItemLeft" align="right" valign="top">std::vector< evhttp_bound_socket * > </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#a41153da092439dd95528d2707da29c33">boundSockets</a></td></tr>
|
|
<tr class="memdesc:a41153da092439dd95528d2707da29c33"><td class="mdescLeft"> </td><td class="mdescRight">Bound listening sockets. <a href="#a41153da092439dd95528d2707da29c33">More...</a><br /></td></tr>
|
|
<tr class="separator:a41153da092439dd95528d2707da29c33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf8212f8a7abde5014088c9c21b0c8bf"><td class="memItemLeft" align="right" valign="top">boost::thread </td><td class="memItemRight" valign="bottom"><a class="el" href="httpserver_8cpp.html#adf8212f8a7abde5014088c9c21b0c8bf">threadHTTP</a></td></tr>
|
|
<tr class="separator:adf8212f8a7abde5014088c9c21b0c8bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="a795675e9eb8d63782e86260f101ae72d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a795675e9eb8d63782e86260f101ae72d">◆ </a></span>EVENT_LOG_WARN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define EVENT_LOG_WARN   _EVENT_LOG_WARN</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00372">libevent_log_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="aca09409a61fe2c1fd1d5f790d16c470f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aca09409a61fe2c1fd1d5f790d16c470f">◆ </a></span>ClientAllowed()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool ClientAllowed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classCNetAddr.html">CNetAddr</a> & </td>
|
|
<td class="paramname"><em>netaddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Check if a network address is allowed to access the HTTP server </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00196">196</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00259">http_request_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4843a79312705c8a4188de88cebb5a2d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4843a79312705c8a4188de88cebb5a2d">◆ </a></span>EventBase()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct event_base* EventBase </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return evhttp event base. This can be used by submodules to queue timers or custom events. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00523">523</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httprpc_8cpp_source.html#l00224">StartHTTPRPC()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acb66dc77121923d7441b7ce325840895"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acb66dc77121923d7441b7ce325840895">◆ </a></span>http_reject_request_cb()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void http_reject_request_cb </td>
|
|
<td>(</td>
|
|
<td class="paramtype">struct evhttp_request * </td>
|
|
<td class="paramname"><em>req</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Callback to reject HTTP requests after shutdown. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00309">309</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00465">InterruptHTTPServer()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1b457f5c4b63d1a0f5b60116d81768af"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b457f5c4b63d1a0f5b60116d81768af">◆ </a></span>http_request_cb()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void http_request_cb </td>
|
|
<td>(</td>
|
|
<td class="paramtype">struct evhttp_request * </td>
|
|
<td class="paramname"><em>req</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>arg</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>HTTP request callback </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00259">259</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00384">InitHTTPServer()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a33003026ae72aa806c85add6d8efcb4a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a33003026ae72aa806c85add6d8efcb4a">◆ </a></span>HTTPBindAddresses()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool HTTPBindAddresses </td>
|
|
<td>(</td>
|
|
<td class="paramtype">struct evhttp * </td>
|
|
<td class="paramname"><em>http</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Bind HTTP server to specified addresses </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00326">326</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00384">InitHTTPServer()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a742caf2e32b30e73ba316f6f66356094"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a742caf2e32b30e73ba316f6f66356094">◆ </a></span>httpevent_callback_fn()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void httpevent_callback_fn </td>
|
|
<td>(</td>
|
|
<td class="paramtype">evutil_socket_t </td>
|
|
<td class="paramname">, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">short </td>
|
|
<td class="paramname">, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>data</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00528">528</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00537">HTTPEvent::HTTPEvent()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3326ebcf9203a92612664e59a82e2f0a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3326ebcf9203a92612664e59a82e2f0a">◆ </a></span>HTTPWorkQueueRun()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void HTTPWorkQueueRun </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classWorkQueue.html">WorkQueue</a>< <a class="el" href="classHTTPClosure.html">HTTPClosure</a> > * </td>
|
|
<td class="paramname"><em>queue</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Simple wrapper to set thread name and run work queue </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00365">365</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00453">StartHTTPServer()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aacd2d2cfef18c714ba497b03c398751f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aacd2d2cfef18c714ba497b03c398751f">◆ </a></span>InitHTTPAllowList()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool InitHTTPAllowList </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Initialize ACL list for HTTP server </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00207">207</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00384">InitHTTPServer()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6808b08438e29d81ba310ebded4ba648"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6808b08438e29d81ba310ebded4ba648">◆ </a></span>InitHTTPServer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool InitHTTPServer </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Initialize HTTP server. Call this before RegisterHTTPHandler or <a class="el" href="httpserver_8h.html#a4843a79312705c8a4188de88cebb5a2d">EventBase()</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00384">384</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="init_8cpp_source.html#l00800">AppInitServers()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0a02b6576090c9fde2eed21b9aa7dc0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0a02b6576090c9fde2eed21b9aa7dc0c">◆ </a></span>InterruptHTTPServer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void InterruptHTTPServer </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Interrupt HTTP server threads </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00465">465</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="init_8cpp_source.html#l00197">Interrupt()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac1552258172bcee1047134108caaead4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1552258172bcee1047134108caaead4">◆ </a></span>libevent_log_cb()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void libevent_log_cb </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>severity</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>msg</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>libevent event log callback </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00372">372</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00384">InitHTTPServer()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a43a4c24762a6af819e364b55820323ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a43a4c24762a6af819e364b55820323ed">◆ </a></span>RegisterHTTPHandler()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RegisterHTTPHandler </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>prefix</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>exactMatch</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="httpserver_8h.html#a90b0a9a188f591e83851dad2b701088f">HTTPRequestHandler</a> & </td>
|
|
<td class="paramname"><em>handler</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Register handler for prefix. If multiple handlers match a prefix, the first-registered one will be invoked. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00665">665</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httprpc_8cpp_source.html#l00224">StartHTTPRPC()</a>, and <a class="el" href="rest_8cpp_source.html#l00613">StartREST()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a47bc8fd4902feb3836d637ced2680cec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a47bc8fd4902feb3836d637ced2680cec">◆ </a></span>RequestMethodString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::string RequestMethodString </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classHTTPRequest.html#a1afe92e9caad997b8f88f0cb07dcc5aa">HTTPRequest::RequestMethod</a> </td>
|
|
<td class="paramname"><em>m</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>HTTP request method as string - use for logging only </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00238">238</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00259">http_request_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9e82ea63cb4e1de19d8acdfbb654f8b2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9e82ea63cb4e1de19d8acdfbb654f8b2">◆ </a></span>StartHTTPServer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool StartHTTPServer </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Start HTTP server. This is separate from InitHTTPServer to give users race-condition-free time to register their handlers between InitHTTPServer and StartHTTPServer. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00453">453</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="init_8cpp_source.html#l00800">AppInitServers()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad95d08d62c15b43d52fdba7b7ecaa0aa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad95d08d62c15b43d52fdba7b7ecaa0aa">◆ </a></span>StopHTTPServer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void StopHTTPServer </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Stop HTTP server </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00480">480</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="init_8cpp_source.html#l00210">PrepareShutdown()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a33c0888317562ee0e8f639bd2d45d57c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a33c0888317562ee0e8f639bd2d45d57c">◆ </a></span>ThreadHTTP()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void ThreadHTTP </td>
|
|
<td>(</td>
|
|
<td class="paramtype">struct event_base * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">struct evhttp * </td>
|
|
<td class="paramname"><em>http</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Event dispatcher thread </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00316">316</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00453">StartHTTPServer()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a42d2567faa003c410a310a9c4e36ebdc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a42d2567faa003c410a310a9c4e36ebdc">◆ </a></span>UnregisterHTTPHandler()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void UnregisterHTTPHandler </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>prefix</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>exactMatch</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Unregister handler for prefix </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00671">671</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httprpc_8cpp_source.html#l00243">StopHTTPRPC()</a>, and <a class="el" href="rest_8cpp_source.html#l00624">StopREST()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="a41153da092439dd95528d2707da29c33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a41153da092439dd95528d2707da29c33">◆ </a></span>boundSockets</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<evhttp_bound_socket *> boundSockets</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Bound listening sockets. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00193">193</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00326">HTTPBindAddresses()</a>, and <a class="el" href="httpserver_8cpp_source.html#l00465">InterruptHTTPServer()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5522823075f10647b77372d0b060f2da"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5522823075f10647b77372d0b060f2da">◆ </a></span>eventBase</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct event_base* eventBase = 0</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>libevent event loop </p>
|
|
<p>HTTP module state </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00183">183</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00523">EventBase()</a>, <a class="el" href="httpserver_8cpp_source.html#l00384">InitHTTPServer()</a>, <a class="el" href="httpserver_8cpp_source.html#l00453">StartHTTPServer()</a>, <a class="el" href="httpserver_8cpp_source.html#l00480">StopHTTPServer()</a>, and <a class="el" href="httpserver_8cpp_source.html#l00611">HTTPRequest::WriteReply()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a06877f3f79d254676c5a550708c915c2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a06877f3f79d254676c5a550708c915c2">◆ </a></span>eventHTTP</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct evhttp* eventHTTP = 0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>HTTP server. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00185">185</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00384">InitHTTPServer()</a>, <a class="el" href="httpserver_8cpp_source.html#l00465">InterruptHTTPServer()</a>, <a class="el" href="httpserver_8cpp_source.html#l00453">StartHTTPServer()</a>, and <a class="el" href="httpserver_8cpp_source.html#l00480">StopHTTPServer()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad7a8724de9862347e233e9989bb5d2d5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7a8724de9862347e233e9989bb5d2d5">◆ </a></span>MAX_HEADERS_SIZE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const size_t MAX_HEADERS_SIZE = 8192</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Maximum size of http request (request line + headers) </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00042">42</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00384">InitHTTPServer()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae0d357530f123f4ecfc6635abc5de5c8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae0d357530f123f4ecfc6635abc5de5c8">◆ </a></span>pathHandlers</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<<a class="el" href="structHTTPPathHandler.html">HTTPPathHandler</a>> pathHandlers</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Handlers for (sub)paths. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00191">191</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00259">http_request_cb()</a>, <a class="el" href="httpserver_8cpp_source.html#l00665">RegisterHTTPHandler()</a>, and <a class="el" href="httpserver_8cpp_source.html#l00671">UnregisterHTTPHandler()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac95cd1cda418414ceb45f0adb40b7422"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac95cd1cda418414ceb45f0adb40b7422">◆ </a></span>rpc_allow_subnets</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<<a class="el" href="classCSubNet.html">CSubNet</a>> rpc_allow_subnets</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>List of subnets to allow RPC connections from. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00187">187</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00196">ClientAllowed()</a>, and <a class="el" href="httpserver_8cpp_source.html#l00207">InitHTTPAllowList()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adf8212f8a7abde5014088c9c21b0c8bf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adf8212f8a7abde5014088c9c21b0c8bf">◆ </a></span>threadHTTP</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">boost::thread threadHTTP</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00451">451</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00453">StartHTTPServer()</a>, and <a class="el" href="httpserver_8cpp_source.html#l00480">StopHTTPServer()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a225ae3b669082bab57a195168ea36d7a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a225ae3b669082bab57a195168ea36d7a">◆ </a></span>workQueue</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classWorkQueue.html">WorkQueue</a><<a class="el" href="classHTTPClosure.html">HTTPClosure</a>>* workQueue = 0</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Work queue for handling longer requests off the event loop thread. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00189">189</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00259">http_request_cb()</a>, <a class="el" href="httpserver_8cpp_source.html#l00384">InitHTTPServer()</a>, <a class="el" href="httpserver_8cpp_source.html#l00465">InterruptHTTPServer()</a>, <a class="el" href="httpserver_8cpp_source.html#l00453">StartHTTPServer()</a>, and <a class="el" href="httpserver_8cpp_source.html#l00480">StopHTTPServer()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</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"><a class="el" href="httpserver_8cpp.html">httpserver.cpp</a></li>
|
|
<li class="footer">Generated on Thu Dec 14 2017 13:15:10 for Dash Core by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|