git-svn-id: svn://db.shs.com.ru/pip@313 12ceb7fc-bf1f-11e4-8940-5bc7170c53b5
This commit is contained in:
@@ -3,7 +3,8 @@
|
||||
<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.9.1"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>PIP: PIMutex Class Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
@@ -14,7 +15,6 @@
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
@@ -24,9 +24,9 @@
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td style="padding-left: 0.5em;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">PIP
|
||||
 <span id="projectnumber">0.5.0_alpha</span>
|
||||
 <span id="projectnumber">0.7.1</span>
|
||||
</div>
|
||||
<div id="projectbrief">Platform-Independent Primitives</div>
|
||||
</td>
|
||||
@@ -35,24 +35,15 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.9.1 -->
|
||||
<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="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="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',false,false,'search.php','Search');
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
@@ -82,7 +73,7 @@ $(document).ready(function(){initNavTree('class_p_i_mutex.html','');});
|
||||
<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:ac4d6be4bdac6af45f1db56c4d1a0d971"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac4d6be4bdac6af45f1db56c4d1a0d971"></a>
|
||||
<tr class="memitem:ac4d6be4bdac6af45f1db56c4d1a0d971"><td class="memItemLeft" align="right" valign="top"><a id="ac4d6be4bdac6af45f1db56c4d1a0d971"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_mutex.html#ac4d6be4bdac6af45f1db56c4d1a0d971">PIMutex</a> ()</td></tr>
|
||||
<tr class="memdesc:ac4d6be4bdac6af45f1db56c4d1a0d971"><td class="mdescLeft"> </td><td class="mdescRight">Constructs unlocked mutex. <br /></td></tr>
|
||||
<tr class="separator:ac4d6be4bdac6af45f1db56c4d1a0d971"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
@@ -95,10 +86,10 @@ Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a5c4ed063c5c7d7ee94ff3402d320851a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_mutex.html#a5c4ed063c5c7d7ee94ff3402d320851a">tryLock</a> ()</td></tr>
|
||||
<tr class="memdesc:a5c4ed063c5c7d7ee94ff3402d320851a"><td class="mdescLeft"> </td><td class="mdescRight">Try to lock mutex. <a href="#a5c4ed063c5c7d7ee94ff3402d320851a">More...</a><br /></td></tr>
|
||||
<tr class="separator:a5c4ed063c5c7d7ee94ff3402d320851a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a06d53d3f21cc8b89e0a240493bdaef77"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06d53d3f21cc8b89e0a240493bdaef77"></a>
|
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_mutex.html#a06d53d3f21cc8b89e0a240493bdaef77">isLocked</a> () const </td></tr>
|
||||
<tr class="memdesc:a06d53d3f21cc8b89e0a240493bdaef77"><td class="mdescLeft"> </td><td class="mdescRight">Returns if mutex is locked. <br /></td></tr>
|
||||
<tr class="separator:a06d53d3f21cc8b89e0a240493bdaef77"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a753da7bdbbeff323d5bfa01b411cfd8d"><td class="memItemLeft" align="right" valign="top"><a id="a753da7bdbbeff323d5bfa01b411cfd8d"></a>
|
||||
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_mutex.html#a753da7bdbbeff323d5bfa01b411cfd8d">isLocked</a> () const</td></tr>
|
||||
<tr class="memdesc:a753da7bdbbeff323d5bfa01b411cfd8d"><td class="mdescLeft"> </td><td class="mdescRight">Returns if mutex is locked. <br /></td></tr>
|
||||
<tr class="separator:a753da7bdbbeff323d5bfa01b411cfd8d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Mutex. </p>
|
||||
@@ -107,12 +98,11 @@ Synopsis</h1>
|
||||
<p>PIMutex provides synchronization blocks between several threads. Using mutex guarantees execution of some code only one of threads. Mutex contains logic state and functions to change it: <em><a class="el" href="class_p_i_mutex.html#aa571ad61ee7bd5fcf60f6f5032a16441" title="Lock mutex. ">lock()</a></em>, <em><a class="el" href="class_p_i_mutex.html#aae483d17150e38436ca25a1bd26b04c2" title="Unlock mutex. ">unlock()</a></em> and <em><a class="el" href="class_p_i_mutex.html#a5c4ed063c5c7d7ee94ff3402d320851a" title="Try to lock mutex. ">tryLock()</a></em>.</p>
|
||||
<h1><a class="anchor" id="PIMutex_sec1"></a>
|
||||
Usage</h1>
|
||||
<p>Block of code that should to be executed only one thread simultaniously should to be started with <em><a class="el" href="class_p_i_mutex.html#aa571ad61ee7bd5fcf60f6f5032a16441" title="Lock mutex. ">lock()</a></em> and ended with <em><a class="el" href="class_p_i_mutex.html#aae483d17150e38436ca25a1bd26b04c2" title="Unlock mutex. ">unlock()</a></em>. </p><div class="fragment"><div class="line">mutex.lock();</div>
|
||||
<div class="line"><span class="comment">// ... your code here</span></div>
|
||||
<div class="line">mutex.unlock();</div>
|
||||
</div><!-- fragment --><p>"mutex" in this example is one for all threads. </p>
|
||||
<p>Block of code that should to be executed only one thread simultaniously should to be started with <em><a class="el" href="class_p_i_mutex.html#aa571ad61ee7bd5fcf60f6f5032a16441" title="Lock mutex. ">lock()</a></em> and ended with <em><a class="el" href="class_p_i_mutex.html#aae483d17150e38436ca25a1bd26b04c2" title="Unlock mutex. ">unlock()</a></em>. </p><div class="fragment"><div class="line">mutex.lock();</div><div class="line"><span class="comment">// ... your code here</span></div><div class="line">mutex.unlock();</div></div><!-- fragment --><p>"mutex" in this example is one for all threads. </p>
|
||||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="aa571ad61ee7bd5fcf60f6f5032a16441"></a>
|
||||
<a id="aa571ad61ee7bd5fcf60f6f5032a16441"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aa571ad61ee7bd5fcf60f6f5032a16441">◆ </a></span>lock()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
@@ -130,7 +120,9 @@ Usage</h1>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aae483d17150e38436ca25a1bd26b04c2"></a>
|
||||
<a id="aae483d17150e38436ca25a1bd26b04c2"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aae483d17150e38436ca25a1bd26b04c2">◆ </a></span>unlock()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
@@ -148,7 +140,9 @@ Usage</h1>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a5c4ed063c5c7d7ee94ff3402d320851a"></a>
|
||||
<a id="a5c4ed063c5c7d7ee94ff3402d320851a"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a5c4ed063c5c7d7ee94ff3402d320851a">◆ </a></span>tryLock()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
@@ -172,9 +166,9 @@ Usage</h1>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_p_i_mutex.html">PIMutex</a></li>
|
||||
<li class="footer">Generated on Sat Jan 30 2016 21:43:28 for PIP by
|
||||
<li class="footer">Generated on Mon Feb 27 2017 15:24:46 for PIP by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user