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.
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/><meta http-equiv="X-UA-Compatible" content="IE=9"/><meta name="generator" content="Doxygen 1.8.4"/><title>tbb::queuing_mutex::scoped_lock Class Reference</title><link href="tabs.css" rel="stylesheet" type="text/css"/><script type="text/javascript" src="jquery.js"></script><script type="text/javascript" src="dynsections.js"></script><link href="doxygen.css" rel="stylesheet" type="text/css" /></head><body><div id="top"><!-- do not remove this div, it is closed by doxygen! --><!-- end header part --><!-- Generated by Doxygen 1.8.4 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div><div id="nav-path" class="navpath"> <ul><li class="navelem"><a class="el" href="a00222.html">tbb</a></li><li class="navelem"><a class="el" href="a00093.html">queuing_mutex</a></li><li class="navelem"><a class="el" href="a00121.html">scoped_lock</a></li> </ul></div></div><!-- top --><div class="header"> <div class="summary"><a href="#pub-methods">Public Member Functions</a> |<a href="a00272.html">List of all members</a> </div> <div class="headertitle"><div class="title">tbb::queuing_mutex::scoped_lock Class Reference</div> </div></div><!--header--><div class="contents">
<p>The scoped locking pattern. <a href="a00121.html#details">More...</a></p>
<p><code>#include <queuing_mutex.h></code></p><div class="dynheader">Inheritance diagram for tbb::queuing_mutex::scoped_lock:</div><div class="dyncontent"> <div class="center"> <img src="a00121.png" usemap="#tbb::queuing_mutex::scoped_lock_map" alt=""/> <map id="tbb::queuing_mutex::scoped_lock_map" name="tbb::queuing_mutex::scoped_lock_map"></map> </div></div><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>Public Member Functions</h2></td></tr><tr class="memitem:a0afe0107eb0aae613e726f67624d2fca"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00121.html#a0afe0107eb0aae613e726f67624d2fca">scoped_lock</a> ()</td></tr><tr class="memdesc:a0afe0107eb0aae613e726f67624d2fca"><td class="mdescLeft"> </td><td class="mdescRight">Construct lock that has not acquired a mutex. <a href="#a0afe0107eb0aae613e726f67624d2fca">More...</a><br/></td></tr><tr class="separator:a0afe0107eb0aae613e726f67624d2fca"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:aa82d9da0dcfe5b21f1c08473f8223105"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa82d9da0dcfe5b21f1c08473f8223105"></a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00121.html#aa82d9da0dcfe5b21f1c08473f8223105">scoped_lock</a> (<a class="el" href="a00093.html">queuing_mutex</a> &m)</td></tr><tr class="memdesc:aa82d9da0dcfe5b21f1c08473f8223105"><td class="mdescLeft"> </td><td class="mdescRight">Acquire lock on given mutex. <br/></td></tr><tr class="separator:aa82d9da0dcfe5b21f1c08473f8223105"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a469ec43836a8dd250ce0a22b02945630"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a469ec43836a8dd250ce0a22b02945630"></a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00121.html#a469ec43836a8dd250ce0a22b02945630">~scoped_lock</a> ()</td></tr><tr class="memdesc:a469ec43836a8dd250ce0a22b02945630"><td class="mdescLeft"> </td><td class="mdescRight">Release lock (if lock is held). <br/></td></tr><tr class="separator:a469ec43836a8dd250ce0a22b02945630"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:abf8aa7ccd48d54dcb53665700a17d02a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf8aa7ccd48d54dcb53665700a17d02a"></a>void __TBB_EXPORTED_METHOD </td><td class="memItemRight" valign="bottom"><a class="el" href="a00121.html#abf8aa7ccd48d54dcb53665700a17d02a">acquire</a> (<a class="el" href="a00093.html">queuing_mutex</a> &m)</td></tr><tr class="memdesc:abf8aa7ccd48d54dcb53665700a17d02a"><td class="mdescLeft"> </td><td class="mdescRight">Acquire lock on given mutex. <br/></td></tr><tr class="separator:abf8aa7ccd48d54dcb53665700a17d02a"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:ab4800ba9e743cd91f152036a6689b0e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4800ba9e743cd91f152036a6689b0e9"></a>bool __TBB_EXPORTED_METHOD </td><td class="memItemRight" valign="bottom"><a class="el" href="a00121.html#ab4800ba9e743cd91f152036a6689b0e9">try_acquire</a> (<a class="el" href="a00093.html">queuing_mutex</a> &m)</td></tr><tr class="memdesc:ab4800ba9e743cd91f152036a6689b0e9"><td class="mdescLeft"> </td><td class="mdescRight">Acquire lock on given mutex if free (i.e. non-blocking) <br/></td></tr><tr class="separator:ab4800ba9e743cd91f152036a6689b0e9"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:aaa065e48b428b8d43e9bb931ba9e6f6c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa065e48b428b8d43e9bb931ba9e6f6c"></a>void __TBB_EXPORTED_METHOD </td><td class="memItemRight" valign="bottom"><a class="el" href="a00121.html#aaa065e48b428b8d43e9bb931ba9e6f6c">release</a> ()</td></tr><tr class="memdesc:aaa065e48b428b8d43e9bb931ba9e6f6c"><td class="mdescLeft"> </td><td class="mdescRight">Release lock. <br/></td></tr><tr class="separator:aaa065e48b428b8d43e9bb931ba9e6f6c"><td class="memSeparator" colspan="2"> </td></tr></table><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2><div class="textblock"><p>The scoped locking pattern. </p><p>It helps to avoid the common problem of forgetting to release lock. It also nicely provides the "node" for queuing locks. </p></div><h2 class="groupheader">Constructor & Destructor Documentation</h2><a class="anchor" id="a0afe0107eb0aae613e726f67624d2fca"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">tbb::queuing_mutex::scoped_lock::scoped_lock </td> <td>(</td> <td class="paramname">)</td><td></td> <td></td> </tr> </table> </td> <td class="mlabels-right"><span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr></table></div><div class="memdoc">
<p>Construct lock that has not acquired a mutex. </p><p>Equivalent to zero-initialization of *this. </p>
</div></div><hr/>The documentation for this class was generated from the following file:<ul><li>queuing_mutex.h</li></ul></div><!-- contents --><hr><p></p>Copyright © 2005-2014 Intel Corporation. All Rights Reserved.<p></p>Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune areregistered trademarks or trademarks of Intel Corporation or itssubsidiaries in the United States and other countries.<p></p>* Other names and brands may be claimed as the property of others.
|
