SHS/pip
4
3
Fork 0
Code Issues 67 Pull Requests 1 Actions Releases Wiki Activity
Files
052fe8663396f9f222fcdf693f3035534a41bafd
pip/doc/html/class_p_i_mutex.html

184 lines
10 KiB
HTML
Raw Blame History

<!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.14"/>
<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>
<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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PIP
&#160;<span id="projectnumber">1.8.0</span>
</div>
<div id="projectbrief">Platform-Independent Primitives</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_p_i_mutex.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<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 id="ac4d6be4bdac6af45f1db56c4d1a0d971"></a>
&#160;</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">&#160;</td><td class="mdescRight">Constructs unlocked mutex. <br /></td></tr>
<tr class="separator:ac4d6be4bdac6af45f1db56c4d1a0d971"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfc2274439f3691a56c068eed2314897"><td class="memItemLeft" align="right" valign="top"><a id="abfc2274439f3691a56c068eed2314897"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_mutex.html#abfc2274439f3691a56c068eed2314897">~PIMutex</a> ()</td></tr>
<tr class="memdesc:abfc2274439f3691a56c068eed2314897"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy mutex. <br /></td></tr>
<tr class="separator:abfc2274439f3691a56c068eed2314897"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa571ad61ee7bd5fcf60f6f5032a16441"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td><td class="mdescRight">Lock mutex. <a href="#aa571ad61ee7bd5fcf60f6f5032a16441">More...</a><br /></td></tr>
<tr class="separator:aa571ad61ee7bd5fcf60f6f5032a16441"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae483d17150e38436ca25a1bd26b04c2"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td><td class="mdescRight">Unlock mutex. <a href="#aae483d17150e38436ca25a1bd26b04c2">More...</a><br /></td></tr>
<tr class="separator:aae483d17150e38436ca25a1bd26b04c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c4ed063c5c7d7ee94ff3402d320851a"><td class="memItemLeft" align="right" valign="top">bool&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a753da7bdbbeff323d5bfa01b411cfd8d"><td class="memItemLeft" align="right" valign="top"><a id="a753da7bdbbeff323d5bfa01b411cfd8d"></a>
bool&#160;</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">&#160;</td><td class="mdescRight">Returns if mutex is locked. <br /></td></tr>
<tr class="separator:a753da7bdbbeff323d5bfa01b411cfd8d"><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>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 id="aa571ad61ee7bd5fcf60f6f5032a16441"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa571ad61ee7bd5fcf60f6f5032a16441">&#9670;&nbsp;</a></span>lock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PIMutex::lock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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 id="aae483d17150e38436ca25a1bd26b04c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae483d17150e38436ca25a1bd26b04c2">&#9670;&nbsp;</a></span>unlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PIMutex::unlock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unlock mutex. </p>
<p>In any case this function returns immediate </p>
</div>
</div>
<a id="a5c4ed063c5c7d7ee94ff3402d320851a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c4ed063c5c7d7ee94ff3402d320851a">&#9670;&nbsp;</a></span>tryLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PIMutex::tryLock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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 Fri Sep 28 2018 21:06:37 for PIP by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink