<!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>xmltooling: xmltooling::Mutex 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="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">xmltooling  <span id="projectnumber">1.5.3</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <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="hierarchy.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('a00052.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="a00265.html">List of all members</a> </div> <div class="headertitle"> <div class="title">xmltooling::Mutex Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p>A class for managing exclusive access to resources. <a href="a00052.html#details">More...</a></p> <p><code>#include <xmltooling/util/Threads.h></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:ab2fd493e23aa594cd267d0b5e39b847b"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#ab2fd493e23aa594cd267d0b5e39b847b">lock</a> ()=0</td></tr> <tr class="memdesc:ab2fd493e23aa594cd267d0b5e39b847b"><td class="mdescLeft"> </td><td class="mdescRight">Locks the mutex for exclusive access. <a href="#ab2fd493e23aa594cd267d0b5e39b847b">More...</a><br /></td></tr> <tr class="separator:ab2fd493e23aa594cd267d0b5e39b847b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1bd0643a5aa85c0d612bfddc5d1d372a"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a1bd0643a5aa85c0d612bfddc5d1d372a">unlock</a> ()=0</td></tr> <tr class="memdesc:a1bd0643a5aa85c0d612bfddc5d1d372a"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the mutex for exclusive access. <a href="#a1bd0643a5aa85c0d612bfddc5d1d372a">More...</a><br /></td></tr> <tr class="separator:a1bd0643a5aa85c0d612bfddc5d1d372a"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a43aacc3a6509ec560208b27ad15fe6f8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00052.html">Mutex</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a43aacc3a6509ec560208b27ad15fe6f8">create</a> ()</td></tr> <tr class="memdesc:a43aacc3a6509ec560208b27ad15fe6f8"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new mutex object. <a href="#a43aacc3a6509ec560208b27ad15fe6f8">More...</a><br /></td></tr> <tr class="separator:a43aacc3a6509ec560208b27ad15fe6f8"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A class for managing exclusive access to resources. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a43aacc3a6509ec560208b27ad15fe6f8"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a00052.html">Mutex</a>* xmltooling::Mutex::create </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Creates a new mutex object. </p> <dl class="section return"><dt>Returns</dt><dd>the new mutex </dd></dl> </div> </div> <a class="anchor" id="ab2fd493e23aa594cd267d0b5e39b847b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual int xmltooling::Mutex::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">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Locks the mutex for exclusive access. </p> <dl class="section return"><dt>Returns</dt><dd>0 for success, non-zero for failure </dd></dl> </div> </div> <a class="anchor" id="a1bd0643a5aa85c0d612bfddc5d1d372a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual int xmltooling::Mutex::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">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Unlocks the mutex for exclusive access. </p> <dl class="section return"><dt>Returns</dt><dd>0 for success, non-zero for failure </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>xmltooling/util/<a class="el" href="a00190.html">Threads.h</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="a00206.html">xmltooling</a></li><li class="navelem"><a class="el" href="a00052.html">Mutex</a></li> <li class="footer">Generated on Fri Oct 17 2014 12:44:58 for xmltooling 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>