<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::ThreadLock Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<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 class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_thread_lock.html">ThreadLock</a></div>
<h1>ost::ThreadLock Class Reference</h1><!-- doxytag: class="ost::ThreadLock" -->The <a class="el" href="classost_1_1_thread_lock.html">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.Posix rwlock extension for protected access.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="thread_8h-source.html">thread.h</a>></code>
<p>
<a href="classost_1_1_thread_lock-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#3844f7c41e77b7f498bcb64e2880ae60">ThreadLock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a process shared thread lock object. <a href="#3844f7c41e77b7f498bcb64e2880ae60"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#73d294adbe345f5727f84f75ed03d4b4">~ThreadLock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a process shared thread lock object. <a href="#73d294adbe345f5727f84f75ed03d4b4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#0c60b2cbd8c51b9d5e097422f667ad2a">readLock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Aquire a read lock for the current object. <a href="#0c60b2cbd8c51b9d5e097422f667ad2a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#436668b798e53addfe451d641a7faeec">writeLock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Aquire a write lock for the current object. <a href="#436668b798e53addfe451d641a7faeec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#0b6a57ab08b3ee3ef688aaa3f8164869">tryReadLock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempt read lock for current object. <a href="#0b6a57ab08b3ee3ef688aaa3f8164869"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#b405f01d33cc07e7f362a1860d0cdce9">tryWriteLock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempt write lock for current object. <a href="#b405f01d33cc07e7f362a1860d0cdce9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html#6aaee369f359cb509baa3accb82db979">unlock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release any held locks. <a href="#6aaee369f359cb509baa3accb82db979"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classost_1_1_thread_lock.html">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.Posix rwlock extension for protected access.
<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="3844f7c41e77b7f498bcb64e2880ae60"></a><!-- doxytag: member="ost::ThreadLock::ThreadLock" ref="3844f7c41e77b7f498bcb64e2880ae60" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::ThreadLock::ThreadLock </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a process shared thread lock object.
<p>
</td>
</tr>
</table>
<a class="anchor" name="73d294adbe345f5727f84f75ed03d4b4"></a><!-- doxytag: member="ost::ThreadLock::~ThreadLock" ref="73d294adbe345f5727f84f75ed03d4b4" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::ThreadLock::~ThreadLock </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destroy a process shared thread lock object.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0c60b2cbd8c51b9d5e097422f667ad2a"></a><!-- doxytag: member="ost::ThreadLock::readLock" ref="0c60b2cbd8c51b9d5e097422f667ad2a" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::ThreadLock::readLock </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Aquire a read lock for the current object.
<p>
</td>
</tr>
</table>
<a class="anchor" name="0b6a57ab08b3ee3ef688aaa3f8164869"></a><!-- doxytag: member="ost::ThreadLock::tryReadLock" ref="0b6a57ab08b3ee3ef688aaa3f8164869" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::ThreadLock::tryReadLock </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Attempt read lock for current object.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true on success. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="b405f01d33cc07e7f362a1860d0cdce9"></a><!-- doxytag: member="ost::ThreadLock::tryWriteLock" ref="b405f01d33cc07e7f362a1860d0cdce9" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::ThreadLock::tryWriteLock </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Attempt write lock for current object.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true on success. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="6aaee369f359cb509baa3accb82db979"></a><!-- doxytag: member="ost::ThreadLock::unlock" ref="6aaee369f359cb509baa3accb82db979" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::ThreadLock::unlock </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Release any held locks.
<p>
</td>
</tr>
</table>
<a class="anchor" name="436668b798e53addfe451d641a7faeec"></a><!-- doxytag: member="ost::ThreadLock::writeLock" ref="436668b798e53addfe451d641a7faeec" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::ThreadLock::writeLock </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Aquire a write lock for the current object.
<p>
</td>
</tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:57 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
