<!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::SharedLock 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('a00074.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="a00286.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">xmltooling::SharedLock Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>RAII wrapper for a shared lock.
<a href="a00074.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:abc769c830da81988995e14b4bc37a1f6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#abc769c830da81988995e14b4bc37a1f6">SharedLock</a> (<a class="el" href="a00072.html">RWLock</a> *lock, bool lockit=true)</td></tr>
<tr class="memdesc:abc769c830da81988995e14b4bc37a1f6"><td class="mdescLeft"> </td><td class="mdescRight">Locks and wraps the designated shared lock. <a href="#abc769c830da81988995e14b4bc37a1f6">More...</a><br /></td></tr>
<tr class="separator:abc769c830da81988995e14b4bc37a1f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a086788c06dfae764b512922b6a11fb54"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#a086788c06dfae764b512922b6a11fb54">SharedLock</a> (const std::auto_ptr< <a class="el" href="a00072.html">RWLock</a> > &lock, bool lockit=true)</td></tr>
<tr class="memdesc:a086788c06dfae764b512922b6a11fb54"><td class="mdescLeft"> </td><td class="mdescRight">Locks and wraps the designated shared lock. <a href="#a086788c06dfae764b512922b6a11fb54">More...</a><br /></td></tr>
<tr class="separator:a086788c06dfae764b512922b6a11fb54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab628b2b55a3dc8306322241720adbb34"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#ab628b2b55a3dc8306322241720adbb34">SharedLock</a> (const boost::scoped_ptr< <a class="el" href="a00072.html">RWLock</a> > &lock, bool lockit=true)</td></tr>
<tr class="memdesc:ab628b2b55a3dc8306322241720adbb34"><td class="mdescLeft"> </td><td class="mdescRight">Locks and wraps the designated shared lock. <a href="#ab628b2b55a3dc8306322241720adbb34">More...</a><br /></td></tr>
<tr class="separator:ab628b2b55a3dc8306322241720adbb34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad51358f73f4bfd9732847782998d65f5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad51358f73f4bfd9732847782998d65f5"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#ad51358f73f4bfd9732847782998d65f5">~SharedLock</a> ()</td></tr>
<tr class="memdesc:ad51358f73f4bfd9732847782998d65f5"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the wrapped shared lock, if any. <br /></td></tr>
<tr class="separator:ad51358f73f4bfd9732847782998d65f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a394a0235d8c786320a184b458e6362e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00072.html">RWLock</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#a394a0235d8c786320a184b458e6362e3">release</a> ()</td></tr>
<tr class="memdesc:a394a0235d8c786320a184b458e6362e3"><td class="mdescLeft"> </td><td class="mdescRight">Releases control of the original shared lock and returns it without unlocking it. <a href="#a394a0235d8c786320a184b458e6362e3">More...</a><br /></td></tr>
<tr class="separator:a394a0235d8c786320a184b458e6362e3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>RAII wrapper for a shared lock. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="abc769c830da81988995e14b4bc37a1f6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xmltooling::SharedLock::SharedLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00072.html">RWLock</a> * </td>
<td class="paramname"><em>lock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>lockit</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</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>Locks and wraps the designated shared lock. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lock</td><td>lock to acquire </td></tr>
<tr><td class="paramname">lockit</td><td>true if the lock should be acquired here, false if already acquired </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a086788c06dfae764b512922b6a11fb54"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xmltooling::SharedLock::SharedLock </td>
<td>(</td>
<td class="paramtype">const std::auto_ptr< <a class="el" href="a00072.html">RWLock</a> > & </td>
<td class="paramname"><em>lock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>lockit</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</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>Locks and wraps the designated shared lock. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lock</td><td>lock to acquire </td></tr>
<tr><td class="paramname">lockit</td><td>true if the lock should be acquired here, false if already acquired </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab628b2b55a3dc8306322241720adbb34"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xmltooling::SharedLock::SharedLock </td>
<td>(</td>
<td class="paramtype">const boost::scoped_ptr< <a class="el" href="a00072.html">RWLock</a> > & </td>
<td class="paramname"><em>lock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>lockit</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</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>Locks and wraps the designated shared lock. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lock</td><td>lock to acquire </td></tr>
<tr><td class="paramname">lockit</td><td>true if the lock should be acquired here, false if already acquired </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a394a0235d8c786320a184b458e6362e3"></a>
<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="a00072.html">RWLock</a>* xmltooling::SharedLock::release </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>Releases control of the original shared lock and returns it without unlocking it. </p>
<dl class="section return"><dt>Returns</dt><dd>the original shared lock </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="a00074.html">SharedLock</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>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
553d1e1391b9f1acad517c925f34ae45
>
files
>
290
