<!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"/>
<title>Kyoto Cabinet: kyotocabinet::SpinRWLock Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Kyoto Cabinet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<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>
</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="namespacekyotocabinet.html">kyotocabinet</a> </li>
<li class="navelem"><a class="el" href="classkyotocabinet_1_1SpinRWLock.html">SpinRWLock</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">kyotocabinet::SpinRWLock Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="kyotocabinet::SpinRWLock" -->
<p>Lightweight reader-writer locking device.
<a href="classkyotocabinet_1_1SpinRWLock.html#details">More...</a></p>
<p><code>#include <kcthread.h></code></p>
<p><a href="classkyotocabinet_1_1SpinRWLock-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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_1SpinRWLock.html#a25aa60db4aabbbbfe71c9232f5237cbf">SpinRWLock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a25aa60db4aabbbbfe71c9232f5237cbf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1SpinRWLock.html#a5dfd3267f02f736e1fae6b169b7dfa05">~SpinRWLock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a5dfd3267f02f736e1fae6b169b7dfa05"></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_1SpinRWLock.html#aad5c21b72910172a633bb30c841b33e3">lock_writer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the writer lock. <a href="#aad5c21b72910172a633bb30c841b33e3"></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_1SpinRWLock.html#a3c7fffa4e1a114efbec7cb1c41c0098a">lock_writer_try</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Try to get the writer lock. <a href="#a3c7fffa4e1a114efbec7cb1c41c0098a"></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_1SpinRWLock.html#acd589f9b2c66f0ca8051766ade0e1399">lock_reader</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a reader lock. <a href="#acd589f9b2c66f0ca8051766ade0e1399"></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_1SpinRWLock.html#ad41f41bc02dd137d2f519826dc6a61df">lock_reader_try</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Try to get a reader lock. <a href="#ad41f41bc02dd137d2f519826dc6a61df"></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_1SpinRWLock.html#a511e8d30ee24f67e914e59992cc042be">unlock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release the lock. <a href="#a511e8d30ee24f67e914e59992cc042be"></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_1SpinRWLock.html#a1c01703eef1e1d4e381019b137c889dc">promote</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Promote a reader lock to the writer lock. <a href="#a1c01703eef1e1d4e381019b137c889dc"></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_1SpinRWLock.html#a5e60170fe21b5a8dddc3589fe2787075">demote</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Demote the writer lock to a reader lock. <a href="#a5e60170fe21b5a8dddc3589fe2787075"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Lightweight reader-writer locking device. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a25aa60db4aabbbbfe71c9232f5237cbf"></a><!-- doxytag: member="kyotocabinet::SpinRWLock::SpinRWLock" ref="a25aa60db4aabbbbfe71c9232f5237cbf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkyotocabinet_1_1SpinRWLock.html#a25aa60db4aabbbbfe71c9232f5237cbf">kyotocabinet::SpinRWLock::SpinRWLock</a> </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="a5dfd3267f02f736e1fae6b169b7dfa05"></a><!-- doxytag: member="kyotocabinet::SpinRWLock::~SpinRWLock" ref="a5dfd3267f02f736e1fae6b169b7dfa05" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkyotocabinet_1_1SpinRWLock.html#a5dfd3267f02f736e1fae6b169b7dfa05">kyotocabinet::SpinRWLock::~SpinRWLock</a> </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="aad5c21b72910172a633bb30c841b33e3"></a><!-- doxytag: member="kyotocabinet::SpinRWLock::lock_writer" ref="aad5c21b72910172a633bb30c841b33e3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classkyotocabinet_1_1SpinRWLock.html#aad5c21b72910172a633bb30c841b33e3">kyotocabinet::SpinRWLock::lock_writer</a> </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="a3c7fffa4e1a114efbec7cb1c41c0098a"></a><!-- doxytag: member="kyotocabinet::SpinRWLock::lock_writer_try" ref="a3c7fffa4e1a114efbec7cb1c41c0098a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1SpinRWLock.html#a3c7fffa4e1a114efbec7cb1c41c0098a">kyotocabinet::SpinRWLock::lock_writer_try</a> </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="acd589f9b2c66f0ca8051766ade0e1399"></a><!-- doxytag: member="kyotocabinet::SpinRWLock::lock_reader" ref="acd589f9b2c66f0ca8051766ade0e1399" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classkyotocabinet_1_1SpinRWLock.html#acd589f9b2c66f0ca8051766ade0e1399">kyotocabinet::SpinRWLock::lock_reader</a> </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="ad41f41bc02dd137d2f519826dc6a61df"></a><!-- doxytag: member="kyotocabinet::SpinRWLock::lock_reader_try" ref="ad41f41bc02dd137d2f519826dc6a61df" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1SpinRWLock.html#ad41f41bc02dd137d2f519826dc6a61df">kyotocabinet::SpinRWLock::lock_reader_try</a> </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="a511e8d30ee24f67e914e59992cc042be"></a><!-- doxytag: member="kyotocabinet::SpinRWLock::unlock" ref="a511e8d30ee24f67e914e59992cc042be" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classkyotocabinet_1_1SpinRWLock.html#a511e8d30ee24f67e914e59992cc042be">kyotocabinet::SpinRWLock::unlock</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release the lock. </p>
</div>
</div>
<a class="anchor" id="a1c01703eef1e1d4e381019b137c889dc"></a><!-- doxytag: member="kyotocabinet::SpinRWLock::promote" ref="a1c01703eef1e1d4e381019b137c889dc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1SpinRWLock.html#a1c01703eef1e1d4e381019b137c889dc">kyotocabinet::SpinRWLock::promote</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Promote a reader lock to 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="a5e60170fe21b5a8dddc3589fe2787075"></a><!-- doxytag: member="kyotocabinet::SpinRWLock::demote" ref="a5e60170fe21b5a8dddc3589fe2787075" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classkyotocabinet_1_1SpinRWLock.html#a5e60170fe21b5a8dddc3589fe2787075">kyotocabinet::SpinRWLock::demote</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Demote the writer lock to a reader lock. </p>
</div>
</div>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 25 2012 01:21:36 for Kyoto Cabinet by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
fbf4a6a432c86099f5fc5195773d119c
>
files
>
119
