<!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>Kyoto Cabinet: kyotocabinet::RWLock 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>
</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="namespacekyotocabinet.html">kyotocabinet</a>::<a class="el" href="classkyotocabinet_1_1RWLock.html">RWLock</a>
</div>
</div>
<div class="contents">
<h1>kyotocabinet::RWLock Class Reference</h1><!-- doxytag: class="kyotocabinet::RWLock" -->
<p>Reader-writer locking device.
<a href="#_details">More...</a></p>
<p><code>#include <kcthread.h></code></p>
<p><a href="classkyotocabinet_1_1RWLock-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="classkyotocabinet_1_1RWLock.html#ab8d4cacbed30a225d74868a0b924f680">RWLock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#ab8d4cacbed30a225d74868a0b924f680"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#a09c3dbcfb667fcc5ff2815f3a042afaf">~RWLock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a09c3dbcfb667fcc5ff2815f3a042afaf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#ab9a8799747f2f08fea90ef3f54479216">lock_writer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the writer lock. <a href="#ab9a8799747f2f08fea90ef3f54479216"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#abb9b29a5265c7e805a73a5abc2997287">lock_writer_try</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Try to get the writer lock. <a href="#abb9b29a5265c7e805a73a5abc2997287"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#abbb6bf7a27a91de36e2adc962f6c9d98">lock_reader</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a reader lock. <a href="#abbb6bf7a27a91de36e2adc962f6c9d98"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#a86252db93906ea42547f308772ef9184">lock_reader_try</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Try to get a reader lock. <a href="#a86252db93906ea42547f308772ef9184"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#ae8d9ff19977afcda9f253aa1c2411fc1">unlock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release the lock. <a href="#ae8d9ff19977afcda9f253aa1c2411fc1"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Reader-writer locking device. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab8d4cacbed30a225d74868a0b924f680"></a><!-- doxytag: member="kyotocabinet::RWLock::RWLock" ref="ab8d4cacbed30a225d74868a0b924f680" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kyotocabinet::RWLock::RWLock </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
</div>
</div>
<a class="anchor" id="a09c3dbcfb667fcc5ff2815f3a042afaf"></a><!-- doxytag: member="kyotocabinet::RWLock::~RWLock" ref="a09c3dbcfb667fcc5ff2815f3a042afaf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kyotocabinet::RWLock::~RWLock </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab9a8799747f2f08fea90ef3f54479216"></a><!-- doxytag: member="kyotocabinet::RWLock::lock_writer" ref="ab9a8799747f2f08fea90ef3f54479216" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::RWLock::lock_writer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the writer lock. </p>
</div>
</div>
<a class="anchor" id="abb9b29a5265c7e805a73a5abc2997287"></a><!-- doxytag: member="kyotocabinet::RWLock::lock_writer_try" ref="abb9b29a5265c7e805a73a5abc2997287" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::RWLock::lock_writer_try </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Try to get the writer lock. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="abbb6bf7a27a91de36e2adc962f6c9d98"></a><!-- doxytag: member="kyotocabinet::RWLock::lock_reader" ref="abbb6bf7a27a91de36e2adc962f6c9d98" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::RWLock::lock_reader </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a reader lock. </p>
</div>
</div>
<a class="anchor" id="a86252db93906ea42547f308772ef9184"></a><!-- doxytag: member="kyotocabinet::RWLock::lock_reader_try" ref="a86252db93906ea42547f308772ef9184" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::RWLock::lock_reader_try </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Try to get a reader lock. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ae8d9ff19977afcda9f253aa1c2411fc1"></a><!-- doxytag: member="kyotocabinet::RWLock::unlock" ref="ae8d9ff19977afcda9f253aa1c2411fc1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::RWLock::unlock </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release the lock. </p>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jan 3 13:02:28 2011 for Kyoto Cabinet 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>
