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.

131 lines
7.5 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_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="a00343.html">spin_mutex</a></div>
  25. <h1>tbb::spin_mutex Class Reference<br>
  26. <small>
  27. [<a class="el" href="a00444.html">Synchronization</a>]</small>
  28. </h1><!-- doxytag: class="tbb::spin_mutex" -->A lock that occupies a single byte.
  29. <a href="#_details">More...</a>
  30. <p>
  31. <code>#include &lt;spin_mutex.h&gt;</code>
  32. <p>
  33. <a href="a00127.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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00343.html#3d8fb44644fd8d41ada1fbeba7409be3">spin_mutex</a> ()</td></tr>
  37. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct unacquired lock. <a href="#3d8fb44644fd8d41ada1fbeba7409be3"></a><br></td></tr>
  38. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b3fa21632815f8fab2fd6c67ec0d48c"></a><!-- doxytag: member="tbb::spin_mutex::internal_construct" ref="4b3fa21632815f8fab2fd6c67ec0d48c" args="()" -->
  39. void __TBB_EXPORTED_METHOD&nbsp;</td><td class="memItemRight" valign="bottom"><b>internal_construct</b> ()</td></tr>
  40. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f748989e19b6045e3a2d2ee73626a28"></a><!-- doxytag: member="tbb::spin_mutex::lock" ref="4f748989e19b6045e3a2d2ee73626a28" args="()" -->
  41. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00343.html#4f748989e19b6045e3a2d2ee73626a28">lock</a> ()</td></tr>
  42. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Acquire lock. <br></td></tr>
  43. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00343.html#8f9a58fb56a2b4c5efe1a7f7c1ae2074">try_lock</a> ()</td></tr>
  44. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Try acquiring lock (non-blocking). <a href="#8f9a58fb56a2b4c5efe1a7f7c1ae2074"></a><br></td></tr>
  45. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0e843ee6265f57f27d228ba91e7308ef"></a><!-- doxytag: member="tbb::spin_mutex::unlock" ref="0e843ee6265f57f27d228ba91e7308ef" args="()" -->
  46. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00343.html#0e843ee6265f57f27d228ba91e7308ef">unlock</a> ()</td></tr>
  47. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release lock. <br></td></tr>
  48. <tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
  49. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a7c93ca9e7ab656037a43984f24c051"></a><!-- doxytag: member="tbb::spin_mutex::is_rw_mutex" ref="5a7c93ca9e7ab656037a43984f24c051" args="" -->
  50. static const bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>is_rw_mutex</b> = false</td></tr>
  51. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a967c455d0d80c9bbe030905201391b6"></a><!-- doxytag: member="tbb::spin_mutex::is_recursive_mutex" ref="a967c455d0d80c9bbe030905201391b6" args="" -->
  52. static const bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>is_recursive_mutex</b> = false</td></tr>
  53. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ec12e4036073fb684b6d2d33493ed0aa"></a><!-- doxytag: member="tbb::spin_mutex::is_fair_mutex" ref="ec12e4036073fb684b6d2d33493ed0aa" args="" -->
  54. static const bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>is_fair_mutex</b> = false</td></tr>
  55. <tr><td colspan="2"><br><h2>Friends</h2></td></tr>
  56. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a36f15b770a1bb0b56e33d7fa75ebd1a"></a><!-- doxytag: member="tbb::spin_mutex::scoped_lock" ref="a36f15b770a1bb0b56e33d7fa75ebd1a" args="" -->
  57. class&nbsp;</td><td class="memItemRight" valign="bottom"><b>scoped_lock</b></td></tr>
  58. <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
  59. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00344.html">scoped_lock</a></td></tr>
  60. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents acquisition of a mutex. <a href="a00344.html#_details">More...</a><br></td></tr>
  61. </table>
  62. <hr><a name="_details"></a><h2>Detailed Description</h2>
  63. A lock that occupies a single byte.
  64. <p>
  65. A <a class="el" href="a00343.html">spin_mutex</a> is a spin mutex that fits in a single byte. It should be used only for locking short critical sections (typically less than 20 instructions) when fairness is not an issue. If zero-initialized, the mutex is considered unheld.
  66. <p>
  67. <hr><h2>Constructor &amp; Destructor Documentation</h2>
  68. <a class="anchor" name="3d8fb44644fd8d41ada1fbeba7409be3"></a><!-- doxytag: member="tbb::spin_mutex::spin_mutex" ref="3d8fb44644fd8d41ada1fbeba7409be3" args="()" -->
  69. <div class="memitem">
  70. <div class="memproto">
  71. <table class="memname">
  72. <tr>
  73. <td class="memname">tbb::spin_mutex::spin_mutex </td>
  74. <td>(</td>
  75. <td class="paramname"> </td>
  76. <td>&nbsp;)&nbsp;</td>
  77. <td width="100%"><code> [inline]</code></td>
  78. </tr>
  79. </table>
  80. </div>
  81. <div class="memdoc">
  82. <p>
  83. Construct unacquired lock.
  84. <p>
  85. Equivalent to zero-initialization of *this.
  86. </div>
  87. </div><p>
  88. <hr><h2>Member Function Documentation</h2>
  89. <a class="anchor" name="8f9a58fb56a2b4c5efe1a7f7c1ae2074"></a><!-- doxytag: member="tbb::spin_mutex::try_lock" ref="8f9a58fb56a2b4c5efe1a7f7c1ae2074" args="()" -->
  90. <div class="memitem">
  91. <div class="memproto">
  92. <table class="memname">
  93. <tr>
  94. <td class="memname">bool tbb::spin_mutex::try_lock </td>
  95. <td>(</td>
  96. <td class="paramname"> </td>
  97. <td>&nbsp;)&nbsp;</td>
  98. <td width="100%"><code> [inline]</code></td>
  99. </tr>
  100. </table>
  101. </div>
  102. <div class="memdoc">
  103. <p>
  104. Try acquiring lock (non-blocking).
  105. <p>
  106. Return true if lock acquired; false otherwise.
  107. </div>
  108. </div><p>
  109. <hr>The documentation for this class was generated from the following file:<ul>
  110. <li>spin_mutex.h</ul>
  111. <hr>
  112. <p></p>
  113. Copyright &copy; 2005-2013 Intel Corporation. All Rights Reserved.
  114. <p></p>
  115. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  116. registered trademarks or trademarks of Intel Corporation or its
  117. subsidiaries in the United States and other countries.
  118. <p></p>
  119. * Other names and brands may be claimed as the property of others.