Amebis/stdex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
stdex/classstdex_1_1watchdog.html

239 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::watchdog&lt; _Clock, _Duration &gt; Class Template 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></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 id="projectrow">
<td id="projectalign">
<div id="projectname">stdex
</div>
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>stdex</b></li><li class="navelem"><a class="el" href="classstdex_1_1watchdog.html">watchdog</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classstdex_1_1watchdog-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::watchdog&lt; _Clock, _Duration &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Triggers callback if not reset frequently enough.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="watchdog_8hpp_source.html">stdex/watchdog.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a045c86421267f195c45d7fa01c6147c0" id="r_a045c86421267f195c45d7fa01c6147c0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a045c86421267f195c45d7fa01c6147c0">watchdog</a> (_Duration timeout, std::function&lt; void()&gt; callback)</td></tr>
<tr class="memdesc:a045c86421267f195c45d7fa01c6147c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the watchdog. <br /></td></tr>
<tr class="separator:a045c86421267f195c45d7fa01c6147c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ecedd7cd51129b3dc6775b638c91b16" id="r_a8ecedd7cd51129b3dc6775b638c91b16"><td class="memItemLeft" align="right" valign="top"><a id="a8ecedd7cd51129b3dc6775b638c91b16" name="a8ecedd7cd51129b3dc6775b638c91b16"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>~watchdog</b> ()</td></tr>
<tr class="memdesc:a8ecedd7cd51129b3dc6775b638c91b16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the watchdog. <br /></td></tr>
<tr class="separator:a8ecedd7cd51129b3dc6775b638c91b16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9d5d1c1b17425f47f3892deec4d31db" id="r_ac9d5d1c1b17425f47f3892deec4d31db"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac9d5d1c1b17425f47f3892deec4d31db">reset</a> ()</td></tr>
<tr class="memdesc:ac9d5d1c1b17425f47f3892deec4d31db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the watchdog. <br /></td></tr>
<tr class="separator:ac9d5d1c1b17425f47f3892deec4d31db"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ad3084de1c37c194bfab2e869ef6b4edb" id="r_ad3084de1c37c194bfab2e869ef6b4edb"><td class="memItemLeft" align="right" valign="top"><a id="ad3084de1c37c194bfab2e869ef6b4edb" name="ad3084de1c37c194bfab2e869ef6b4edb"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>run</b> ()</td></tr>
<tr class="separator:ad3084de1c37c194bfab2e869ef6b4edb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a301e35d22b11f6ea6ffbe94ffa22fc3e" id="r_a301e35d22b11f6ea6ffbe94ffa22fc3e"><td class="memItemLeft" align="right" valign="top"><a id="a301e35d22b11f6ea6ffbe94ffa22fc3e" name="a301e35d22b11f6ea6ffbe94ffa22fc3e"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_phase</b></td></tr>
<tr class="memdesc:a301e35d22b11f6ea6ffbe94ffa22fc3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">A counter we are incrementing to keep the watchdog happy. <br /></td></tr>
<tr class="separator:a301e35d22b11f6ea6ffbe94ffa22fc3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa7759c46dc8632b3f26d17291ca9483" id="r_aaa7759c46dc8632b3f26d17291ca9483"><td class="memItemLeft" align="right" valign="top"><a id="aaa7759c46dc8632b3f26d17291ca9483" name="aaa7759c46dc8632b3f26d17291ca9483"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>m_quit</b></td></tr>
<tr class="memdesc:aaa7759c46dc8632b3f26d17291ca9483"><td class="mdescLeft">&#160;</td><td class="mdescRight">Quit the watchdog. <br /></td></tr>
<tr class="separator:aaa7759c46dc8632b3f26d17291ca9483"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a816c03499d71d1fe73410d979744c817" id="r_a816c03499d71d1fe73410d979744c817"><td class="memItemLeft" align="right" valign="top"><a id="a816c03499d71d1fe73410d979744c817" name="a816c03499d71d1fe73410d979744c817"></a>
_Duration&#160;</td><td class="memItemRight" valign="bottom"><b>m_timeout</b></td></tr>
<tr class="memdesc:a816c03499d71d1fe73410d979744c817"><td class="mdescLeft">&#160;</td><td class="mdescRight">How long the watchdog is waiting for a reset. <br /></td></tr>
<tr class="separator:a816c03499d71d1fe73410d979744c817"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1d34b845b80a49997e82f50bb13f839" id="r_af1d34b845b80a49997e82f50bb13f839"><td class="memItemLeft" align="right" valign="top"><a id="af1d34b845b80a49997e82f50bb13f839" name="af1d34b845b80a49997e82f50bb13f839"></a>
std::function&lt; void()&gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_callback</b></td></tr>
<tr class="memdesc:af1d34b845b80a49997e82f50bb13f839"><td class="mdescLeft">&#160;</td><td class="mdescRight">The function watchdog calls on timeout. <br /></td></tr>
<tr class="separator:af1d34b845b80a49997e82f50bb13f839"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f75c812969d6ede144285a353b0e364" id="r_a8f75c812969d6ede144285a353b0e364"><td class="memItemLeft" align="right" valign="top"><a id="a8f75c812969d6ede144285a353b0e364" name="a8f75c812969d6ede144285a353b0e364"></a>
std::mutex&#160;</td><td class="memItemRight" valign="bottom"><b>m_mutex</b></td></tr>
<tr class="separator:a8f75c812969d6ede144285a353b0e364"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44a903810472ad7747310130d01c88c2" id="r_a44a903810472ad7747310130d01c88c2"><td class="memItemLeft" align="right" valign="top"><a id="a44a903810472ad7747310130d01c88c2" name="a44a903810472ad7747310130d01c88c2"></a>
std::condition_variable&#160;</td><td class="memItemRight" valign="bottom"><b>m_cv</b></td></tr>
<tr class="separator:a44a903810472ad7747310130d01c88c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9213223bfa0780a8d5a4b3b0a47ed7d1" id="r_a9213223bfa0780a8d5a4b3b0a47ed7d1"><td class="memItemLeft" align="right" valign="top"><a id="a9213223bfa0780a8d5a4b3b0a47ed7d1" name="a9213223bfa0780a8d5a4b3b0a47ed7d1"></a>
std::thread&#160;</td><td class="memItemRight" valign="bottom"><b>m_thread</b></td></tr>
<tr class="separator:a9213223bfa0780a8d5a4b3b0a47ed7d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class _Clock, class _Duration = typename _Clock::duration&gt;<br />
class stdex::watchdog&lt; _Clock, _Duration &gt;</div><p>Triggers callback if not reset frequently enough. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a045c86421267f195c45d7fa01c6147c0" name="a045c86421267f195c45d7fa01c6147c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a045c86421267f195c45d7fa01c6147c0">&#9670;&#160;</a></span>watchdog()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class _Clock , class _Duration = typename _Clock::duration&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1watchdog.html">stdex::watchdog</a>&lt; _Clock, _Duration &gt;::watchdog </td>
<td>(</td>
<td class="paramtype">_Duration</td> <td class="paramname"><span class="paramname"><em>timeout</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::function&lt; void()&gt;</td> <td class="paramname"><span class="paramname"><em>callback</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts the watchdog. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>How long the watchdog is waiting for a reset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>The function watchdog calls on timeout </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac9d5d1c1b17425f47f3892deec4d31db" name="ac9d5d1c1b17425f47f3892deec4d31db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9d5d1c1b17425f47f3892deec4d31db">&#9670;&#160;</a></span>reset()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class _Clock , class _Duration = typename _Clock::duration&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classstdex_1_1watchdog.html">stdex::watchdog</a>&lt; _Clock, _Duration &gt;::reset </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the watchdog. </p>
<p>Must be called frequently enough not to timeout the watchdog </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/stdex/<a class="el" href="watchdog_8hpp_source.html">watchdog.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 27 2024 14:39:01 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink