118 lines
7.8 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 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></div>
  25. <h1>tbb::recursive_mutex Class Reference<br>
  26. <small>
  27. [<a class="el" href="a00444.html">Synchronization</a>]</small>
  28. </h1><!-- doxytag: class="tbb::recursive_mutex" -->Mutex that allows recursive mutex acquisition.
  29. <a href="#_details">More...</a>
  30. <p>
  31. <code>#include &lt;recursive_mutex.h&gt;</code>
  32. <p>
  33. <a href="a00119.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  34. <tr><td></td></tr>
  35. <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
  36. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="889fa8cc32dd707eef7c0f52dda09c0d"></a><!-- doxytag: member="tbb::recursive_mutex::native_handle_type" ref="889fa8cc32dd707eef7c0f52dda09c0d" args="" -->
  37. typedef LPCRITICAL_SECTION&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00334.html#889fa8cc32dd707eef7c0f52dda09c0d">native_handle_type</a></td></tr>
  38. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return native_handle. <br></td></tr>
  39. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26a40fae42bf6cd9f3f77ee7482d6164"></a><!-- doxytag: member="tbb::recursive_mutex::native_handle_type" ref="26a40fae42bf6cd9f3f77ee7482d6164" args="" -->
  40. typedef pthread_mutex_t *&nbsp;</td><td class="memItemRight" valign="bottom"><b>native_handle_type</b></td></tr>
  41. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  42. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d2fceb7f95c24a8cd1457d4527e4b8c6"></a><!-- doxytag: member="tbb::recursive_mutex::recursive_mutex" ref="d2fceb7f95c24a8cd1457d4527e4b8c6" args="()" -->
  43. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00334.html#d2fceb7f95c24a8cd1457d4527e4b8c6">recursive_mutex</a> ()</td></tr>
  44. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct unacquired <a class="el" href="a00334.html">recursive_mutex</a>. <br></td></tr>
  45. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c342c69d47f4bb0b393535dee4015d6"></a><!-- doxytag: member="tbb::recursive_mutex::lock" ref="4c342c69d47f4bb0b393535dee4015d6" args="()" -->
  46. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00334.html#4c342c69d47f4bb0b393535dee4015d6">lock</a> ()</td></tr>
  47. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Acquire lock. <br></td></tr>
  48. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00334.html#86e719b0afee25704af11ab97694d240">try_lock</a> ()</td></tr>
  49. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Try acquiring lock (non-blocking). <a href="#86e719b0afee25704af11ab97694d240"></a><br></td></tr>
  50. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f0a96e26b7f074588dc31e32524856ae"></a><!-- doxytag: member="tbb::recursive_mutex::unlock" ref="f0a96e26b7f074588dc31e32524856ae" args="()" -->
  51. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00334.html#f0a96e26b7f074588dc31e32524856ae">unlock</a> ()</td></tr>
  52. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release lock. <br></td></tr>
  53. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6baa9ce4b394c39622456fd8a68f8bd8"></a><!-- doxytag: member="tbb::recursive_mutex::native_handle" ref="6baa9ce4b394c39622456fd8a68f8bd8" args="()" -->
  54. <a class="el" href="a00334.html#889fa8cc32dd707eef7c0f52dda09c0d">native_handle_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>native_handle</b> ()</td></tr>
  55. <tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
  56. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="718cc53f6b33d8c396ccca0e4ebc5606"></a><!-- doxytag: member="tbb::recursive_mutex::is_rw_mutex" ref="718cc53f6b33d8c396ccca0e4ebc5606" args="" -->
  57. static const bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>is_rw_mutex</b> = false</td></tr>
  58. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6149d7541063d8b35afd98df6f0f89d"></a><!-- doxytag: member="tbb::recursive_mutex::is_recursive_mutex" ref="f6149d7541063d8b35afd98df6f0f89d" args="" -->
  59. static const bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>is_recursive_mutex</b> = true</td></tr>
  60. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f01aacad6b9b9d51573c0803323182fe"></a><!-- doxytag: member="tbb::recursive_mutex::is_fair_mutex" ref="f01aacad6b9b9d51573c0803323182fe" args="" -->
  61. static const bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>is_fair_mutex</b> = false</td></tr>
  62. <tr><td colspan="2"><br><h2>Friends</h2></td></tr>
  63. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a36f15b770a1bb0b56e33d7fa75ebd1a"></a><!-- doxytag: member="tbb::recursive_mutex::scoped_lock" ref="a36f15b770a1bb0b56e33d7fa75ebd1a" args="" -->
  64. class&nbsp;</td><td class="memItemRight" valign="bottom"><b>scoped_lock</b></td></tr>
  65. <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
  66. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00335.html">scoped_lock</a></td></tr>
  67. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The scoped locking pattern. <a href="a00335.html#_details">More...</a><br></td></tr>
  68. </table>
  69. <hr><a name="_details"></a><h2>Detailed Description</h2>
  70. Mutex that allows recursive mutex acquisition.
  71. <p>
  72. Mutex that allows recursive mutex acquisition.
  73. <p>
  74. <hr><h2>Member Function Documentation</h2>
  75. <a class="anchor" name="86e719b0afee25704af11ab97694d240"></a><!-- doxytag: member="tbb::recursive_mutex::try_lock" ref="86e719b0afee25704af11ab97694d240" args="()" -->
  76. <div class="memitem">
  77. <div class="memproto">
  78. <table class="memname">
  79. <tr>
  80. <td class="memname">bool tbb::recursive_mutex::try_lock </td>
  81. <td>(</td>
  82. <td class="paramname"> </td>
  83. <td>&nbsp;)&nbsp;</td>
  84. <td width="100%"><code> [inline]</code></td>
  85. </tr>
  86. </table>
  87. </div>
  88. <div class="memdoc">
  89. <p>
  90. Try acquiring lock (non-blocking).
  91. <p>
  92. Return true if lock acquired; false otherwise.
  93. </div>
  94. </div><p>
  95. <hr>The documentation for this class was generated from the following file:<ul>
  96. <li>recursive_mutex.h</ul>
  97. <hr>
  98. <p></p>
  99. Copyright &copy; 2005-2013 Intel Corporation. All Rights Reserved.
  100. <p></p>
  101. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  102. registered trademarks or trademarks of Intel Corporation or its
  103. subsidiaries in the United States and other countries.
  104. <p></p>
  105. * Other names and brands may be claimed as the property of others.