Debian Codegraph @

doc/api/classkyotocabinet_1_1RWLock.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <title>Kyoto Cabinet: kyotocabinet::RWLock Class Reference</title>
7
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
10
11
12
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div! -->
16
17
18 <div id="titlearea">
19 <table cellspacing="0" cellpadding="0">
20 <tbody>
21 <tr style="height: 56px;">
22
23
24 <td style="padding-left: 0.5em;">
25 <div id="projectname">Kyoto Cabinet
26
27 </div>
28
29 </td>
30
31
32
33 </tr>
34 </tbody>
35 </table>
36 </div>
37
38 <!-- Generated by Doxygen 1.7.6.1 -->
39 <div id="navrow1" class="tabs">
40 <ul class="tablist">
41 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
42 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
43 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
44 <li><a href="files.html"><span>Files</span></a></li>
45 </ul>
46 </div>
47 <div id="navrow2" class="tabs2">
48 <ul class="tablist">
49 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
50 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
51 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
52 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
53 </ul>
54 </div>
55 <div id="nav-path" class="navpath">
56 <ul>
57 <li class="navelem"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a> </li>
58 <li class="navelem"><a class="el" href="classkyotocabinet_1_1RWLock.html">RWLock</a> </li>
59 </ul>
60 </div>
61 </div>
62 <div class="header">
63 <div class="summary">
64 <a href="#pub-methods">Public Member Functions</a> </div>
65 <div class="headertitle">
66 <div class="title">kyotocabinet::RWLock Class Reference</div> </div>
67 </div><!--header-->
68 <div class="contents">
69 <!-- doxytag: class="kyotocabinet::RWLock" -->
70 <p>Reader-writer locking device.
71 <a href="classkyotocabinet_1_1RWLock.html#details">More...</a></p>
72
73 <p><code>#include &lt;kcthread.h&gt;</code></p>
74
75 <p><a href="classkyotocabinet_1_1RWLock-members.html">List of all members.</a></p>
76 <table class="memberdecls">
77 <tr><td colspan="2"><h2><a name="pub-methods"></a>
78 Public Member Functions</h2></td></tr>
79 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#ab8d4cacbed30a225d74868a0b924f680">RWLock</a> ()</td></tr>
80 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <a href="#ab8d4cacbed30a225d74868a0b924f680"></a><br/></td></tr>
81 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#a09c3dbcfb667fcc5ff2815f3a042afaf">~RWLock</a> ()</td></tr>
82 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a09c3dbcfb667fcc5ff2815f3a042afaf"></a><br/></td></tr>
83 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#ab9a8799747f2f08fea90ef3f54479216">lock_writer</a> ()</td></tr>
84 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the writer lock. <a href="#ab9a8799747f2f08fea90ef3f54479216"></a><br/></td></tr>
85 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#abb9b29a5265c7e805a73a5abc2997287">lock_writer_try</a> ()</td></tr>
86 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Try to get the writer lock. <a href="#abb9b29a5265c7e805a73a5abc2997287"></a><br/></td></tr>
87 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#abbb6bf7a27a91de36e2adc962f6c9d98">lock_reader</a> ()</td></tr>
88 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a reader lock. <a href="#abbb6bf7a27a91de36e2adc962f6c9d98"></a><br/></td></tr>
89 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#a86252db93906ea42547f308772ef9184">lock_reader_try</a> ()</td></tr>
90 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Try to get a reader lock. <a href="#a86252db93906ea42547f308772ef9184"></a><br/></td></tr>
91 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1RWLock.html#ae8d9ff19977afcda9f253aa1c2411fc1">unlock</a> ()</td></tr>
92 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Release the lock. <a href="#ae8d9ff19977afcda9f253aa1c2411fc1"></a><br/></td></tr>
93 </table>
94 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
95 <div class="textblock"><p>Reader-writer locking device. </p>
96 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
97 <a class="anchor" id="ab8d4cacbed30a225d74868a0b924f680"></a><!-- doxytag: member="kyotocabinet::RWLock::RWLock" ref="ab8d4cacbed30a225d74868a0b924f680" args="()" -->
98 <div class="memitem">
99 <div class="memproto">
100 <table class="memname">
101 <tr>
102 <td class="memname"><a class="el" href="classkyotocabinet_1_1RWLock.html#ab8d4cacbed30a225d74868a0b924f680">kyotocabinet::RWLock::RWLock</a> </td>
103 <td>(</td>
104 <td class="paramname"></td><td>)</td>
105 <td><code> [explicit]</code></td>
106 </tr>
107 </table>
108 </div>
109 <div class="memdoc">
110
111 <p>Default constructor. </p>
112
113 </div>
114 </div>
115 <a class="anchor" id="a09c3dbcfb667fcc5ff2815f3a042afaf"></a><!-- doxytag: member="kyotocabinet::RWLock::~RWLock" ref="a09c3dbcfb667fcc5ff2815f3a042afaf" args="()" -->
116 <div class="memitem">
117 <div class="memproto">
118 <table class="memname">
119 <tr>
120 <td class="memname"><a class="el" href="classkyotocabinet_1_1RWLock.html#a09c3dbcfb667fcc5ff2815f3a042afaf">kyotocabinet::RWLock::~RWLock</a> </td>
121 <td>(</td>
122 <td class="paramname"></td><td>)</td>
123 <td></td>
124 </tr>
125 </table>
126 </div>
127 <div class="memdoc">
128
129 <p>Destructor. </p>
130
131 </div>
132 </div>
133 <hr/><h2>Member Function Documentation</h2>
134 <a class="anchor" id="ab9a8799747f2f08fea90ef3f54479216"></a><!-- doxytag: member="kyotocabinet::RWLock::lock_writer" ref="ab9a8799747f2f08fea90ef3f54479216" args="()" -->
135 <div class="memitem">
136 <div class="memproto">
137 <table class="memname">
138 <tr>
139 <td class="memname">void <a class="el" href="classkyotocabinet_1_1RWLock.html#ab9a8799747f2f08fea90ef3f54479216">kyotocabinet::RWLock::lock_writer</a> </td>
140 <td>(</td>
141 <td class="paramname"></td><td>)</td>
142 <td></td>
143 </tr>
144 </table>
145 </div>
146 <div class="memdoc">
147
148 <p>Get the writer lock. </p>
149
150 </div>
151 </div>
152 <a class="anchor" id="abb9b29a5265c7e805a73a5abc2997287"></a><!-- doxytag: member="kyotocabinet::RWLock::lock_writer_try" ref="abb9b29a5265c7e805a73a5abc2997287" args="()" -->
153 <div class="memitem">
154 <div class="memproto">
155 <table class="memname">
156 <tr>
157 <td class="memname">bool <a class="el" href="classkyotocabinet_1_1RWLock.html#abb9b29a5265c7e805a73a5abc2997287">kyotocabinet::RWLock::lock_writer_try</a> </td>
158 <td>(</td>
159 <td class="paramname"></td><td>)</td>
160 <td></td>
161 </tr>
162 </table>
163 </div>
164 <div class="memdoc">
165
166 <p>Try to get the writer lock. </p>
167 <dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
168
169 </div>
170 </div>
171 <a class="anchor" id="abbb6bf7a27a91de36e2adc962f6c9d98"></a><!-- doxytag: member="kyotocabinet::RWLock::lock_reader" ref="abbb6bf7a27a91de36e2adc962f6c9d98" args="()" -->
172 <div class="memitem">
173 <div class="memproto">
174 <table class="memname">
175 <tr>
176 <td class="memname">void <a class="el" href="classkyotocabinet_1_1RWLock.html#abbb6bf7a27a91de36e2adc962f6c9d98">kyotocabinet::RWLock::lock_reader</a> </td>
177 <td>(</td>
178 <td class="paramname"></td><td>)</td>
179 <td></td>
180 </tr>
181 </table>
182 </div>
183 <div class="memdoc">
184
185 <p>Get a reader lock. </p>
186
187 </div>
188 </div>
189 <a class="anchor" id="a86252db93906ea42547f308772ef9184"></a><!-- doxytag: member="kyotocabinet::RWLock::lock_reader_try" ref="a86252db93906ea42547f308772ef9184" args="()" -->
190 <div class="memitem">
191 <div class="memproto">
192 <table class="memname">
193 <tr>
194 <td class="memname">bool <a class="el" href="classkyotocabinet_1_1RWLock.html#a86252db93906ea42547f308772ef9184">kyotocabinet::RWLock::lock_reader_try</a> </td>
195 <td>(</td>
196 <td class="paramname"></td><td>)</td>
197 <td></td>
198 </tr>
199 </table>
200 </div>
201 <div class="memdoc">
202
203 <p>Try to get a reader lock. </p>
204 <dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
205
206 </div>
207 </div>
208 <a class="anchor" id="ae8d9ff19977afcda9f253aa1c2411fc1"></a><!-- doxytag: member="kyotocabinet::RWLock::unlock" ref="ae8d9ff19977afcda9f253aa1c2411fc1" args="()" -->
209 <div class="memitem">
210 <div class="memproto">
211 <table class="memname">
212 <tr>
213 <td class="memname">void <a class="el" href="classkyotocabinet_1_1RWLock.html#ae8d9ff19977afcda9f253aa1c2411fc1">kyotocabinet::RWLock::unlock</a> </td>
214 <td>(</td>
215 <td class="paramname"></td><td>)</td>
216 <td></td>
217 </tr>
218 </table>
219 </div>
220 <div class="memdoc">
221
222 <p>Release the lock. </p>
223
224 </div>
225 </div>
226 </div><!-- contents -->
227
228
229 <hr class="footer"/><address class="footer"><small>
230 Generated on Fri May 25 2012 01:21:36 for Kyoto Cabinet by &#160;<a href="http://www.doxygen.org/index.html">
231 <img class="footer" src="doxygen.png" alt="doxygen"/>
232 </a> 1.7.6.1
233 </small></address>
234
235 </body>
236 </html>