Livox-SDK
112 lines
16 KiB
HTML
112 lines
16 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">
|
|
<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.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Livox SDK API: sdk_core/include/third_party/spdlog/spdlog/details/periodic_worker.h 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>
|
|
<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="1.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Livox SDK API
|
|
 <span id="projectnumber">V1.1.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<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('periodic__worker_8h_source.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="headertitle">
|
|
<div class="title">periodic_worker.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="periodic__worker_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Copyright(c) 2018 Gabi Melman.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Distributed under the MIT License (http://opensource.org/licenses/MIT)</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// periodic worker thread - periodically executes the given callback function.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// RAII over the owned thread:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// creates the thread on construction.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// stops and joins the thread on destruction (if the thread is executing a callback, wait for it to finish first).</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <chrono></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <condition_variable></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <functional></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <mutex></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <thread></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span><a class="code" href="namespacespdlog.html">spdlog</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span>details {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classspdlog_1_1details_1_1periodic__worker.html"> 23</a></span> <span class="keyword">class </span><a class="code" href="classspdlog_1_1details_1_1periodic__worker.html">periodic_worker</a></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classspdlog_1_1details_1_1periodic__worker.html#a16ae1b1cb27aa85efbc25a2f055d3523"> 26</a></span>  <a class="code" href="classspdlog_1_1details_1_1periodic__worker.html#a16ae1b1cb27aa85efbc25a2f055d3523">periodic_worker</a>(<span class="keyword">const</span> std::function<<span class="keywordtype">void</span>()> &callback_fun, std::chrono::seconds interval)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  active_ = (interval > std::chrono::seconds::zero());</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">if</span> (!active_)</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">return</span>;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  }</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  worker_thread_ = std::thread([<span class="keyword">this</span>, callback_fun, interval]() {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordflow">for</span> (;;)</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  std::unique_lock<std::mutex> lock(this->mutex_);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">if</span> (this->cv_.wait_for(lock, interval, [<span class="keyword">this</span>] { return !this->active_; }))</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">return</span>; <span class="comment">// active_ == false, so exit this thread</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  }</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  callback_fun();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  }</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  });</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classspdlog_1_1details_1_1periodic__worker.html#a16ae1b1cb27aa85efbc25a2f055d3523">periodic_worker</a>(<span class="keyword">const</span> <a class="code" href="classspdlog_1_1details_1_1periodic__worker.html">periodic_worker</a> &) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classspdlog_1_1details_1_1periodic__worker.html">periodic_worker</a> &<a class="code" href="classspdlog_1_1details_1_1periodic__worker.html#a81c0461ef77f85295b93991749df746b">operator=</a>(<span class="keyword">const</span> <a class="code" href="classspdlog_1_1details_1_1periodic__worker.html">periodic_worker</a> &) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// stop the worker thread and join it</span></div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classspdlog_1_1details_1_1periodic__worker.html#a21168ffd3a91ca2d82fd8959c205a464"> 51</a></span>  <a class="code" href="classspdlog_1_1details_1_1periodic__worker.html#a21168ffd3a91ca2d82fd8959c205a464">~periodic_worker</a>()</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">if</span> (worker_thread_.joinable())</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::lock_guard<std::mutex> lock(mutex_);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  active_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  cv_.notify_one();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  worker_thread_.join();</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">bool</span> active_;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  std::thread worker_thread_;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  std::mutex mutex_;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  std::condition_variable cv_;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> };</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> } <span class="comment">// namespace details</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> } <span class="comment">// namespace spdlog</span></div><div class="ttc" id="classspdlog_1_1details_1_1periodic__worker_html_a21168ffd3a91ca2d82fd8959c205a464"><div class="ttname"><a href="classspdlog_1_1details_1_1periodic__worker.html#a21168ffd3a91ca2d82fd8959c205a464">spdlog::details::periodic_worker::~periodic_worker</a></div><div class="ttdeci">~periodic_worker()</div><div class="ttdef"><b>Definition:</b> <a href="periodic__worker_8h_source.html#l00051">periodic_worker.h:51</a></div></div>
|
|
<div class="ttc" id="classspdlog_1_1details_1_1periodic__worker_html_a16ae1b1cb27aa85efbc25a2f055d3523"><div class="ttname"><a href="classspdlog_1_1details_1_1periodic__worker.html#a16ae1b1cb27aa85efbc25a2f055d3523">spdlog::details::periodic_worker::periodic_worker</a></div><div class="ttdeci">periodic_worker(const std::function< void()> &callback_fun, std::chrono::seconds interval)</div><div class="ttdef"><b>Definition:</b> <a href="periodic__worker_8h_source.html#l00026">periodic_worker.h:26</a></div></div>
|
|
<div class="ttc" id="namespacespdlog_html"><div class="ttname"><a href="namespacespdlog.html">spdlog</a></div><div class="ttdef"><b>Definition:</b> <a href="async_8h_source.html#l00027">async.h:27</a></div></div>
|
|
<div class="ttc" id="classspdlog_1_1details_1_1periodic__worker_html_a81c0461ef77f85295b93991749df746b"><div class="ttname"><a href="classspdlog_1_1details_1_1periodic__worker.html#a81c0461ef77f85295b93991749df746b">spdlog::details::periodic_worker::operator=</a></div><div class="ttdeci">periodic_worker & operator=(const periodic_worker &)=delete</div></div>
|
|
<div class="ttc" id="classspdlog_1_1details_1_1periodic__worker_html"><div class="ttname"><a href="classspdlog_1_1details_1_1periodic__worker.html">spdlog::details::periodic_worker</a></div><div class="ttdef"><b>Definition:</b> <a href="periodic__worker_8h_source.html#l00023">periodic_worker.h:23</a></div></div>
|
|
</div><!-- fragment --></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_5f1136fe404e0a548faf586fae339a6a.html">sdk_core</a></li><li class="navelem"><a class="el" href="dir_fef6b6f1028f30fedf17225feaaa02fe.html">include</a></li><li class="navelem"><a class="el" href="dir_7bb3e31efd6b819bbb0704cee4a66d41.html">third_party</a></li><li class="navelem"><a class="el" href="dir_cf58c3a45797022668a1e269b5315a33.html">spdlog</a></li><li class="navelem"><a class="el" href="dir_248a80cf6760c7a1ab13394a1c16f7b2.html">spdlog</a></li><li class="navelem"><a class="el" href="dir_7d093cd833acfccb787639923feedd9d.html">details</a></li><li class="navelem"><a class="el" href="periodic__worker_8h.html">periodic_worker.h</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|