167 lines
14 KiB
HTML
167 lines
14 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.13.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>My Project: include/utils/ThreadSafeQueue.hh 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>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.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>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { init_search(); });
|
|
/* @license-end */
|
|
</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">My Project
|
|
</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="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.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.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">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
</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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('ThreadSafeQueue_8hh_source.html',''); initResizable(true); });
|
|
/* @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">
|
|
<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 class="header">
|
|
<div class="headertitle"><div class="title">ThreadSafeQueue.hh</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="ThreadSafeQueue_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// C++ Includes</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include <queue></span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include <thread></span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <mutex></span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <condition_variable></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="keyword">namespace </span><a class="code hl_namespace" href="namespaceutils.html">utils</a> {</div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadSafeQueue.html"> 11</a></span><span class="keyword">class </span><a class="code hl_class" href="classutils_1_1ThreadSafeQueue.html">ThreadSafeQueue</a> {</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadSafeQueue.html#a970596f4c9a6d1a806b06d46807e06ee"> 13</a></span> std::queue<T> <a class="code hl_variable" href="classutils_1_1ThreadSafeQueue.html#a970596f4c9a6d1a806b06d46807e06ee">_queue</a>;</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadSafeQueue.html#a43fef8c13f23363c48bac7a6a49a565b"> 14</a></span> std::mutex <a class="code hl_variable" href="classutils_1_1ThreadSafeQueue.html#a43fef8c13f23363c48bac7a6a49a565b">_mutex</a>;</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadSafeQueue.html#aa8f60ba625a00977e004c6641325671e"> 15</a></span> std::condition_variable <a class="code hl_variable" href="classutils_1_1ThreadSafeQueue.html#aa8f60ba625a00977e004c6641325671e">_cv</a>;</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">public</span>:</div>
|
|
<div class="foldopen" id="foldopen00018" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadSafeQueue.html#a00347d38cfa085d97c67796779da2f33"> 18</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classutils_1_1ThreadSafeQueue.html#a00347d38cfa085d97c67796779da2f33">push</a>(T value) {</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> {</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> std::lock_guard<std::mutex> lock(<a class="code hl_variable" href="classutils_1_1ThreadSafeQueue.html#a43fef8c13f23363c48bac7a6a49a565b">_mutex</a>);</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_variable" href="classutils_1_1ThreadSafeQueue.html#a970596f4c9a6d1a806b06d46807e06ee">_queue</a>.push(std::move(value));</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> }</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_variable" href="classutils_1_1ThreadSafeQueue.html#aa8f60ba625a00977e004c6641325671e">_cv</a>.notify_one();</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
|
|
<div class="foldopen" id="foldopen00027" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadSafeQueue.html#a0fc878c7c3ed27b4c65bcf277b99a48b"> 27</a></span> T <a class="code hl_function" href="classutils_1_1ThreadSafeQueue.html#a0fc878c7c3ed27b4c65bcf277b99a48b">wait_and_pop</a>() {</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> std::unique_lock<std::mutex> lock(<a class="code hl_variable" href="classutils_1_1ThreadSafeQueue.html#a43fef8c13f23363c48bac7a6a49a565b">_mutex</a>);</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_variable" href="classutils_1_1ThreadSafeQueue.html#aa8f60ba625a00977e004c6641325671e">_cv</a>.wait(lock, [&] { <span class="keywordflow">return</span> !<a class="code hl_variable" href="classutils_1_1ThreadSafeQueue.html#a970596f4c9a6d1a806b06d46807e06ee">_queue</a>.empty(); });</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> T val = std::move(<a class="code hl_variable" href="classutils_1_1ThreadSafeQueue.html#a970596f4c9a6d1a806b06d46807e06ee">_queue</a>.front());</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_variable" href="classutils_1_1ThreadSafeQueue.html#a970596f4c9a6d1a806b06d46807e06ee">_queue</a>.pop();</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">return</span> val;</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>} <span class="comment">// End utils namespace</span></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadSafeQueue_html"><div class="ttname"><a href="classutils_1_1ThreadSafeQueue.html">utils::ThreadSafeQueue</a></div><div class="ttdef"><b>Definition</b> ThreadSafeQueue.hh:11</div></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadSafeQueue_html_a00347d38cfa085d97c67796779da2f33"><div class="ttname"><a href="classutils_1_1ThreadSafeQueue.html#a00347d38cfa085d97c67796779da2f33">utils::ThreadSafeQueue::push</a></div><div class="ttdeci">void push(T value)</div><div class="ttdef"><b>Definition</b> ThreadSafeQueue.hh:18</div></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadSafeQueue_html_a0fc878c7c3ed27b4c65bcf277b99a48b"><div class="ttname"><a href="classutils_1_1ThreadSafeQueue.html#a0fc878c7c3ed27b4c65bcf277b99a48b">utils::ThreadSafeQueue::wait_and_pop</a></div><div class="ttdeci">T wait_and_pop()</div><div class="ttdef"><b>Definition</b> ThreadSafeQueue.hh:27</div></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadSafeQueue_html_a43fef8c13f23363c48bac7a6a49a565b"><div class="ttname"><a href="classutils_1_1ThreadSafeQueue.html#a43fef8c13f23363c48bac7a6a49a565b">utils::ThreadSafeQueue::_mutex</a></div><div class="ttdeci">std::mutex _mutex</div><div class="ttdef"><b>Definition</b> ThreadSafeQueue.hh:14</div></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadSafeQueue_html_a970596f4c9a6d1a806b06d46807e06ee"><div class="ttname"><a href="classutils_1_1ThreadSafeQueue.html#a970596f4c9a6d1a806b06d46807e06ee">utils::ThreadSafeQueue::_queue</a></div><div class="ttdeci">std::queue< T > _queue</div><div class="ttdef"><b>Definition</b> ThreadSafeQueue.hh:13</div></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadSafeQueue_html_aa8f60ba625a00977e004c6641325671e"><div class="ttname"><a href="classutils_1_1ThreadSafeQueue.html#aa8f60ba625a00977e004c6641325671e">utils::ThreadSafeQueue::_cv</a></div><div class="ttdeci">std::condition_variable _cv</div><div class="ttdef"><b>Definition</b> ThreadSafeQueue.hh:15</div></div>
|
|
<div class="ttc" id="anamespaceutils_html"><div class="ttname"><a href="namespaceutils.html">utils</a></div><div class="ttdef"><b>Definition</b> ThreadPool.cc:11</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_821002d4f10779a80d4fb17bc32f21f1.html">utils</a></li><li class="navelem"><a class="el" href="ThreadSafeQueue_8hh.html">ThreadSafeQueue.hh</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|