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.

97 lines
6.3 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::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="a00343.html">spin_mutex</a>::<a class="el" href="a00344.html">scoped_lock</a></div>
  25. <h1>tbb::spin_mutex::scoped_lock Class Reference</h1><!-- doxytag: class="tbb::spin_mutex::scoped_lock" -->Represents acquisition of a mutex.
  26. <a href="#_details">More...</a>
  27. <p>
  28. <code>#include &lt;spin_mutex.h&gt;</code>
  29. <p>
  30. <a href="a00128.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="29ae680ae7f5e685c2e15535b9c855b3"></a><!-- doxytag: member="tbb::spin_mutex::scoped_lock::scoped_lock" ref="29ae680ae7f5e685c2e15535b9c855b3" args="()" -->
  34. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00344.html#29ae680ae7f5e685c2e15535b9c855b3">scoped_lock</a> ()</td></tr>
  35. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct without acquiring a mutex. <br></td></tr>
  36. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5ce6807050a9e8f87bcb4a65dccb12ef"></a><!-- doxytag: member="tbb::spin_mutex::scoped_lock::scoped_lock" ref="5ce6807050a9e8f87bcb4a65dccb12ef" args="(spin_mutex &amp;m)" -->
  37. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00344.html#5ce6807050a9e8f87bcb4a65dccb12ef">scoped_lock</a> (<a class="el" href="a00343.html">spin_mutex</a> &amp;m)</td></tr>
  38. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct and acquire lock on a mutex. <br></td></tr>
  39. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ee3c338732b1f64b0b32a757807a30d"></a><!-- doxytag: member="tbb::spin_mutex::scoped_lock::acquire" ref="3ee3c338732b1f64b0b32a757807a30d" args="(spin_mutex &amp;m)" -->
  40. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00344.html#3ee3c338732b1f64b0b32a757807a30d">acquire</a> (<a class="el" href="a00343.html">spin_mutex</a> &amp;m)</td></tr>
  41. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Acquire lock. <br></td></tr>
  42. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00344.html#9297ec188534b45dc0ca48f2f39a0501">try_acquire</a> (<a class="el" href="a00343.html">spin_mutex</a> &amp;m)</td></tr>
  43. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Try acquiring lock (non-blocking). <a href="#9297ec188534b45dc0ca48f2f39a0501"></a><br></td></tr>
  44. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eeb615e68e963e6bf8d9c11402d0ce8e"></a><!-- doxytag: member="tbb::spin_mutex::scoped_lock::release" ref="eeb615e68e963e6bf8d9c11402d0ce8e" args="()" -->
  45. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00344.html#eeb615e68e963e6bf8d9c11402d0ce8e">release</a> ()</td></tr>
  46. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release lock. <br></td></tr>
  47. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ac6fa425d1f06c56d8b70abc51aac844"></a><!-- doxytag: member="tbb::spin_mutex::scoped_lock::~scoped_lock" ref="ac6fa425d1f06c56d8b70abc51aac844" args="()" -->
  48. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00344.html#ac6fa425d1f06c56d8b70abc51aac844">~scoped_lock</a> ()</td></tr>
  49. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy lock. If holding a lock, releases the lock first. <br></td></tr>
  50. <tr><td colspan="2"><br><h2>Friends</h2></td></tr>
  51. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6ee2a2cdaf6a2128849e7d7723d9174f"></a><!-- doxytag: member="tbb::spin_mutex::scoped_lock::spin_mutex" ref="6ee2a2cdaf6a2128849e7d7723d9174f" args="" -->
  52. class&nbsp;</td><td class="memItemRight" valign="bottom"><b>spin_mutex</b></td></tr>
  53. </table>
  54. <hr><a name="_details"></a><h2>Detailed Description</h2>
  55. Represents acquisition of a mutex.
  56. <p>
  57. <hr><h2>Member Function Documentation</h2>
  58. <a class="anchor" name="9297ec188534b45dc0ca48f2f39a0501"></a><!-- doxytag: member="tbb::spin_mutex::scoped_lock::try_acquire" ref="9297ec188534b45dc0ca48f2f39a0501" args="(spin_mutex &amp;m)" -->
  59. <div class="memitem">
  60. <div class="memproto">
  61. <table class="memname">
  62. <tr>
  63. <td class="memname">bool tbb::spin_mutex::scoped_lock::try_acquire </td>
  64. <td>(</td>
  65. <td class="paramtype"><a class="el" href="a00343.html">spin_mutex</a> &amp;&nbsp;</td>
  66. <td class="paramname"> <em>m</em> </td>
  67. <td>&nbsp;)&nbsp;</td>
  68. <td width="100%"><code> [inline]</code></td>
  69. </tr>
  70. </table>
  71. </div>
  72. <div class="memdoc">
  73. <p>
  74. Try acquiring lock (non-blocking).
  75. <p>
  76. Return true if lock acquired; false otherwise.
  77. </div>
  78. </div><p>
  79. <hr>The documentation for this class was generated from the following file:<ul>
  80. <li>spin_mutex.h</ul>
  81. <hr>
  82. <p></p>
  83. Copyright &copy; 2005-2013 Intel Corporation. All Rights Reserved.
  84. <p></p>
  85. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  86. registered trademarks or trademarks of Intel Corporation or its
  87. subsidiaries in the United States and other countries.
  88. <p></p>
  89. * Other names and brands may be claimed as the property of others.