-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path_data_queue_8h_source.html
More file actions
108 lines (106 loc) · 18.2 KB
/
_data_queue_8h_source.html
File metadata and controls
108 lines (106 loc) · 18.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<!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.11"/>
<title>OXII: /home/pieter/CLionProjects/OXII/src/Utils/Queue/DataQueue.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="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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OXII
 <span id="projectnumber">0.0.0</span>
</div>
<div id="projectbrief">OXII, the Nuna On-Board computer</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_148f265b2a469352ff294886af73b94d.html">OXII</a></li><li class="navelem"><a class="el" href="dir_14d9778ac3ac6187df74d1bf79afd578.html">src</a></li><li class="navelem"><a class="el" href="dir_b9d9ef4d57d7b8fdad9cf4bda2c98058.html">Utils</a></li><li class="navelem"><a class="el" href="dir_886ab85d3ce1a7a7cd04eea8b7c115f0.html">Queue</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">DataQueue.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Created by pieter on 15-10-18.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#ifndef OXII_DATAQUEUE_H</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#define OXII_DATAQUEUE_H</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "readerwriterqueue.h"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <iostream></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "../Time.h"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">using namespace </span><a class="code" href="namespacestd.html">std</a>;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">using namespace </span><a class="code" href="namespacemoodycamel.html">moodycamel</a>;</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="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="class_data_queue.html"> 16</a></span> <span class="keyword">class </span><a class="code" href="class_data_queue.html">DataQueue</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <a class="code" href="class_data_queue.html">DataQueue</a>() : q(1) {};</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <a class="code" href="class_data_queue.html">DataQueue</a>(<span class="keywordtype">int</span> capacity) : q(capacity), capacity_(capacity) {};</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <a class="code" href="class_data_queue.html">DataQueue</a>(<span class="keywordtype">int</span> capacity, milliseconds timeout) : q(capacity), capacity_(capacity), can_expire(<span class="keyword">true</span>), timeout_(timeout) {};</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <a class="code" href="class_data_queue.html">DataQueue</a>(<span class="keywordtype">int</span> capacity, <span class="keywordtype">string</span> name) : q(capacity), capacity_(capacity), name_(name) {};</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="class_data_queue.html">DataQueue</a>(<span class="keywordtype">int</span> capacity, <span class="keywordtype">string</span> name, milliseconds timeout) : q(capacity), capacity_(capacity), name_(name), can_expire(<span class="keyword">true</span>), timeout_(timeout) {};</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="class_data_queue.html#a0c4c086a852fd214fef115ac387b891a"> 37</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_data_queue.html#a0c4c086a852fd214fef115ac387b891a">pop</a>(T & result) {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">if</span> (can_expire && !IsValid()) {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  clear();</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  T data;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  result = data;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</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>  <span class="keywordtype">bool</span> status = q.try_dequeue(result);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">if</span> (status) count--;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">return</span> status;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</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="keywordtype">void</span> push(T data) {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">if</span> (count == capacity_) {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  T item;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  pop(item);</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>  q.enqueue(data);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  count++;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">if</span> (can_expire) {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  last_update_ = system_clock::now();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</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="l00066"></a><span class="lineno"><a class="line" href="class_data_queue.html#aa58efc31b559f2b808fddcfcb2f933ce"> 66</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_data_queue.html#aa58efc31b559f2b808fddcfcb2f933ce">clear</a>() {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">while</span> (q.pop()) {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</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> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">bool</span> WaitForItem(T & item, std::chrono::milliseconds time) {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">bool</span> status = q.wait_dequeue_timed(item, time);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">if</span> (status) count--;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">return</span> status;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">bool</span> IsEmpty() {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> count == 0;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">int</span> GetCount() {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> count;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="class_data_queue.html#ab6fc11d7e74b2b6758583145a6650103"> 91</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_data_queue.html#ab6fc11d7e74b2b6758583145a6650103">IsValid</a>() {</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">if</span> (!can_expire) {</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">return</span> Time::TimeSince(last_update_) < timeout_;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <a class="code" href="classmoodycamel_1_1_blocking_reader_writer_queue.html">BlockingReaderWriterQueue<T></a> q;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">int</span> count = 0;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">int</span> capacity_ = 1;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">bool</span> can_expire = <span class="keyword">false</span>;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  milliseconds timeout_ = 1s;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  time_point<system_clock> last_update_;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">string</span> name_ = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> };</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#endif //OXII_DATAQUEUE_H</span></div><div class="ttc" id="namespacemoodycamel_html"><div class="ttname"><a href="namespacemoodycamel.html">moodycamel</a></div><div class="ttdef"><b>Definition:</b> atomicops.h:70</div></div>
<div class="ttc" id="namespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdef"><b>Definition:</b> gtest-tuple.h:113</div></div>
<div class="ttc" id="class_data_queue_html"><div class="ttname"><a href="class_data_queue.html">DataQueue</a></div><div class="ttdef"><b>Definition:</b> DataQueue.h:16</div></div>
<div class="ttc" id="class_data_queue_html_ab6fc11d7e74b2b6758583145a6650103"><div class="ttname"><a href="class_data_queue.html#ab6fc11d7e74b2b6758583145a6650103">DataQueue::IsValid</a></div><div class="ttdeci">bool IsValid()</div><div class="ttdoc">Checks the time since the last item was pushed onto this queue. </div><div class="ttdef"><b>Definition:</b> DataQueue.h:91</div></div>
<div class="ttc" id="class_data_queue_html_a0c4c086a852fd214fef115ac387b891a"><div class="ttname"><a href="class_data_queue.html#a0c4c086a852fd214fef115ac387b891a">DataQueue::pop</a></div><div class="ttdeci">bool pop(T &result)</div><div class="ttdoc">Pops item from queue and stores it in result. </div><div class="ttdef"><b>Definition:</b> DataQueue.h:37</div></div>
<div class="ttc" id="classmoodycamel_1_1_blocking_reader_writer_queue_html"><div class="ttname"><a href="classmoodycamel_1_1_blocking_reader_writer_queue.html">moodycamel::BlockingReaderWriterQueue< T ></a></div></div>
<div class="ttc" id="class_data_queue_html_aa58efc31b559f2b808fddcfcb2f933ce"><div class="ttname"><a href="class_data_queue.html#aa58efc31b559f2b808fddcfcb2f933ce">DataQueue::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Empties the queue. </div><div class="ttdef"><b>Definition:</b> DataQueue.h:66</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>