diff options
Diffstat (limited to 'syncqueue_8h_source.html')
| -rw-r--r-- | syncqueue_8h_source.html | 214 |
1 files changed, 214 insertions, 0 deletions
diff --git a/syncqueue_8h_source.html b/syncqueue_8h_source.html new file mode 100644 index 00000000..01c7b782 --- /dev/null +++ b/syncqueue_8h_source.html @@ -0,0 +1,214 @@ +<!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.6"/> +<title>YAGE: yage/util/syncqueue.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="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 style="padding-left: 0.5em;"> + <div id="projectname">YAGE +  <span id="projectnumber">v0.1.3.0</span> + </div> + <div id="projectbrief">Yet Another Game Engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<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="namespaces.html"><span>Namespaces</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> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </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"> +$(document).ready(function(){initNavTree('syncqueue_8h_source.html','');}); +</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)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></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">syncqueue.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="syncqueue_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="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef YAGE_UTIL_SYNCQUEUE_H</span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"></span><span class="preprocessor">#define YAGE_UTIL_SYNCQUEUE_H</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <condition_variable></span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <mutex></span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <queue></span></div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span>yage</div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</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> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div> +<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classyage_1_1SyncQueue.html"> 20</a></span> <span class="keyword">class </span><a class="code" href="classyage_1_1SyncQueue.html">SyncQueue</a></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> {</div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="classyage_1_1SyncQueue.html#a0c8aa1c22e3e6d5094dbdeb88cff426b">SyncQueue</a>() = <span class="keywordflow">default</span>;</div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="classyage_1_1SyncQueue.html#a0c8aa1c22e3e6d5094dbdeb88cff426b">SyncQueue</a>(<span class="keyword">const</span> <a class="code" href="classyage_1_1SyncQueue.html">SyncQueue</a> &) = <span class="keyword">delete</span>;</div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="classyage_1_1SyncQueue.html">SyncQueue</a> &<a class="code" href="classyage_1_1SyncQueue.html#a43e4ba65c8e367ed55da9b8e3e1567b6">operator=</a>(<span class="keyword">const</span> <a class="code" href="classyage_1_1SyncQueue.html">SyncQueue</a> &) = <span class="keyword">delete</span>;</div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="namespaceyage.html#ad5a9307442e5daa8810aff942564a822ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> <a class="code" href="classyage_1_1SyncQueue.html#a1f7f099e1347b82c1f2b72a5352ca05e">pop</a>();</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordtype">void</span> <a class="code" href="classyage_1_1SyncQueue.html#a1f7f099e1347b82c1f2b72a5352ca05e">pop</a>(<a class="code" href="namespaceyage.html#ad5a9307442e5daa8810aff942564a822ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> &item);</div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordtype">void</span> <a class="code" href="classyage_1_1SyncQueue.html#a4ef8940b49b9c1b7a213fd38847370b1">push</a>(<span class="keyword">const</span> <a class="code" href="namespaceyage.html#ad5a9307442e5daa8810aff942564a822ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> &item);</div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordtype">void</span> <a class="code" href="classyage_1_1SyncQueue.html#a4ef8940b49b9c1b7a213fd38847370b1">push</a>(<a class="code" href="namespaceyage.html#ad5a9307442e5daa8810aff942564a822ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> &&item);</div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">private</span>:</div> +<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classyage_1_1SyncQueue.html#ae554585c8b44da0db79a0767c1b90968"> 33</a></span>  std::queue<T> <a class="code" href="classyage_1_1SyncQueue.html#ae554585c8b44da0db79a0767c1b90968">queue_</a>;</div> +<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classyage_1_1SyncQueue.html#a273dec7f58d6a727d32dcfc9b3c9622b"> 34</a></span>  std::mutex <a class="code" href="classyage_1_1SyncQueue.html#a273dec7f58d6a727d32dcfc9b3c9622b">mutex_</a>;</div> +<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classyage_1_1SyncQueue.html#af1682d934e8a71dad6718977240e83e4"> 35</a></span>  std::condition_variable <a class="code" href="classyage_1_1SyncQueue.html#af1682d934e8a71dad6718977240e83e4">cond_</a>;</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> </div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// Template definitions</span></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="keyword">template</span> <<span class="keyword">typename</span> T></div> +<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classyage_1_1SyncQueue.html#a1f7f099e1347b82c1f2b72a5352ca05e"> 41</a></span> <a class="code" href="namespaceyage.html#ad5a9307442e5daa8810aff942564a822ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> <a class="code" href="classyage_1_1SyncQueue.html#a1f7f099e1347b82c1f2b72a5352ca05e">SyncQueue<T>::pop</a>()</div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  std::unique_lock<std::mutex> mlock(mutex_);</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="keywordflow">while</span> (queue_.empty()) {</div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  cond_.wait(mlock);</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  }</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>  <span class="keyword">auto</span> item = queue_.front();</div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  queue_.pop();</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">return</span> item;</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> </div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div> +<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classyage_1_1SyncQueue.html#ab8a3c646e1d2f9adfcbcfbaa2e2a4b27"> 55</a></span> <span class="keywordtype">void</span> <a class="code" href="classyage_1_1SyncQueue.html#a1f7f099e1347b82c1f2b72a5352ca05e">SyncQueue<T>::pop</a>(T &item)</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  std::unique_lock<std::mutex> mlock(mutex_);</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>  <span class="keywordflow">while</span> (queue_.empty()) {</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  cond_.wait(mlock);</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>  item = queue_.front();</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  queue_.pop();</div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> }</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div> +<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classyage_1_1SyncQueue.html#a4ef8940b49b9c1b7a213fd38847370b1"> 68</a></span> <span class="keywordtype">void</span> <a class="code" href="classyage_1_1SyncQueue.html#a4ef8940b49b9c1b7a213fd38847370b1">SyncQueue<T>::push</a>(<span class="keyword">const</span> T &item)</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>  std::unique_lock<std::mutex> mlock(mutex_);</div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  queue_.push(item);</div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  mlock.unlock();</div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  cond_.notify_one();</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="keyword">template</span> <<span class="keyword">typename</span> T></div> +<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classyage_1_1SyncQueue.html#a4c01a855e97a46449a97c76634ef7678"> 78</a></span> <span class="keywordtype">void</span> <a class="code" href="classyage_1_1SyncQueue.html#a4ef8940b49b9c1b7a213fd38847370b1">SyncQueue<T>::push</a>(T &&item)</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>  std::unique_lock<std::mutex> mlock(mutex_);</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>  queue_.push(std::move(item));</div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  mlock.unlock();</div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  cond_.notify_one();</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="comment">// namespace yage</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">#endif</span></div> +<div class="ttc" id="classyage_1_1SyncQueue_html_a0c8aa1c22e3e6d5094dbdeb88cff426b"><div class="ttname"><a href="classyage_1_1SyncQueue.html#a0c8aa1c22e3e6d5094dbdeb88cff426b">yage::SyncQueue::SyncQueue</a></div><div class="ttdeci">SyncQueue()=default</div></div> +<div class="ttc" id="classyage_1_1SyncQueue_html_a43e4ba65c8e367ed55da9b8e3e1567b6"><div class="ttname"><a href="classyage_1_1SyncQueue.html#a43e4ba65c8e367ed55da9b8e3e1567b6">yage::SyncQueue::operator=</a></div><div class="ttdeci">SyncQueue & operator=(const SyncQueue &)=delete</div></div> +<div class="ttc" id="classyage_1_1SyncQueue_html_a1f7f099e1347b82c1f2b72a5352ca05e"><div class="ttname"><a href="classyage_1_1SyncQueue.html#a1f7f099e1347b82c1f2b72a5352ca05e">yage::SyncQueue::pop</a></div><div class="ttdeci">T pop()</div><div class="ttdef"><b>Definition:</b> syncqueue.h:41</div></div> +<div class="ttc" id="classyage_1_1SyncQueue_html_af1682d934e8a71dad6718977240e83e4"><div class="ttname"><a href="classyage_1_1SyncQueue.html#af1682d934e8a71dad6718977240e83e4">yage::SyncQueue::cond_</a></div><div class="ttdeci">std::condition_variable cond_</div><div class="ttdef"><b>Definition:</b> syncqueue.h:35</div></div> +<div class="ttc" id="classyage_1_1SyncQueue_html_a273dec7f58d6a727d32dcfc9b3c9622b"><div class="ttname"><a href="classyage_1_1SyncQueue.html#a273dec7f58d6a727d32dcfc9b3c9622b">yage::SyncQueue::mutex_</a></div><div class="ttdeci">std::mutex mutex_</div><div class="ttdef"><b>Definition:</b> syncqueue.h:34</div></div> +<div class="ttc" id="classyage_1_1SyncQueue_html_a4ef8940b49b9c1b7a213fd38847370b1"><div class="ttname"><a href="classyage_1_1SyncQueue.html#a4ef8940b49b9c1b7a213fd38847370b1">yage::SyncQueue::push</a></div><div class="ttdeci">void push(const T &item)</div><div class="ttdef"><b>Definition:</b> syncqueue.h:68</div></div> +<div class="ttc" id="namespaceyage_html_ad5a9307442e5daa8810aff942564a822ab9ece18c950afbfa6b0fdbfa4ff731d3"><div class="ttname"><a href="namespaceyage.html#ad5a9307442e5daa8810aff942564a822ab9ece18c950afbfa6b0fdbfa4ff731d3">yage::key::T</a></div></div> +<div class="ttc" id="classyage_1_1SyncQueue_html_ae554585c8b44da0db79a0767c1b90968"><div class="ttname"><a href="classyage_1_1SyncQueue.html#ae554585c8b44da0db79a0767c1b90968">yage::SyncQueue::queue_</a></div><div class="ttdeci">std::queue< T > queue_</div><div class="ttdef"><b>Definition:</b> syncqueue.h:33</div></div> +<div class="ttc" id="classyage_1_1SyncQueue_html"><div class="ttname"><a href="classyage_1_1SyncQueue.html">yage::SyncQueue</a></div><div class="ttdef"><b>Definition:</b> syncqueue.h:20</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_0a5be4b85c8e2c05f7a9f5a803f53125.html">yage</a></li><li class="navelem"><a class="el" href="dir_48a91ae829881cbedcfc124d2027890d.html">util</a></li><li class="navelem"><a class="el" href="syncqueue_8h.html">syncqueue.h</a></li> + <li class="footer">Generated on Sat Dec 23 2017 01:02:05 for YAGE by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> + </ul> +</div> +</body> +</html> |