joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 09:46:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
dash-docs/en/doxygen/html/classHTTPEvent.html

286 lines
14 KiB
HTML
Raw Blame History

<!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: HTTPEvent Class 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&amp;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
&#160;<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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classHTTPEvent.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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classHTTPEvent-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">HTTPEvent Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="httpserver_8h_source.html">httpserver.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad7598146077dac606ccf4c9948040508"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHTTPEvent.html#ad7598146077dac606ccf4c9948040508">HTTPEvent</a> (struct event_base *<a class="el" href="torcontrol_8cpp.html#ab1a154f7530a81e9dd1d63fc6b98a5c7">base</a>, bool <a class="el" href="classHTTPEvent.html#a226496f0af00e98c301e92cd8bf7ca9b">deleteWhenTriggered</a>, const boost::function&lt; void(void)&gt; &amp;<a class="el" href="classHTTPEvent.html#a61e7b99b180ddd304a524c2a27063c4c">handler</a>)</td></tr>
<tr class="separator:ad7598146077dac606ccf4c9948040508"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f216c67f9c4732bac686744a9c527d7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHTTPEvent.html#a3f216c67f9c4732bac686744a9c527d7">~HTTPEvent</a> ()</td></tr>
<tr class="separator:a3f216c67f9c4732bac686744a9c527d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3e2ab005035c3ac678b29095ac0da87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHTTPEvent.html#ad3e2ab005035c3ac678b29095ac0da87">trigger</a> (struct timeval *tv)</td></tr>
<tr class="separator:ad3e2ab005035c3ac678b29095ac0da87"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a226496f0af00e98c301e92cd8bf7ca9b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHTTPEvent.html#a226496f0af00e98c301e92cd8bf7ca9b">deleteWhenTriggered</a></td></tr>
<tr class="separator:a226496f0af00e98c301e92cd8bf7ca9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61e7b99b180ddd304a524c2a27063c4c"><td class="memItemLeft" align="right" valign="top">boost::function&lt; void(void)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHTTPEvent.html#a61e7b99b180ddd304a524c2a27063c4c">handler</a></td></tr>
<tr class="separator:a61e7b99b180ddd304a524c2a27063c4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a1b00e03074314686bf8b01979f938a45"><td class="memItemLeft" align="right" valign="top">struct event *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHTTPEvent.html#a1b00e03074314686bf8b01979f938a45">ev</a></td></tr>
<tr class="separator:a1b00e03074314686bf8b01979f938a45"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Event class. This can be used either as an cross-thread trigger or as a timer. </p>
<p class="definition">Definition at line <a class="el" href="httpserver_8h_source.html#l00128">128</a> of file <a class="el" href="httpserver_8h_source.html">httpserver.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad7598146077dac606ccf4c9948040508"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7598146077dac606ccf4c9948040508">&#9670;&nbsp;</a></span>HTTPEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">HTTPEvent::HTTPEvent </td>
<td>(</td>
<td class="paramtype">struct event_base *&#160;</td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>deleteWhenTriggered</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const boost::function&lt; void(void)&gt; &amp;&#160;</td>
<td class="paramname"><em>handler</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new event. deleteWhenTriggered deletes this event object after the event is triggered (and the handler called) handler is the handler to call when the event is triggered. </p>
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00537">537</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
</div>
</div>
<a id="a3f216c67f9c4732bac686744a9c527d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f216c67f9c4732bac686744a9c527d7">&#9670;&nbsp;</a></span>~HTTPEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">HTTPEvent::~HTTPEvent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00543">543</a> of file <a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad3e2ab005035c3ac678b29095ac0da87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3e2ab005035c3ac678b29095ac0da87">&#9670;&nbsp;</a></span>trigger()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HTTPEvent::trigger </td>
<td>(</td>
<td class="paramtype">struct timeval *&#160;</td>
<td class="paramname"><em>tv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Trigger the event. If tv is 0, trigger it immediately. Otherwise trigger it after the given time has elapsed. </p>
<p class="definition">Definition at line <a class="el" href="httpserver_8cpp_source.html#l00547">547</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#l00029">HTTPRPCTimer::HTTPRPCTimer()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a226496f0af00e98c301e92cd8bf7ca9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a226496f0af00e98c301e92cd8bf7ca9b">&#9670;&nbsp;</a></span>deleteWhenTriggered</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool HTTPEvent::deleteWhenTriggered</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="httpserver_8h_source.html#l00143">143</a> of file <a class="el" href="httpserver_8h_source.html">httpserver.h</a>.</p>
</div>
</div>
<a id="a1b00e03074314686bf8b01979f938a45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b00e03074314686bf8b01979f938a45">&#9670;&nbsp;</a></span>ev</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">struct event* HTTPEvent::ev</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="httpserver_8h_source.html#l00146">146</a> of file <a class="el" href="httpserver_8h_source.html">httpserver.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00537">HTTPEvent()</a>, <a class="el" href="httpserver_8cpp_source.html#l00547">trigger()</a>, and <a class="el" href="httpserver_8cpp_source.html#l00543">~HTTPEvent()</a>.</p>
</div>
</div>
<a id="a61e7b99b180ddd304a524c2a27063c4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61e7b99b180ddd304a524c2a27063c4c">&#9670;&nbsp;</a></span>handler</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::function&lt;void(void)&gt; HTTPEvent::handler</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="httpserver_8h_source.html#l00144">144</a> of file <a class="el" href="httpserver_8h_source.html">httpserver.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="httpserver_8cpp_source.html#l00528">httpevent_callback_fn()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="httpserver_8h_source.html">httpserver.h</a></li>
<li>src/<a class="el" href="httpserver_8cpp_source.html">httpserver.cpp</a></li>
</ul>
</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="classHTTPEvent.html">HTTPEvent</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:13 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>
Reference in a new issue View git blame Copy permalink