133 lines
8.2 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::spin_rw_mutex_v3 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="a00345.html">spin_rw_mutex_v3</a></div>
  25. <h1>tbb::spin_rw_mutex_v3 Class Reference<br>
  26. <small>
  27. [<a class="el" href="a00444.html">Synchronization</a>]</small>
  28. </h1><!-- doxytag: class="tbb::spin_rw_mutex_v3" -->Fast, unfair, spinning reader-writer lock with backoff and writer-preference.
  29. <a href="#_details">More...</a>
  30. <p>
  31. <code>#include &lt;spin_rw_mutex.h&gt;</code>
  32. <p>
  33. <a href="a00129.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 Member Functions</h2></td></tr>
  36. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="61332b2756de89f3f5f69310cbb6e70c"></a><!-- doxytag: member="tbb::spin_rw_mutex_v3::spin_rw_mutex_v3" ref="61332b2756de89f3f5f69310cbb6e70c" args="()" -->
  37. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00345.html#61332b2756de89f3f5f69310cbb6e70c">spin_rw_mutex_v3</a> ()</td></tr>
  38. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct unacquired mutex. <br></td></tr>
  39. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a815fb2759e55072ed413f1b6970cf3"></a><!-- doxytag: member="tbb::spin_rw_mutex_v3::~spin_rw_mutex_v3" ref="9a815fb2759e55072ed413f1b6970cf3" args="()" -->
  40. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00345.html#9a815fb2759e55072ed413f1b6970cf3">~spin_rw_mutex_v3</a> ()</td></tr>
  41. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor asserts if the mutex is acquired, i.e. state is zero. <br></td></tr>
  42. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4007d6e1523dbc3c2bb7f889ab789a8a"></a><!-- doxytag: member="tbb::spin_rw_mutex_v3::lock" ref="4007d6e1523dbc3c2bb7f889ab789a8a" args="()" -->
  43. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00345.html#4007d6e1523dbc3c2bb7f889ab789a8a">lock</a> ()</td></tr>
  44. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Acquire writer lock. <br></td></tr>
  45. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00345.html#088bb256be794cc47d3b83791632fdfc">try_lock</a> ()</td></tr>
  46. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Try acquiring writer lock (non-blocking). <a href="#088bb256be794cc47d3b83791632fdfc"></a><br></td></tr>
  47. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f9f52ead2098eb5fb12da59d5ae53b55"></a><!-- doxytag: member="tbb::spin_rw_mutex_v3::unlock" ref="f9f52ead2098eb5fb12da59d5ae53b55" args="()" -->
  48. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00345.html#f9f52ead2098eb5fb12da59d5ae53b55">unlock</a> ()</td></tr>
  49. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release lock. <br></td></tr>
  50. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="13f799708ac4ca437a16be202e263e18"></a><!-- doxytag: member="tbb::spin_rw_mutex_v3::lock_read" ref="13f799708ac4ca437a16be202e263e18" args="()" -->
  51. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00345.html#13f799708ac4ca437a16be202e263e18">lock_read</a> ()</td></tr>
  52. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Acquire reader lock. <br></td></tr>
  53. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00345.html#b8667415869013f840d976aa406d385a">try_lock_read</a> ()</td></tr>
  54. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Try acquiring reader lock (non-blocking). <a href="#b8667415869013f840d976aa406d385a"></a><br></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="4c1e60f22c01604ca93c41b8334cc15e"></a><!-- doxytag: member="tbb::spin_rw_mutex_v3::is_rw_mutex" ref="4c1e60f22c01604ca93c41b8334cc15e" args="" -->
  57. static const bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>is_rw_mutex</b> = true</td></tr>
  58. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="681a816fe76d6ca7752303f9dcc3c4b2"></a><!-- doxytag: member="tbb::spin_rw_mutex_v3::is_recursive_mutex" ref="681a816fe76d6ca7752303f9dcc3c4b2" args="" -->
  59. static const bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>is_recursive_mutex</b> = false</td></tr>
  60. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4dd66d90df6247da6050e88b2aa3b820"></a><!-- doxytag: member="tbb::spin_rw_mutex_v3::is_fair_mutex" ref="4dd66d90df6247da6050e88b2aa3b820" 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>Classes</h2></td></tr>
  63. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00346.html">scoped_lock</a></td></tr>
  64. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The scoped locking pattern. <a href="a00346.html#_details">More...</a><br></td></tr>
  65. </table>
  66. <hr><a name="_details"></a><h2>Detailed Description</h2>
  67. Fast, unfair, spinning reader-writer lock with backoff and writer-preference.
  68. <p>
  69. <hr><h2>Member Function Documentation</h2>
  70. <a class="anchor" name="088bb256be794cc47d3b83791632fdfc"></a><!-- doxytag: member="tbb::spin_rw_mutex_v3::try_lock" ref="088bb256be794cc47d3b83791632fdfc" args="()" -->
  71. <div class="memitem">
  72. <div class="memproto">
  73. <table class="memname">
  74. <tr>
  75. <td class="memname">bool tbb::spin_rw_mutex_v3::try_lock </td>
  76. <td>(</td>
  77. <td class="paramname"> </td>
  78. <td>&nbsp;)&nbsp;</td>
  79. <td width="100%"><code> [inline]</code></td>
  80. </tr>
  81. </table>
  82. </div>
  83. <div class="memdoc">
  84. <p>
  85. Try acquiring writer lock (non-blocking).
  86. <p>
  87. Return true if lock acquired; false otherwise.
  88. </div>
  89. </div><p>
  90. <a class="anchor" name="b8667415869013f840d976aa406d385a"></a><!-- doxytag: member="tbb::spin_rw_mutex_v3::try_lock_read" ref="b8667415869013f840d976aa406d385a" args="()" -->
  91. <div class="memitem">
  92. <div class="memproto">
  93. <table class="memname">
  94. <tr>
  95. <td class="memname">bool tbb::spin_rw_mutex_v3::try_lock_read </td>
  96. <td>(</td>
  97. <td class="paramname"> </td>
  98. <td>&nbsp;)&nbsp;</td>
  99. <td width="100%"><code> [inline]</code></td>
  100. </tr>
  101. </table>
  102. </div>
  103. <div class="memdoc">
  104. <p>
  105. Try acquiring reader lock (non-blocking).
  106. <p>
  107. Return true if reader lock acquired; false otherwise.
  108. </div>
  109. </div><p>
  110. <hr>The documentation for this class was generated from the following file:<ul>
  111. <li>spin_rw_mutex.h</ul>
  112. <hr>
  113. <p></p>
  114. Copyright &copy; 2005-2013 Intel Corporation. All Rights Reserved.
  115. <p></p>
  116. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  117. registered trademarks or trademarks of Intel Corporation or its
  118. subsidiaries in the United States and other countries.
  119. <p></p>
  120. * Other names and brands may be claimed as the property of others.