<!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"/>
<title>ucommon: ucommon/access.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>ucommon/access.h File Reference</h1>
<p>Locking classes for member function automatic operations.
<a href="#_details">More...</a></p>
<code>#include <<a class="el" href="a00194_source.html">ucommon/platform.h</a>></code><br/>
<div class="dynheader">
Include dependency graph for access.h:</div>
<div class="dynsection">
<div class="center"><img src="a00221.png" border="0" usemap="#ucommon_2access_8h_map" alt=""/></div>
<map name="ucommon_2access_8h_map" id="ucommon_2access_8h">
<area shape="rect" id="node3" href="a00194.html" title="Various miscellaneous platform specific headers and defines." alt="" coords="635,80,837,107"/></map>
</div>
<div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dynsection">
<div class="center"><img src="a00222.png" border="0" usemap="#ucommon_2access_8hdep_map" alt=""/></div>
<map name="ucommon_2access_8hdep_map" id="ucommon_2access_8hdep">
<area shape="rect" id="node3" href="a00202.html" title="Thread classes and sychronization objects." alt="" coords="557,80,739,107"/><area shape="rect" id="node7" href="a00204.html" title="Top level include file for the GNU uCommon C++ core library." alt="" coords="429,379,621,405"/><area shape="rect" id="node5" href="a00181.html" title="Threadsafe object containers." alt="" coords="5,304,227,331"/><area shape="rect" id="node11" href="a00185.html" title="Thread-aware file system manipulation class." alt="" coords="392,155,555,181"/><area shape="rect" id="node20" href="a00200.html" title="Any ucommon streaming classes that are built from std::streamio facilities and that..." alt="" coords="557,229,739,256"/><area shape="rect" id="node24" href="a00189.html" title="Support for memory mapped objects." alt="" coords="763,229,944,256"/><area shape="rect" id="node29" href="a00206.html" title="Basic array and reusable object factory heap support." alt="" coords="793,155,975,181"/><area shape="rect" id="node9" href="a00196.html" title="This library holds basic cryptographic functions and secure socket support for use..." alt="" coords="435,453,616,480"/><area shape="rect" id="node13" href="a00180.html" title="Classes which use the buffer protocol to stream data." alt="" coords="352,229,533,256"/><area shape="rect" id="node15" href="a00197.html" title="Generic shell parsing and application services." alt="" coords="440,304,611,331"/></map>
</div>
<p><a href="a00177_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html">ucommon::exclusive_lock</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A kind of smart pointer object to support exclusive locking protocol. <a href="a00048.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00049.html">ucommon::ExclusiveProtocol</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An exclusive locking protocol interface base. <a href="a00049.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00123.html">ucommon::shared_lock</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A kind of smart pointer object to support shared locking protocol. <a href="a00123.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00128.html">ucommon::SharedProtocol</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An exclusive locking protocol interface base. <a href="a00128.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html">ucommon</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Common namespace for all ucommon objects. </p>
<br/></td></tr>
</p>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4dc13224ae0606c24a3952d0119d6d63"></a><!-- doxytag: member="access.h::exclusive_access" ref="a4dc13224ae0606c24a3952d0119d6d63" args="(x)" -->
#define </td><td class="memItemRight" valign="bottom"><b>exclusive_access</b>(x) exlock_t __autolock__ = &x</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdb46d649c8fb6b11b555117b1ef4b48"></a><!-- doxytag: member="access.h::exclusive_object" ref="afdb46d649c8fb6b11b555117b1ef4b48" args="()" -->
#define </td><td class="memItemRight" valign="bottom"><b>exclusive_object</b>() exlock_t __autolock__ = this</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42648abdfb15d8abaf8c308d6b6a6e25"></a><!-- doxytag: member="access.h::protected_access" ref="a42648abdfb15d8abaf8c308d6b6a6e25" args="(x)" -->
#define </td><td class="memItemRight" valign="bottom"><b>protected_access</b>(x) shlock_t __autolock__ = &x</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a453defe2c5de62cbe51af2ce4f7843b4"></a><!-- doxytag: member="access.h::protected_object" ref="a453defe2c5de62cbe51af2ce4f7843b4" args="()" -->
#define </td><td class="memItemRight" valign="bottom"><b>protected_object</b>() shlock_t __autolock__ = this</td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1b206748a4675583711dd2a60c0d435"></a><!-- doxytag: member="access.h::exlock_t" ref="ac1b206748a4675583711dd2a60c0d435" args="" -->
typedef exclusive_lock </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html#ac1b206748a4675583711dd2a60c0d435">ucommon::exlock_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience type to use for object referencing an exclusive object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0aa2b11125533b17b59cea4e63182e37"></a><!-- doxytag: member="access.h::shlock_t" ref="a0aa2b11125533b17b59cea4e63182e37" args="" -->
typedef shared_lock </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html#a0aa2b11125533b17b59cea4e63182e37">ucommon::shlock_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience type to use for object referencing a shared object. <br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html#a5422fe5f7269f2606c8317e29e4147bf">ucommon::access</a> (SharedProtocol *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to access (lock) shared object through it's protocol. <a href="#a5422fe5f7269f2606c8317e29e4147bf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html#a38f16b6c76465ba13751ff3b5be4a41e">ucommon::exclusive</a> (SharedProtocol *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to exclusive lock shared object through it's protocol. <a href="#a38f16b6c76465ba13751ff3b5be4a41e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html#a93b9eec9d0b7db95ce778265f806afd6">ucommon::lock</a> (ExclusiveProtocol *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to exclusively lock an object through it's protocol. <a href="#a93b9eec9d0b7db95ce778265f806afd6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html#a40cad4d2f99609499746d66063c5a04b">ucommon::release</a> (shlock_t &reference)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to release a reference to a shared lock. <a href="#a40cad4d2f99609499746d66063c5a04b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html#a447e496c6053ef4532637ed44bec2b63">ucommon::release</a> (exlock_t &reference)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to release a reference to an exclusive lock. <a href="#a447e496c6053ef4532637ed44bec2b63"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html#a8df8e4b667d68be02961ff0d4cd84224">ucommon::release</a> (SharedProtocol *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to unlock shared object through it's protocol. <a href="#a8df8e4b667d68be02961ff0d4cd84224"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html#aa738a981d717c379a3facda88eafbdea">ucommon::share</a> (SharedProtocol *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to restore shared locking for object through it's protocol. <a href="#aa738a981d717c379a3facda88eafbdea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html#a06fc306b76334e4410e554d683ae790b">ucommon::unlock</a> (ExclusiveProtocol *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to unlock an exclusive object through it's protocol. <a href="#a06fc306b76334e4410e554d683ae790b"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Locking classes for member function automatic operations. </p>
<p>This header covers ucommon access related classes. These are used to provide automatic management of locks and synchronization objects through common virtual base classes which can be used with automatic objects. These classes are intended to be used much like "protocols" in conjunction with smart pointer/referencing classes. This protocol interface supports member functions to acquire a lock when entered and automatically release the lock when the member function returns that are used in conjunction with special referencing smart pointers. </p>
<p>Definition in file <a class="el" href="a00177_source.html">access.h</a>.</p>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:38:57 2011 for ucommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
