<!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::Options 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_1_1Options.html','');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> | <a href="classzypp_1_1base_1_1InterProcessMutex_1_1Options-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">zypp::base::InterProcessMutex::Options Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>options to alter the mutex behavor <a href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html#details">More...</a></p> <p><code>#include <<a class="el" href="InterProcessMutex_8h_source.html">InterProcessMutex.h</a>></code></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:af1893b7bcffd7624d68db677e9c06e39"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html#af1893b7bcffd7624d68db677e9c06e39">Options</a> (<a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#a92b55e495c58a83a5a18acb914efd909">ConsumerType</a> ptype, const std::string &pname="zypp", int ptimeout=-1)</td></tr> <tr class="memdesc:af1893b7bcffd7624d68db677e9c06e39"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html" title="options to alter the mutex behavor">Options</a> for a mutex of type ptype with a given name and timeout. <a href="#af1893b7bcffd7624d68db677e9c06e39">More...</a><br /></td></tr> <tr class="separator:af1893b7bcffd7624d68db677e9c06e39"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adfdfdfa9fcbe5d79d98fbc1972d3971e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html#adfdfdfa9fcbe5d79d98fbc1972d3971e">setPath</a> (const <a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> &<a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html#af1ac256968a3bb9245f920690c1e83df">base</a>)</td></tr> <tr class="memdesc:adfdfdfa9fcbe5d79d98fbc1972d3971e"><td class="mdescLeft"> </td><td class="mdescRight">set the path where the lockfile is created. <a href="#adfdfdfa9fcbe5d79d98fbc1972d3971e">More...</a><br /></td></tr> <tr class="separator:adfdfdfa9fcbe5d79d98fbc1972d3971e"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:ab74e778ad958810183ec2e4eb480c95f"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html#ab74e778ad958810183ec2e4eb480c95f">name</a></td></tr> <tr class="separator:ab74e778ad958810183ec2e4eb480c95f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af072ab2bbf878fd4cd44a7fa779a5c02"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html#af072ab2bbf878fd4cd44a7fa779a5c02">timeout</a></td></tr> <tr class="separator:af072ab2bbf878fd4cd44a7fa779a5c02"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac794d6ed3c93aeea384e9b22cc995e19"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#a92b55e495c58a83a5a18acb914efd909">ConsumerType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html#ac794d6ed3c93aeea384e9b22cc995e19">type</a></td></tr> <tr class="separator:ac794d6ed3c93aeea384e9b22cc995e19"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af1ac256968a3bb9245f920690c1e83df"><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_1_1Options.html#af1ac256968a3bb9245f920690c1e83df">base</a></td></tr> <tr class="separator:af1ac256968a3bb9245f920690c1e83df"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>options to alter the mutex behavor </p> <p class="definition">Definition at line <a class="el" href="InterProcessMutex_8h_source.html#l00059">59</a> of file <a class="el" href="InterProcessMutex_8h_source.html">InterProcessMutex.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="af1893b7bcffd7624d68db677e9c06e39"></a> <h2 class="memtitle"><span class="permalink"><a href="#af1893b7bcffd7624d68db677e9c06e39">◆ </a></span>Options()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">zypp::base::InterProcessMutex::Options::Options </td> <td>(</td> <td class="paramtype"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#a92b55e495c58a83a5a18acb914efd909">ConsumerType</a> </td> <td class="paramname"><em>ptype</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>pname</em> = <code>"zypp"</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>ptimeout</em> = <code>-1</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p><a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html" title="options to alter the mutex behavor">Options</a> for a mutex of type ptype with a given name and timeout. </p> <p>Default is name "zypp" and no timeout (wait till resource is free)</p> <p>The mutex type, Writer or Reader must be given explictly.</p> <p>The mutex will be handled using a lock file located on default library path if the library is running as root, and in users home directory if not. </p> <p class="definition">Definition at line <a class="el" href="InterProcessMutex_8cc_source.html#l00040">40</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="adfdfdfa9fcbe5d79d98fbc1972d3971e"></a> <h2 class="memtitle"><span class="permalink"><a href="#adfdfdfa9fcbe5d79d98fbc1972d3971e">◆ </a></span>setPath()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void zypp::base::InterProcessMutex::Options::setPath </td> <td>(</td> <td class="paramtype">const <a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> & </td> <td class="paramname"><em>base</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>set the path where the lockfile is created. </p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a id="ab74e778ad958810183ec2e4eb480c95f"></a> <h2 class="memtitle"><span class="permalink"><a href="#ab74e778ad958810183ec2e4eb480c95f">◆ </a></span>name</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string zypp::base::InterProcessMutex::Options::name</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="InterProcessMutex_8h_source.html#l00087">87</a> of file <a class="el" href="InterProcessMutex_8h_source.html">InterProcessMutex.h</a>.</p> </div> </div> <a id="af072ab2bbf878fd4cd44a7fa779a5c02"></a> <h2 class="memtitle"><span class="permalink"><a href="#af072ab2bbf878fd4cd44a7fa779a5c02">◆ </a></span>timeout</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int zypp::base::InterProcessMutex::Options::timeout</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="InterProcessMutex_8h_source.html#l00088">88</a> of file <a class="el" href="InterProcessMutex_8h_source.html">InterProcessMutex.h</a>.</p> </div> </div> <a id="ac794d6ed3c93aeea384e9b22cc995e19"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac794d6ed3c93aeea384e9b22cc995e19">◆ </a></span>type</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex.html#a92b55e495c58a83a5a18acb914efd909">ConsumerType</a> zypp::base::InterProcessMutex::Options::type</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="InterProcessMutex_8h_source.html#l00089">89</a> of file <a class="el" href="InterProcessMutex_8h_source.html">InterProcessMutex.h</a>.</p> </div> </div> <a id="af1ac256968a3bb9245f920690c1e83df"></a> <h2 class="memtitle"><span class="permalink"><a href="#af1ac256968a3bb9245f920690c1e83df">◆ </a></span>base</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> zypp::base::InterProcessMutex::Options::base</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="InterProcessMutex_8h_source.html#l00090">90</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="navelem"><a class="el" href="classzypp_1_1base_1_1InterProcessMutex_1_1Options.html">Options</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>