-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_queue_8h_source.html
72 lines (72 loc) · 17.8 KB
/
_queue_8h_source.html
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
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gamedev Framework (gf): Queue.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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.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="gf_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Gamedev Framework (gf)
 <span id="projectnumber">0.6.0</span>
</div>
<div id="projectbrief">A C++11 framework for 2D games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></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_6d069d519ae9d12fa11dd8e685586b60.html">gf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Queue.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"> * Gamedev Framework (gf)</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2016-2017 Julien Bernard</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This software is provided 'as-is', without any express or implied</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * warranty. In no event will the authors be held liable for any damages</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * arising from the use of this software.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Permission is granted to anyone to use this software for any purpose,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * including commercial applications, and to alter it and redistribute it</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * freely, subject to the following restrictions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * 1. The origin of this software must not be misrepresented; you must not</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * claim that you wrote the original software. If you use this software</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * in a product, an acknowledgment in the product documentation would be</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * appreciated but is not required.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * 2. Altered source versions must be plainly marked as such, and must not be</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * misrepresented as being the original software.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * 3. This notice may not be removed or altered from any source distribution.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">GF_QUEUE_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">GF_QUEUE_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <span class="preprocessor"><</span><span class="preprocessor">condition_variable</span><span class="preprocessor">></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <span class="preprocessor"><</span><span class="preprocessor">deque</span><span class="preprocessor">></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <span class="preprocessor"><</span><span class="preprocessor">mutex</span><span class="preprocessor">></span></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> <span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="_portability_8h.html">"Portability.h"</a></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace</span> <a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">inline</span> <span class="keyword">namespace</span> v1 {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">/**</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * @ingroup core</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * @brief A simple concurrent queue</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> *</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * This is a simple concurrent queue that can be used in a multi-threaded</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * application. For example, it can be used between a thread that receives</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * messages from the network and the main loop that handles the messages.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> */</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classgf_1_1_queue.html"> 44</a></span>  <span class="keyword">class</span> <a class="code" href="_portability_8h.html#a0169111e0ff1d9fe0f23dee89e904d57">GF_API</a> <a class="code" href="classgf_1_1_queue.html">Queue</a> {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">/**</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * @brief Poll a value from the queue, if possible</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> *</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @param value A reference for the result</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @return True if a value was poped from the queue</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classgf_1_1_queue.html#a903561ebf611e0d556315999569e6f89"> 52</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_queue.html#a903561ebf611e0d556315999569e6f89">poll</a>(T& value) {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  std::unique_lock<std::mutex> lock(m_mutex);</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>  <span class="keywordflow">if</span> (m_queue.empty()) {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</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> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  value = m_queue.front();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  m_queue.pop_front();</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> <span class="keyword">true</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="comment">/**</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @brief Push a value on the queue</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> *</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * @param value The value to push on the queue</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> */</span></div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classgf_1_1_queue.html#a6e868058e9ac5db97e89fb625a9b87dd"> 69</a></span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_queue.html#a6e868058e9ac5db97e89fb625a9b87dd">push</a>(<span class="keyword">const</span> T& value) {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  std::unique_lock<std::mutex> lock(m_mutex);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  m_queue.push_back(value);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">/**</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * @brief Clear the queue</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> */</span></div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classgf_1_1_queue.html#a24be99879f6ecad83affa999730e72d5"> 77</a></span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_queue.html#a24be99879f6ecad83affa999730e72d5">clear</a>() {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  std::unique_lock<std::mutex> lock(m_mutex);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  m_queue.clear();</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> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  std::mutex m_mutex;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  std::deque<T> m_queue;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  };</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> }</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> }</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span> <span class="comment">// GF_QUEUE_H</span></div><div class="ttc" id="classgf_1_1_queue_html_a6e868058e9ac5db97e89fb625a9b87dd"><div class="ttname"><a href="classgf_1_1_queue.html#a6e868058e9ac5db97e89fb625a9b87dd">gf::Queue::push</a></div><div class="ttdeci">void push(const T &value)</div><div class="ttdoc">Push a value on the queue. </div><div class="ttdef"><b>Definition:</b> Queue.h:69</div></div>
<div class="ttc" id="classgf_1_1_queue_html"><div class="ttname"><a href="classgf_1_1_queue.html">gf::Queue</a></div><div class="ttdoc">A simple concurrent queue. </div><div class="ttdef"><b>Definition:</b> Queue.h:44</div></div>
<div class="ttc" id="classgf_1_1_queue_html_a903561ebf611e0d556315999569e6f89"><div class="ttname"><a href="classgf_1_1_queue.html#a903561ebf611e0d556315999569e6f89">gf::Queue::poll</a></div><div class="ttdeci">bool poll(T &value)</div><div class="ttdoc">Poll a value from the queue, if possible. </div><div class="ttdef"><b>Definition:</b> Queue.h:52</div></div>
<div class="ttc" id="namespacegf_html"><div class="ttname"><a href="namespacegf.html">gf</a></div><div class="ttdoc">The namespace for gf classes. </div><div class="ttdef"><b>Definition:</b> Action.h:34</div></div>
<div class="ttc" id="classgf_1_1_queue_html_a24be99879f6ecad83affa999730e72d5"><div class="ttname"><a href="classgf_1_1_queue.html#a24be99879f6ecad83affa999730e72d5">gf::Queue::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clear the queue. </div><div class="ttdef"><b>Definition:</b> Queue.h:77</div></div>
<div class="ttc" id="_portability_8h_html_a0169111e0ff1d9fe0f23dee89e904d57"><div class="ttname"><a href="_portability_8h.html#a0169111e0ff1d9fe0f23dee89e904d57">GF_API</a></div><div class="ttdeci">#define GF_API</div><div class="ttdef"><b>Definition:</b> Portability.h:35</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.13
</small></address>
</body>
</html>