<!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::SpinLock 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_1SpinLock.html">SpinLock</a> </div> </div> <div class="contents"> <h1>kyotocabinet::SpinLock Class Reference</h1><!-- doxytag: class="kyotocabinet::SpinLock" --> <p>Lightweight mutual exclusion device. <a href="#_details">More...</a></p> <p><code>#include <kcthread.h></code></p> <p><a href="classkyotocabinet_1_1SpinLock-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_1SpinLock.html#a2c35eefaf58572efa4a06b83299192dc">SpinLock</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a2c35eefaf58572efa4a06b83299192dc"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1SpinLock.html#a2c1a92839710e1ce4c6ae42c0805a0c4">~SpinLock</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a2c1a92839710e1ce4c6ae42c0805a0c4"></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_1SpinLock.html#abe6a24664c6ccf898f57dabe855a79cc">lock</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the lock. <a href="#abe6a24664c6ccf898f57dabe855a79cc"></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_1SpinLock.html#a5935812ac3d066cf642748af267ce6b4">lock_try</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Try to get the lock. <a href="#a5935812ac3d066cf642748af267ce6b4"></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_1SpinLock.html#aa7e4ae87da07b870018eebe9bb7c8bd4">unlock</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Release the lock. <a href="#aa7e4ae87da07b870018eebe9bb7c8bd4"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Lightweight mutual exclusion device. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a2c35eefaf58572efa4a06b83299192dc"></a><!-- doxytag: member="kyotocabinet::SpinLock::SpinLock" ref="a2c35eefaf58572efa4a06b83299192dc" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">kyotocabinet::SpinLock::SpinLock </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="a2c1a92839710e1ce4c6ae42c0805a0c4"></a><!-- doxytag: member="kyotocabinet::SpinLock::~SpinLock" ref="a2c1a92839710e1ce4c6ae42c0805a0c4" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">kyotocabinet::SpinLock::~SpinLock </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="abe6a24664c6ccf898f57dabe855a79cc"></a><!-- doxytag: member="kyotocabinet::SpinLock::lock" ref="abe6a24664c6ccf898f57dabe855a79cc" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void kyotocabinet::SpinLock::lock </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Get the lock. </p> </div> </div> <a class="anchor" id="a5935812ac3d066cf642748af267ce6b4"></a><!-- doxytag: member="kyotocabinet::SpinLock::lock_try" ref="a5935812ac3d066cf642748af267ce6b4" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool kyotocabinet::SpinLock::lock_try </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Try to get the 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="aa7e4ae87da07b870018eebe9bb7c8bd4"></a><!-- doxytag: member="kyotocabinet::SpinLock::unlock" ref="aa7e4ae87da07b870018eebe9bb7c8bd4" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void kyotocabinet::SpinLock::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 Sat Dec 11 01:50:27 2010 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>