<!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>GNU CommonC++: ost::ThreadLock Class 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="index.html"><span>Main Page</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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 class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_thread_lock.html">ThreadLock</a>
</div>
</div>
<div class="contents">
<h1>ost::ThreadLock Class Reference</h1><!-- doxytag: class="ost::ThreadLock" -->
<p>The <a class="el" href="classost_1_1_thread_lock.html" title="The ThreadLock class impliments a thread rwlock for optimal reader performance on...">ThreadLock</a> class impliments a thread rwlock for optimal reader performance on systems which have rwlock support, and reverts to a simple mutex for those that do not.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="thread_8h_source.html">thread.h</a>></code></p>
<p><a href="classost_1_1_thread_lock-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#a3844f7c41e77b7f498bcb64e2880ae60">ThreadLock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a process shared thread lock object. <a href="#a3844f7c41e77b7f498bcb64e2880ae60"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#a73d294adbe345f5727f84f75ed03d4b4">~ThreadLock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a process shared thread lock object. <a href="#a73d294adbe345f5727f84f75ed03d4b4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#a0c60b2cbd8c51b9d5e097422f667ad2a">readLock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Aquire a read lock for the current object. <a href="#a0c60b2cbd8c51b9d5e097422f667ad2a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#a436668b798e53addfe451d641a7faeec">writeLock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Aquire a write lock for the current object. <a href="#a436668b798e53addfe451d641a7faeec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#a0b6a57ab08b3ee3ef688aaa3f8164869">tryReadLock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempt read lock for current object. <a href="#a0b6a57ab08b3ee3ef688aaa3f8164869"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#ab405f01d33cc07e7f362a1860d0cdce9">tryWriteLock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempt write lock for current object. <a href="#ab405f01d33cc07e7f362a1860d0cdce9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#a6aaee369f359cb509baa3accb82db979">unlock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release any held locks. <a href="#a6aaee369f359cb509baa3accb82db979"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classost_1_1_thread_lock.html" title="The ThreadLock class impliments a thread rwlock for optimal reader performance on...">ThreadLock</a> class impliments a thread rwlock for optimal reader performance on systems which have rwlock support, and reverts to a simple mutex for those that do not. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> Posix rwlock extension for protected access. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3844f7c41e77b7f498bcb64e2880ae60"></a><!-- doxytag: member="ost::ThreadLock::ThreadLock" ref="a3844f7c41e77b7f498bcb64e2880ae60" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::ThreadLock::ThreadLock </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a process shared thread lock object. </p>
</div>
</div>
<a class="anchor" id="a73d294adbe345f5727f84f75ed03d4b4"></a><!-- doxytag: member="ost::ThreadLock::~ThreadLock" ref="a73d294adbe345f5727f84f75ed03d4b4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::ThreadLock::~ThreadLock </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy a process shared thread lock object. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0c60b2cbd8c51b9d5e097422f667ad2a"></a><!-- doxytag: member="ost::ThreadLock::readLock" ref="a0c60b2cbd8c51b9d5e097422f667ad2a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::ThreadLock::readLock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Aquire a read lock for the current object. </p>
</div>
</div>
<a class="anchor" id="a0b6a57ab08b3ee3ef688aaa3f8164869"></a><!-- doxytag: member="ost::ThreadLock::tryReadLock" ref="a0b6a57ab08b3ee3ef688aaa3f8164869" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::ThreadLock::tryReadLock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Attempt read lock for current object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success. </dd></dl>
</div>
</div>
<a class="anchor" id="ab405f01d33cc07e7f362a1860d0cdce9"></a><!-- doxytag: member="ost::ThreadLock::tryWriteLock" ref="ab405f01d33cc07e7f362a1860d0cdce9" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::ThreadLock::tryWriteLock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Attempt write lock for current object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success. </dd></dl>
</div>
</div>
<a class="anchor" id="a6aaee369f359cb509baa3accb82db979"></a><!-- doxytag: member="ost::ThreadLock::unlock" ref="a6aaee369f359cb509baa3accb82db979" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::ThreadLock::unlock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release any held locks. </p>
</div>
</div>
<a class="anchor" id="a436668b798e53addfe451d641a7faeec"></a><!-- doxytag: member="ost::ThreadLock::writeLock" ref="a436668b798e53addfe451d641a7faeec" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::ThreadLock::writeLock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Aquire a write lock for the current object. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="thread_8h_source.html">thread.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ 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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
400
