195 lines
21 KiB
HTML
195 lines
21 KiB
HTML
<!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.10.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>stdex: include/stdex/watchdog.hpp Source File</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>
|
|
<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.10.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_fca3c47b2ea228727bd6729832f89576.html">stdex</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">watchdog.hpp</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> SPDX-License-Identifier: MIT</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> Copyright © 2023-2024 Amebis</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">*/</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "compat.hpp"</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <chrono></span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <condition_variable></span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include <mutex></span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include <thread></span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">namespace </span>stdex</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>{</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">template</span> <<span class="keyword">class</span> _Clock, <span class="keyword">class</span> _Duration = <span class="keyword">typename</span> _Clock::duration></div>
|
|
<div class="foldopen" id="foldopen00021" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classstdex_1_1watchdog.html"> 21</a></span> <span class="keyword">class </span><a class="code hl_class" href="classstdex_1_1watchdog.html">watchdog</a></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> {</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">public</span>:</div>
|
|
<div class="foldopen" id="foldopen00030" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classstdex_1_1watchdog.html#a045c86421267f195c45d7fa01c6147c0"> 30</a></span> <a class="code hl_function" href="classstdex_1_1watchdog.html#a045c86421267f195c45d7fa01c6147c0">watchdog</a>(_In_ _Duration timeout, _In_ std::function<<span class="keywordtype">void</span>()> callback) :</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_variable" href="classstdex_1_1watchdog.html#a301e35d22b11f6ea6ffbe94ffa22fc3e">m_phase</a>(0),</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_variable" href="classstdex_1_1watchdog.html#aaa7759c46dc8632b3f26d17291ca9483">m_quit</a>(false),</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <a class="code hl_variable" href="classstdex_1_1watchdog.html#a816c03499d71d1fe73410d979744c817">m_timeout</a>(timeout),</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_variable" href="classstdex_1_1watchdog.html#af1d34b845b80a49997e82f50bb13f839">m_callback</a>(callback),</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> m_thread([](_Inout_ <a class="code hl_class" href="classstdex_1_1watchdog.html">watchdog</a>& wd) { wd.run(); }, std::ref(*<span class="keyword">this</span>))</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {}</div>
|
|
</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
|
|
<div class="foldopen" id="foldopen00041" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classstdex_1_1watchdog.html#a8ecedd7cd51129b3dc6775b638c91b16"> 41</a></span> <a class="code hl_function" href="classstdex_1_1watchdog.html#a8ecedd7cd51129b3dc6775b638c91b16">~watchdog</a>()</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> {</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> {</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">const</span> std::lock_guard<std::mutex> lk(m_mutex);</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_variable" href="classstdex_1_1watchdog.html#aaa7759c46dc8632b3f26d17291ca9483">m_quit</a> = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> }</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> m_cv.notify_one();</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">if</span> (m_thread.joinable())</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> m_thread.join();</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
|
|
<div class="foldopen" id="foldopen00057" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classstdex_1_1watchdog.html#ac9d5d1c1b17425f47f3892deec4d31db"> 57</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classstdex_1_1watchdog.html#ac9d5d1c1b17425f47f3892deec4d31db">reset</a>()</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> {</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> {</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">const</span> std::lock_guard<std::mutex> lk(m_mutex);</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <a class="code hl_variable" href="classstdex_1_1watchdog.html#a301e35d22b11f6ea6ffbe94ffa22fc3e">m_phase</a>++;</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> m_cv.notify_one();</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">void</span> run()</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> {</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">size_t</span> phase;</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">for</span> (;;) {</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> {</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> std::unique_lock<std::mutex> lk(m_mutex);</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> phase = <a class="code hl_variable" href="classstdex_1_1watchdog.html#a301e35d22b11f6ea6ffbe94ffa22fc3e">m_phase</a>;</div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">if</span> (m_cv.wait_for(lk, <a class="code hl_variable" href="classstdex_1_1watchdog.html#a816c03499d71d1fe73410d979744c817">m_timeout</a>, [&] {return m_quit || phase != m_phase; })) {</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classstdex_1_1watchdog.html#aaa7759c46dc8632b3f26d17291ca9483">m_quit</a>)</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="comment">// reset() called in time.</span></div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordflow">continue</span>;</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> }</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> }</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// Timeout</span></div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <a class="code hl_variable" href="classstdex_1_1watchdog.html#af1d34b845b80a49997e82f50bb13f839">m_callback</a>();</div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> {</div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="comment">// Sleep until next reset().</span></div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> std::unique_lock<std::mutex> lk(m_mutex);</div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> m_cv.wait(lk, [&] {<span class="keywordflow">return</span> <a class="code hl_variable" href="classstdex_1_1watchdog.html#aaa7759c46dc8632b3f26d17291ca9483">m_quit</a> || phase != <a class="code hl_variable" href="classstdex_1_1watchdog.html#a301e35d22b11f6ea6ffbe94ffa22fc3e">m_phase</a>; });</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classstdex_1_1watchdog.html#aaa7759c46dc8632b3f26d17291ca9483">m_quit</a>)</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> }</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> }</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> }</div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="classstdex_1_1watchdog.html#a301e35d22b11f6ea6ffbe94ffa22fc3e"> 94</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classstdex_1_1watchdog.html#a301e35d22b11f6ea6ffbe94ffa22fc3e">m_phase</a>; </div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="classstdex_1_1watchdog.html#aaa7759c46dc8632b3f26d17291ca9483"> 95</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classstdex_1_1watchdog.html#aaa7759c46dc8632b3f26d17291ca9483">m_quit</a>; </div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="classstdex_1_1watchdog.html#a816c03499d71d1fe73410d979744c817"> 96</a></span> _Duration <a class="code hl_variable" href="classstdex_1_1watchdog.html#a816c03499d71d1fe73410d979744c817">m_timeout</a>; </div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classstdex_1_1watchdog.html#af1d34b845b80a49997e82f50bb13f839"> 97</a></span> std::function<void()> <a class="code hl_variable" href="classstdex_1_1watchdog.html#af1d34b845b80a49997e82f50bb13f839">m_callback</a>; </div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> std::mutex m_mutex;</div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> std::condition_variable m_cv;</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> std::thread m_thread;</div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> };</div>
|
|
</div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span>}</div>
|
|
<div class="ttc" id="aclassstdex_1_1watchdog_html"><div class="ttname"><a href="classstdex_1_1watchdog.html">stdex::watchdog</a></div><div class="ttdoc">Triggers callback if not reset frequently enough.</div><div class="ttdef"><b>Definition</b> watchdog.hpp:22</div></div>
|
|
<div class="ttc" id="aclassstdex_1_1watchdog_html_a045c86421267f195c45d7fa01c6147c0"><div class="ttname"><a href="classstdex_1_1watchdog.html#a045c86421267f195c45d7fa01c6147c0">stdex::watchdog::watchdog</a></div><div class="ttdeci">watchdog(_Duration timeout, std::function< void()> callback)</div><div class="ttdoc">Starts the watchdog.</div><div class="ttdef"><b>Definition</b> watchdog.hpp:30</div></div>
|
|
<div class="ttc" id="aclassstdex_1_1watchdog_html_a301e35d22b11f6ea6ffbe94ffa22fc3e"><div class="ttname"><a href="classstdex_1_1watchdog.html#a301e35d22b11f6ea6ffbe94ffa22fc3e">stdex::watchdog::m_phase</a></div><div class="ttdeci">size_t m_phase</div><div class="ttdoc">A counter we are incrementing to keep the watchdog happy.</div><div class="ttdef"><b>Definition</b> watchdog.hpp:94</div></div>
|
|
<div class="ttc" id="aclassstdex_1_1watchdog_html_a816c03499d71d1fe73410d979744c817"><div class="ttname"><a href="classstdex_1_1watchdog.html#a816c03499d71d1fe73410d979744c817">stdex::watchdog::m_timeout</a></div><div class="ttdeci">_Duration m_timeout</div><div class="ttdoc">How long the watchdog is waiting for a reset.</div><div class="ttdef"><b>Definition</b> watchdog.hpp:96</div></div>
|
|
<div class="ttc" id="aclassstdex_1_1watchdog_html_a8ecedd7cd51129b3dc6775b638c91b16"><div class="ttname"><a href="classstdex_1_1watchdog.html#a8ecedd7cd51129b3dc6775b638c91b16">stdex::watchdog::~watchdog</a></div><div class="ttdeci">~watchdog()</div><div class="ttdoc">Stops the watchdog.</div><div class="ttdef"><b>Definition</b> watchdog.hpp:41</div></div>
|
|
<div class="ttc" id="aclassstdex_1_1watchdog_html_aaa7759c46dc8632b3f26d17291ca9483"><div class="ttname"><a href="classstdex_1_1watchdog.html#aaa7759c46dc8632b3f26d17291ca9483">stdex::watchdog::m_quit</a></div><div class="ttdeci">bool m_quit</div><div class="ttdoc">Quit the watchdog.</div><div class="ttdef"><b>Definition</b> watchdog.hpp:95</div></div>
|
|
<div class="ttc" id="aclassstdex_1_1watchdog_html_ac9d5d1c1b17425f47f3892deec4d31db"><div class="ttname"><a href="classstdex_1_1watchdog.html#ac9d5d1c1b17425f47f3892deec4d31db">stdex::watchdog::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Resets the watchdog.</div><div class="ttdef"><b>Definition</b> watchdog.hpp:57</div></div>
|
|
<div class="ttc" id="aclassstdex_1_1watchdog_html_af1d34b845b80a49997e82f50bb13f839"><div class="ttname"><a href="classstdex_1_1watchdog.html#af1d34b845b80a49997e82f50bb13f839">stdex::watchdog::m_callback</a></div><div class="ttdeci">std::function< void()> m_callback</div><div class="ttdoc">The function watchdog calls on timeout.</div><div class="ttdef"><b>Definition</b> watchdog.hpp:97</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Feb 21 2024 16:51:53 for stdex by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
|
|
</small></address>
|
|
</body>
|
|
</html>
|