TorqueEngine
/
Torque2D
의 미러 https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: MutexHandle 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_mutex_handle-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">MutexHandle Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;mutex.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a59c3d53e04a3299d1a928c4c3eb11ab0" id="r_a59c3d53e04a3299d1a928c4c3eb11ab0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex_handle.html#a59c3d53e04a3299d1a928c4c3eb11ab0">MutexHandle</a> ()</td></tr>
<tr class="separator:a59c3d53e04a3299d1a928c4c3eb11ab0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85d007b48a9ad9fd6c30ac55c76d5e35" id="r_a85d007b48a9ad9fd6c30ac55c76d5e35"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex_handle.html#a85d007b48a9ad9fd6c30ac55c76d5e35">~MutexHandle</a> ()</td></tr>
<tr class="separator:a85d007b48a9ad9fd6c30ac55c76d5e35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1f3013f628e50aa2244bd34876f95f1" id="r_ad1f3013f628e50aa2244bd34876f95f1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex_handle.html#ad1f3013f628e50aa2244bd34876f95f1">lock</a> (void *mutex, bool blocking=false)</td></tr>
<tr class="separator:ad1f3013f628e50aa2244bd34876f95f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9278be8203e1c42e2619179882ae4403" id="r_a9278be8203e1c42e2619179882ae4403"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex_handle.html#a9278be8203e1c42e2619179882ae4403">unlock</a> ()</td></tr>
<tr class="separator:a9278be8203e1c42e2619179882ae4403"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Helper for simplifying mutex locking code.</p>
<p>This class will automatically unlock a mutex that you've locked through it, saving you from managing a lot of complex exit cases. For instance:</p>
<div class="fragment"><div class="line"><a class="code hl_class" href="class_mutex_handle.html">MutexHandle</a> handle;</div>
<div class="line">handle.<a class="code hl_function" href="class_mutex_handle.html#ad1f3013f628e50aa2244bd34876f95f1">lock</a>(myMutex);</div>
<div class="line"> </div>
<div class="line"><span class="keywordflow">if</span>(error1)</div>
<div class="line">  <span class="keywordflow">return</span>; <span class="comment">// Auto-unlocked by handle if we leave here - normally would</span></div>
<div class="line">          <span class="comment">// leave the mutex locked, causing much pain later.</span></div>
<div class="line"> </div>
<div class="line">handle.<a class="code hl_function" href="class_mutex_handle.html#a9278be8203e1c42e2619179882ae4403">unlock</a>();</div>
<div class="ttc" id="aclass_mutex_handle_html"><div class="ttname"><a href="class_mutex_handle.html">MutexHandle</a></div><div class="ttdef"><b>Definition</b> mutex.h:87</div></div>
<div class="ttc" id="aclass_mutex_handle_html_a9278be8203e1c42e2619179882ae4403"><div class="ttname"><a href="class_mutex_handle.html#a9278be8203e1c42e2619179882ae4403">MutexHandle::unlock</a></div><div class="ttdeci">void unlock()</div><div class="ttdef"><b>Definition</b> mutex.h:118</div></div>
<div class="ttc" id="aclass_mutex_handle_html_ad1f3013f628e50aa2244bd34876f95f1"><div class="ttname"><a href="class_mutex_handle.html#ad1f3013f628e50aa2244bd34876f95f1">MutexHandle::lock</a></div><div class="ttdeci">bool lock(void *mutex, bool blocking=false)</div><div class="ttdef"><b>Definition</b> mutex.h:103</div></div>
</div><!-- fragment --> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a59c3d53e04a3299d1a928c4c3eb11ab0" name="a59c3d53e04a3299d1a928c4c3eb11ab0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59c3d53e04a3299d1a928c4c3eb11ab0">&#9670;&#160;</a></span>MutexHandle()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_mutex_handle.html">MutexHandle</a> </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">

</div>
</div>
<a id="a85d007b48a9ad9fd6c30ac55c76d5e35" name="a85d007b48a9ad9fd6c30ac55c76d5e35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85d007b48a9ad9fd6c30ac55c76d5e35">&#9670;&#160;</a></span>~MutexHandle()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="class_mutex_handle.html">MutexHandle</a> </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">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad1f3013f628e50aa2244bd34876f95f1" name="ad1f3013f628e50aa2244bd34876f95f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1f3013f628e50aa2244bd34876f95f1">&#9670;&#160;</a></span>lock()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool lock </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>mutex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>blocking</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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">

</div>
</div>
<a id="a9278be8203e1c42e2619179882ae4403" name="a9278be8203e1c42e2619179882ae4403"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9278be8203e1c42e2619179882ae4403">&#9670;&#160;</a></span>unlock()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void unlock </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">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>platform/threads/<b>mutex.h</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>