with docs
git-svn-id: svn://db.shs.com.ru/pip@5 12ceb7fc-bf1f-11e4-8940-5bc7170c53b5
This commit is contained in:
238
doc/html/class_p_i_mutex.html
Normal file
238
doc/html/class_p_i_mutex.html
Normal file
@@ -0,0 +1,238 @@
|
||||
<!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.8"/>
|
||||
<title>PIP: PIMutex 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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
||||
</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! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td style="padding-left: 0.5em;">
|
||||
<div id="projectname">PIP
|
||||
 <span id="projectnumber">0.4.1_alpha3</span>
|
||||
</div>
|
||||
<div id="projectbrief">Platform-Independent Primitives</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.8 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<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>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</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>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_p_i_mutex.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_p_i_mutex-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">PIMutex Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Mutex.
|
||||
<a href="class_p_i_mutex.html#details">More...</a></p>
|
||||
<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>
|
||||
 </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>
|
||||
<tr class="memitem:aa571ad61ee7bd5fcf60f6f5032a16441"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_mutex.html#aa571ad61ee7bd5fcf60f6f5032a16441">lock</a> ()</td></tr>
|
||||
<tr class="memdesc:aa571ad61ee7bd5fcf60f6f5032a16441"><td class="mdescLeft"> </td><td class="mdescRight">Lock mutex. <a href="#aa571ad61ee7bd5fcf60f6f5032a16441">More...</a><br /></td></tr>
|
||||
<tr class="separator:aa571ad61ee7bd5fcf60f6f5032a16441"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aae483d17150e38436ca25a1bd26b04c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_mutex.html#aae483d17150e38436ca25a1bd26b04c2">unlock</a> ()</td></tr>
|
||||
<tr class="memdesc:aae483d17150e38436ca25a1bd26b04c2"><td class="mdescLeft"> </td><td class="mdescRight">Unlock mutex. <a href="#aae483d17150e38436ca25a1bd26b04c2">More...</a><br /></td></tr>
|
||||
<tr class="separator:aae483d17150e38436ca25a1bd26b04c2"><td class="memSeparator" colspan="2"> </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>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Mutex. </p>
|
||||
<h1><a class="anchor" id="PIMutex_sec0"></a>
|
||||
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>
|
||||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="aa571ad61ee7bd5fcf60f6f5032a16441"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void PIMutex::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>Lock mutex. </p>
|
||||
<p>If mutex is unlocked it set to locked state and returns immediate. If mutex is already locked function blocks until mutex will be unlocked </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aae483d17150e38436ca25a1bd26b04c2"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void PIMutex::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">
|
||||
|
||||
<p>Unlock mutex. </p>
|
||||
<p>In any case this function returns immediate </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a5c4ed063c5c7d7ee94ff3402d320851a"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool PIMutex::tryLock </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>Try to lock mutex. </p>
|
||||
<p>If mutex is unlocked it set to locked state and returns "true" immediate. If mutex is already locked function returns immediate an returns "false" </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<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 Sun Nov 2 2014 22:29:35 for PIP by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user