You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

77 lines
6.1 KiB

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
  3. <title>tbb::recursive_mutex::scoped_lock Class Reference</title>
  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
  5. <link href="tabs.css" rel="stylesheet" type="text/css">
  6. </head><body>
  7. <!-- Generated by Doxygen 1.4.7 -->
  8. <div class="tabs">
  9. <ul>
  10. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  11. <li><a href="modules.html"><span>Modules</span></a></li>
  12. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  13. <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
  14. <li><a href="files.html"><span>Files</span></a></li>
  15. <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  16. </ul></div>
  17. <div class="tabs">
  18. <ul>
  19. <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  20. <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  21. <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  22. </ul></div>
  23. <div class="nav">
  24. <a class="el" href="a00428.html">tbb</a>::<a class="el" href="a00334.html">recursive_mutex</a>::<a class="el" href="a00335.html">scoped_lock</a></div>
  25. <h1>tbb::recursive_mutex::scoped_lock Class Reference</h1><!-- doxytag: class="tbb::recursive_mutex::scoped_lock" -->The scoped locking pattern.
  26. <a href="#_details">More...</a>
  27. <p>
  28. <code>#include &lt;recursive_mutex.h&gt;</code>
  29. <p>
  30. <a href="a00120.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  31. <tr><td></td></tr>
  32. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  33. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d82d4d36fbf9727a493d26ae50855fe7"></a><!-- doxytag: member="tbb::recursive_mutex::scoped_lock::scoped_lock" ref="d82d4d36fbf9727a493d26ae50855fe7" args="()" -->
  34. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00335.html#d82d4d36fbf9727a493d26ae50855fe7">scoped_lock</a> ()</td></tr>
  35. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct lock that has not acquired a <a class="el" href="a00334.html">recursive_mutex</a>. <br></td></tr>
  36. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dec17713c4c1321ac8fec66816d0c602"></a><!-- doxytag: member="tbb::recursive_mutex::scoped_lock::scoped_lock" ref="dec17713c4c1321ac8fec66816d0c602" args="(recursive_mutex &amp;mutex)" -->
  37. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00335.html#dec17713c4c1321ac8fec66816d0c602">scoped_lock</a> (<a class="el" href="a00334.html">recursive_mutex</a> &amp;<a class="el" href="a00313.html">mutex</a>)</td></tr>
  38. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Acquire lock on given mutex. <br></td></tr>
  39. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1197ffb8f3cd9d4fed71d7e06265b7c"></a><!-- doxytag: member="tbb::recursive_mutex::scoped_lock::~scoped_lock" ref="c1197ffb8f3cd9d4fed71d7e06265b7c" args="()" -->
  40. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00335.html#c1197ffb8f3cd9d4fed71d7e06265b7c">~scoped_lock</a> ()</td></tr>
  41. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release lock (if lock is held). <br></td></tr>
  42. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fb04da37cccf8c99b1f9102d9074f9a"></a><!-- doxytag: member="tbb::recursive_mutex::scoped_lock::acquire" ref="7fb04da37cccf8c99b1f9102d9074f9a" args="(recursive_mutex &amp;mutex)" -->
  43. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00335.html#7fb04da37cccf8c99b1f9102d9074f9a">acquire</a> (<a class="el" href="a00334.html">recursive_mutex</a> &amp;<a class="el" href="a00313.html">mutex</a>)</td></tr>
  44. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Acquire lock on given mutex. <br></td></tr>
  45. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="36bfc3e93e3ef6340abef4901444d340"></a><!-- doxytag: member="tbb::recursive_mutex::scoped_lock::try_acquire" ref="36bfc3e93e3ef6340abef4901444d340" args="(recursive_mutex &amp;mutex)" -->
  46. bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00335.html#36bfc3e93e3ef6340abef4901444d340">try_acquire</a> (<a class="el" href="a00334.html">recursive_mutex</a> &amp;<a class="el" href="a00313.html">mutex</a>)</td></tr>
  47. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Try acquire lock on given <a class="el" href="a00334.html">recursive_mutex</a>. <br></td></tr>
  48. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ac480ea0e9d5ea0345a67d57008b6263"></a><!-- doxytag: member="tbb::recursive_mutex::scoped_lock::release" ref="ac480ea0e9d5ea0345a67d57008b6263" args="()" -->
  49. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00335.html#ac480ea0e9d5ea0345a67d57008b6263">release</a> ()</td></tr>
  50. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release lock. <br></td></tr>
  51. <tr><td colspan="2"><br><h2>Friends</h2></td></tr>
  52. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="459818b78a3e9985dc5a9d5638b6593e"></a><!-- doxytag: member="tbb::recursive_mutex::scoped_lock::recursive_mutex" ref="459818b78a3e9985dc5a9d5638b6593e" args="" -->
  53. class&nbsp;</td><td class="memItemRight" valign="bottom"><b>recursive_mutex</b></td></tr>
  54. </table>
  55. <hr><a name="_details"></a><h2>Detailed Description</h2>
  56. The scoped locking pattern.
  57. <p>
  58. It helps to avoid the common problem of forgetting to release lock. It also nicely provides the "node" for queuing locks.
  59. <p>
  60. <hr>The documentation for this class was generated from the following file:<ul>
  61. <li>recursive_mutex.h</ul>
  62. <hr>
  63. <p></p>
  64. Copyright &copy; 2005-2013 Intel Corporation. All Rights Reserved.
  65. <p></p>
  66. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  67. registered trademarks or trademarks of Intel Corporation or its
  68. subsidiaries in the United States and other countries.
  69. <p></p>
  70. * Other names and brands may be claimed as the property of others.