<!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.5"/>
<title>GNU CommonC++: ost::ThreadLock 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="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">GNU CommonC++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_thread_lock.html">ThreadLock</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classost_1_1_thread_lock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::ThreadLock Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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 systems which have ...">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="classost_1_1_thread_lock.html#details">More...</a></p>
<p><code>#include <<a class="el" href="thread_8h_source.html">thread.h</a>></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:a3844f7c41e77b7f498bcb64e2880ae60"><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 class="memdesc:a3844f7c41e77b7f498bcb64e2880ae60"><td class="mdescLeft"> </td><td class="mdescRight">Create a process shared thread lock object. <a href="#a3844f7c41e77b7f498bcb64e2880ae60">More...</a><br/></td></tr>
<tr class="separator:a3844f7c41e77b7f498bcb64e2880ae60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73d294adbe345f5727f84f75ed03d4b4"><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 class="memdesc:a73d294adbe345f5727f84f75ed03d4b4"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a process shared thread lock object. <a href="#a73d294adbe345f5727f84f75ed03d4b4">More...</a><br/></td></tr>
<tr class="separator:a73d294adbe345f5727f84f75ed03d4b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c60b2cbd8c51b9d5e097422f667ad2a"><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 class="memdesc:a0c60b2cbd8c51b9d5e097422f667ad2a"><td class="mdescLeft"> </td><td class="mdescRight">Aquire a read lock for the current object. <a href="#a0c60b2cbd8c51b9d5e097422f667ad2a">More...</a><br/></td></tr>
<tr class="separator:a0c60b2cbd8c51b9d5e097422f667ad2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a436668b798e53addfe451d641a7faeec"><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 class="memdesc:a436668b798e53addfe451d641a7faeec"><td class="mdescLeft"> </td><td class="mdescRight">Aquire a write lock for the current object. <a href="#a436668b798e53addfe451d641a7faeec">More...</a><br/></td></tr>
<tr class="separator:a436668b798e53addfe451d641a7faeec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b6a57ab08b3ee3ef688aaa3f8164869"><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 class="memdesc:a0b6a57ab08b3ee3ef688aaa3f8164869"><td class="mdescLeft"> </td><td class="mdescRight">Attempt read lock for current object. <a href="#a0b6a57ab08b3ee3ef688aaa3f8164869">More...</a><br/></td></tr>
<tr class="separator:a0b6a57ab08b3ee3ef688aaa3f8164869"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab405f01d33cc07e7f362a1860d0cdce9"><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 class="memdesc:ab405f01d33cc07e7f362a1860d0cdce9"><td class="mdescLeft"> </td><td class="mdescRight">Attempt write lock for current object. <a href="#ab405f01d33cc07e7f362a1860d0cdce9">More...</a><br/></td></tr>
<tr class="separator:ab405f01d33cc07e7f362a1860d0cdce9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6aaee369f359cb509baa3accb82db979"><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 class="memdesc:a6aaee369f359cb509baa3accb82db979"><td class="mdescLeft"> </td><td class="mdescRight">Release any held locks. <a href="#a6aaee369f359cb509baa3accb82db979">More...</a><br/></td></tr>
<tr class="separator:a6aaee369f359cb509baa3accb82db979"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><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 systems which have ...">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="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> Posix rwlock extension for protected access. </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3844f7c41e77b7f498bcb64e2880ae60"></a>
<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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ost::ThreadLock::~ThreadLock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a process shared thread lock object. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0c60b2cbd8c51b9d5e097422f667ad2a"></a>
<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>
<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="section return"><dt>Returns</dt><dd>true on success. </dd></dl>
</div>
</div>
<a class="anchor" id="ab405f01d33cc07e7f362a1860d0cdce9"></a>
<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="section return"><dt>Returns</dt><dd>true on success. </dd></dl>
</div>
</div>
<a class="anchor" id="a6aaee369f359cb509baa3accb82db979"></a>
<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>
<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><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 23:24:58 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
