TorqueEngine
/
Torque2D
Mirror von https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
							<!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: Semaphore 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="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_semaphore-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Semaphore Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;semaphore.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:a2c7860c271e59ac06e92266e73de7723" id="r_a2c7860c271e59ac06e92266e73de7723"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_semaphore.html#a2c7860c271e59ac06e92266e73de7723">Semaphore</a> (S32 initialCount=1)</td></tr>
<tr class="memdesc:a2c7860c271e59ac06e92266e73de7723"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a semaphore. initialCount defaults to 1.  <br /></td></tr>
<tr class="separator:a2c7860c271e59ac06e92266e73de7723"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e0394d4ca6109ccb52b3c1e5cf6c9b5" id="r_a5e0394d4ca6109ccb52b3c1e5cf6c9b5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_semaphore.html#a5e0394d4ca6109ccb52b3c1e5cf6c9b5">~Semaphore</a> ()</td></tr>
<tr class="memdesc:a5e0394d4ca6109ccb52b3c1e5cf6c9b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a semaphore, ignoring it's count.  <br /></td></tr>
<tr class="separator:a5e0394d4ca6109ccb52b3c1e5cf6c9b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af111dad5fcf43df4130392480ae1f019" id="r_af111dad5fcf43df4130392480ae1f019"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_semaphore.html#af111dad5fcf43df4130392480ae1f019">acquire</a> (bool block=true, S32 timeoutMS=-1)</td></tr>
<tr class="separator:af111dad5fcf43df4130392480ae1f019"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23b477d0e2d399f75d585d154c346591" id="r_a23b477d0e2d399f75d585d154c346591"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_semaphore.html#a23b477d0e2d399f75d585d154c346591">release</a> ()</td></tr>
<tr class="separator:a23b477d0e2d399f75d585d154c346591"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a7a20254adb02a7b006dc64556ad23194" id="r_a7a20254adb02a7b006dc64556ad23194"><td class="memItemLeft" align="right" valign="top">static void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_semaphore.html#a7a20254adb02a7b006dc64556ad23194">createSemaphore</a> (U32 initialCount=1)</td></tr>
<tr class="separator:a7a20254adb02a7b006dc64556ad23194"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7bcf2c87c474f3d9b51e57d853a3ed1" id="r_ab7bcf2c87c474f3d9b51e57d853a3ed1"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_semaphore.html#ab7bcf2c87c474f3d9b51e57d853a3ed1">destroySemaphore</a> (void *semaphore)</td></tr>
<tr class="separator:ab7bcf2c87c474f3d9b51e57d853a3ed1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7ccee8819b0b669c103916140ebd5b1" id="r_ad7ccee8819b0b669c103916140ebd5b1"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_semaphore.html#ad7ccee8819b0b669c103916140ebd5b1">acquireSemaphore</a> (void *semaphore, bool block=true)</td></tr>
<tr class="separator:ad7ccee8819b0b669c103916140ebd5b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23ae790a1b84fb624f04fd2ad97618fb" id="r_a23ae790a1b84fb624f04fd2ad97618fb"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_semaphore.html#a23ae790a1b84fb624f04fd2ad97618fb">releaseSemaphore</a> (void *semaphore)</td></tr>
<tr class="separator:a23ae790a1b84fb624f04fd2ad97618fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ab336c1d69355cd5546fe5db425fac01b" id="r_ab336c1d69355cd5546fe5db425fac01b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_platform_semaphore.html">PlatformSemaphore</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_semaphore.html#ab336c1d69355cd5546fe5db425fac01b">mData</a></td></tr>
<tr class="separator:ab336c1d69355cd5546fe5db425fac01b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2c7860c271e59ac06e92266e73de7723" name="a2c7860c271e59ac06e92266e73de7723"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c7860c271e59ac06e92266e73de7723">&#9670;&#160;</a></span>Semaphore()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_semaphore.html">Semaphore</a> </td>
          <td>(</td>
          <td class="paramtype">S32&#160;</td>
          <td class="paramname"><em>initialCount</em> = <code>1</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a semaphore. initialCount defaults to 1. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="class_semaphore.html">Semaphore</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Delete a semaphore, ignoring it's count. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool acquire </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>block</em> = <code>true</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">S32&#160;</td>
          <td class="paramname"><em>timeoutMS</em> = <code>-1</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Acquire the semaphore, decrementing its count. if the initial count is less than 1, block until it goes above 1, then acquire. Returns true if the semaphore was acquired, false if the semaphore could not be acquired and block was false. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool acquireSemaphore </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>semaphore</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>block</em> = <code>true</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 class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void * createSemaphore </td>
          <td>(</td>
          <td class="paramtype">U32&#160;</td>
          <td class="paramname"><em>initialCount</em> = <code>1</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void destroySemaphore </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>semaphore</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void release </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Release the semaphore, incrementing its count. Never blocks. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void releaseSemaphore </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>semaphore</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ab336c1d69355cd5546fe5db425fac01b" name="ab336c1d69355cd5546fe5db425fac01b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab336c1d69355cd5546fe5db425fac01b">&#9670;&#160;</a></span>mData</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="struct_platform_semaphore.html">PlatformSemaphore</a>* mData</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>platform/threads/<b>semaphore.h</b></li>
<li>platformAndroid/<b>AndroidSemaphore.cpp</b></li>
<li>platformEmscripten/<b>EmscriptenSemaphore.cpp</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>