<!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">
<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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libzypp: zypp::base::InterProcessMutex 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&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">libzypp
 <span id="projectnumber">17.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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&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&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classzypp_1_1base_1_1InterProcessMutex.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="classzypp_1_1base_1_1InterProcessMutex-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">zypp::base::InterProcessMutex Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Inter process scoped lock implementation.
<a href="classzypp_1_1base_1_1InterProcessMutex.html#details">More...</a></p>
<p><code>#include <<a class="el" href="InterProcessMutex_8h_source.html">InterProcessMutex.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for zypp::base::InterProcessMutex:</div>
<div class="dyncontent">
<div class="center"><img src="classzypp_1_1base_1_1InterProcessMutex__inherit__graph.png" border="0" usemap="#zypp_1_1base_1_1InterProcessMutex_inherit__map" alt="Inheritance graph"/></div>
<map name="zypp_1_1base_1_1InterProcessMutex_inherit__map" id="zypp_1_1base_1_1InterProcessMutex_inherit__map">
<area shape="rect" title="Inter process scoped lock implementation." alt="" coords="5,80,175,121"/>
<area shape="rect" title=" " alt="" coords="19,5,161,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html">Options</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">options to alter the mutex behavor <a href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a92b55e495c58a83a5a18acb914efd909"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#a92b55e495c58a83a5a18acb914efd909">ConsumerType</a> { <a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#a92b55e495c58a83a5a18acb914efd909a070f400ef460e5e01663aba0b982e64c">Reader</a>,
<a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#a92b55e495c58a83a5a18acb914efd909a4ca83e486b0cb7d049cf33b29ee866a3">Writer</a>
}</td></tr>
<tr class="memdesc:a92b55e495c58a83a5a18acb914efd909"><td class="mdescLeft"> </td><td class="mdescRight">Processes can be of two types Reader or Writer. <a href="classzypp_1_1base_1_1InterProcessMutex.html#a92b55e495c58a83a5a18acb914efd909">More...</a><br /></td></tr>
<tr class="separator:a92b55e495c58a83a5a18acb914efd909"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:afa38a3d3f446048c01f077d70e9da7cb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#afa38a3d3f446048c01f077d70e9da7cb">InterProcessMutex</a> (const <a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html">Options</a> &poptions)</td></tr>
<tr class="memdesc:afa38a3d3f446048c01f077d70e9da7cb"><td class="mdescLeft"> </td><td class="mdescRight">Creates a mutex with a name and a timeout. <a href="#afa38a3d3f446048c01f077d70e9da7cb">More...</a><br /></td></tr>
<tr class="separator:afa38a3d3f446048c01f077d70e9da7cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6417bc43a865775605cc1c64ae248a2a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#a6417bc43a865775605cc1c64ae248a2a">~InterProcessMutex</a> ()</td></tr>
<tr class="memdesc:a6417bc43a865775605cc1c64ae248a2a"><td class="mdescLeft"> </td><td class="mdescRight">Destructor, gives up the lock on the named resource. <a href="#a6417bc43a865775605cc1c64ae248a2a">More...</a><br /></td></tr>
<tr class="separator:a6417bc43a865775605cc1c64ae248a2a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a25b7f1fcd5ce9a1c8c03039e99a30e63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbool.html">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#a25b7f1fcd5ce9a1c8c03039e99a30e63">isProcessRunning</a> (pid_t pid_r)</td></tr>
<tr class="separator:a25b7f1fcd5ce9a1c8c03039e99a30e63"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16a22ffe99dba1598f56ac051aa0c1bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#a16a22ffe99dba1598f56ac051aa0c1bf">lockFilePath</a> () const</td></tr>
<tr class="separator:a16a22ffe99dba1598f56ac051aa0c1bf"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aa109f392ed9985f129b2a266682065ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classshared__ptr.html">shared_ptr</a>< <a class="el" href="classzypp_1_1base_1_1Fd.html">Fd</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#aa109f392ed9985f129b2a266682065ae">_fd</a></td></tr>
<tr class="separator:aa109f392ed9985f129b2a266682065ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7111c6dbd70a898312400f7582649734"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html">Options</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#a7111c6dbd70a898312400f7582649734">_options</a></td></tr>
<tr class="separator:a7111c6dbd70a898312400f7582649734"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Inter process scoped lock implementation. </p>
<p>This mutex will allow only one writer process to reach a critical region protected by a mutex of the same name, if there are no readers at the same time.</p>
<p>Multiple readers are allowed if there is no currently a writer. </p>
<p class="definition">Definition at line <a class="el" href="InterProcessMutex_8h_source.html#l00043">43</a> of file <a class="el" href="InterProcessMutex_8h_source.html">InterProcessMutex.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a92b55e495c58a83a5a18acb914efd909"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92b55e495c58a83a5a18acb914efd909">◆ </a></span>ConsumerType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#a92b55e495c58a83a5a18acb914efd909">zypp::base::InterProcessMutex::ConsumerType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Processes can be of two types Reader or Writer. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a92b55e495c58a83a5a18acb914efd909a070f400ef460e5e01663aba0b982e64c"></a>Reader </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a92b55e495c58a83a5a18acb914efd909a4ca83e486b0cb7d049cf33b29ee866a3"></a>Writer </td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="InterProcessMutex_8h_source.html#l00050">50</a> of file <a class="el" href="InterProcessMutex_8h_source.html">InterProcessMutex.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="afa38a3d3f446048c01f077d70e9da7cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa38a3d3f446048c01f077d70e9da7cb">◆ </a></span>InterProcessMutex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">zypp::base::InterProcessMutex::InterProcessMutex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html">Options</a> & </td>
<td class="paramname"><em>poptions</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a mutex with a name and a timeout. </p>
<p>default timeout is -1 which means no timeout at all, and the mutex will wait forever if other process is accessing the critical region for a mutex in with the same name.</p>
<p>If the timeout is 0, then if the lock is acquired an exception will be thrown inmediately.</p>
<p>Otherwise, the timeout exception will come after the timeout is reached. </p>
<p class="definition">Definition at line <a class="el" href="InterProcessMutex_8cc_source.html#l00055">55</a> of file <a class="el" href="InterProcessMutex_8cc_source.html">InterProcessMutex.cc</a>.</p>
</div>
</div>
<a id="a6417bc43a865775605cc1c64ae248a2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6417bc43a865775605cc1c64ae248a2a">◆ </a></span>~InterProcessMutex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">zypp::base::InterProcessMutex::~InterProcessMutex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor, gives up the lock on the named resource. </p>
<p class="definition">Definition at line <a class="el" href="InterProcessMutex_8cc_source.html#l00284">284</a> of file <a class="el" href="InterProcessMutex_8cc_source.html">InterProcessMutex.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a25b7f1fcd5ce9a1c8c03039e99a30e63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25b7f1fcd5ce9a1c8c03039e99a30e63">◆ </a></span>isProcessRunning()</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="classbool.html">bool</a> zypp::base::InterProcessMutex::isProcessRunning </td>
<td>(</td>
<td class="paramtype">pid_t </td>
<td class="paramname"><em>pid_r</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="InterProcessMutex_8cc_source.html#l00318">318</a> of file <a class="el" href="InterProcessMutex_8cc_source.html">InterProcessMutex.cc</a>.</p>
</div>
</div>
<a id="a16a22ffe99dba1598f56ac051aa0c1bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16a22ffe99dba1598f56ac051aa0c1bf">◆ </a></span>lockFilePath()</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="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> zypp::base::InterProcessMutex::lockFilePath </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="InterProcessMutex_8cc_source.html#l00312">312</a> of file <a class="el" href="InterProcessMutex_8cc_source.html">InterProcessMutex.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa109f392ed9985f129b2a266682065ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa109f392ed9985f129b2a266682065ae">◆ </a></span>_fd</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="classshared__ptr.html">shared_ptr</a><<a class="el" href="classzypp_1_1base_1_1Fd.html">Fd</a>> zypp::base::InterProcessMutex::_fd</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="InterProcessMutex_8h_source.html#l00120">120</a> of file <a class="el" href="InterProcessMutex_8h_source.html">InterProcessMutex.h</a>.</p>
</div>
</div>
<a id="a7111c6dbd70a898312400f7582649734"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7111c6dbd70a898312400f7582649734">◆ </a></span>_options</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="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html">Options</a> zypp::base::InterProcessMutex::_options</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="InterProcessMutex_8h_source.html#l00121">121</a> of file <a class="el" href="InterProcessMutex_8h_source.html">InterProcessMutex.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>zypp/base/<a class="el" href="InterProcessMutex_8h_source.html">InterProcessMutex.h</a></li>
<li>zypp/base/<a class="el" href="InterProcessMutex_8cc_source.html">InterProcessMutex.cc</a></li>
</ul>
</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="namespacezypp.html">zypp</a></li><li class="navelem"><a class="el" href="namespacezypp_1_1base.html">base</a></li><li class="navelem"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html">InterProcessMutex</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
68c0c2ff89d8bf9051ff1b9773ed48e4
>
files
>
4442
