| <!-- HTML header for doxygen 1.8.15--> |
| <!-- Remember to use version doxygen 1.8.15 +--> |
| <!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.15"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: Semaphore Class Reference</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> |
| <script type="text/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="stylesheet.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;"> |
| <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname"> |
|  <span id="projectnumber">19.02</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('classarm__compute_1_1_semaphore.xhtml','');}); |
| /* @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="summary"> |
| <a href="#pub-methods">Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Semaphore Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Semamphore class. |
| <a href="classarm__compute_1_1_semaphore.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_semaphore_8h_source.xhtml">Semaphore.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a5d450aa70997a73d56a0400cee4e539d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_semaphore.xhtml#a5d450aa70997a73d56a0400cee4e539d">Semaphore</a> (int value=0)</td></tr> |
| <tr class="memdesc:a5d450aa70997a73d56a0400cee4e539d"><td class="mdescLeft"> </td><td class="mdescRight">Default Constuctor. <a href="#a5d450aa70997a73d56a0400cee4e539d">More...</a><br /></td></tr> |
| <tr class="separator:a5d450aa70997a73d56a0400cee4e539d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2a0f4bfac2f24aa0a07de86141381aec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_semaphore.xhtml#a2a0f4bfac2f24aa0a07de86141381aec">signal</a> ()</td></tr> |
| <tr class="memdesc:a2a0f4bfac2f24aa0a07de86141381aec"><td class="mdescLeft"> </td><td class="mdescRight">Signals a semaphore. <a href="#a2a0f4bfac2f24aa0a07de86141381aec">More...</a><br /></td></tr> |
| <tr class="separator:a2a0f4bfac2f24aa0a07de86141381aec"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa3b21853f890838c88d047d6c2786917"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_semaphore.xhtml#aa3b21853f890838c88d047d6c2786917">wait</a> ()</td></tr> |
| <tr class="memdesc:aa3b21853f890838c88d047d6c2786917"><td class="mdescLeft"> </td><td class="mdescRight">Waits on a semaphore. <a href="#aa3b21853f890838c88d047d6c2786917">More...</a><br /></td></tr> |
| <tr class="separator:aa3b21853f890838c88d047d6c2786917"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Semamphore class. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_semaphore_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_semaphore_8h_source.xhtml">Semaphore.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a5d450aa70997a73d56a0400cee4e539d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5d450aa70997a73d56a0400cee4e539d">◆ </a></span>Semaphore()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1_semaphore.xhtml">Semaphore</a> </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>value</em> = <code>0</code></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default Constuctor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td><a class="el" href="classarm__compute_1_1_semaphore.xhtml" title="Semamphore class.">Semaphore</a> initial value </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_semaphore_8h_source.xhtml#l00042">42</a> of file <a class="el" href="_semaphore_8h_source.xhtml">Semaphore.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  : _value(value), _m(), _cv()</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><!-- fragment --> |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a2a0f4bfac2f24aa0a07de86141381aec"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2a0f4bfac2f24aa0a07de86141381aec">◆ </a></span>signal()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void signal </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Signals a semaphore. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_semaphore_8h_source.xhtml#l00047">47</a> of file <a class="el" href="_semaphore_8h_source.xhtml">Semaphore.h</a>.</p> |
| <div class="fragment"><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>  std::lock_guard<std::mutex> lock(_m);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  ++_value;</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>  _cv.notify_one();</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="aa3b21853f890838c88d047d6c2786917"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa3b21853f890838c88d047d6c2786917">◆ </a></span>wait()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void wait </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Waits on a semaphore. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_semaphore_8h_source.xhtml#l00056">56</a> of file <a class="el" href="_semaphore_8h_source.xhtml">Semaphore.h</a>.</p> |
| <div class="fragment"><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>  std::unique_lock<std::mutex> lock(_m);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  _cv.wait(lock, [<span class="keyword">this</span>]()</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>  <span class="keywordflow">return</span> _value > 0;</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>  --_value;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>support/<a class="el" href="_semaphore_8h_source.xhtml">Semaphore.h</a></li> |
| </ul> |
| </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="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_semaphore.xhtml">Semaphore</a></li> |
| <li class="footer">Generated on Thu Feb 28 2019 12:25:04 for Compute Library 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> |