← Back to branch summary

~ubuntu-branches/ubuntu/quantal/kyotocabinet/quantal

« back to all changes in this revision

Viewing changes to doc/api/classkyotocabinet_1_1SlottedSpinLock.html

  • Committer: Package Import Robot
  • Author(s): Shawn Landden
  • Date: 2012-06-07 16:12:07 UTC
  • Revision ID: package-import@ubuntu.com-20120607161207-prbj5blqgzzfl8of
Tags: upstream-1.2.76
Import upstream version 1.2.76

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/classkyotocabinet_1_1SlottedSpinLock.html
 
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::SlottedSpinLock 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_1SlottedSpinLock.html">SlottedSpinLock</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::SlottedSpinLock Class Reference</div>  </div>
 
67
</div><!--header-->
 
68
<div class="contents">
 
69
<!-- doxytag: class="kyotocabinet::SlottedSpinLock" -->
 
70
<p>Slotted spin lock devices.  
 
71
 <a href="classkyotocabinet_1_1SlottedSpinLock.html#details">More...</a></p>
 
72
 
 
73
<p><code>#include &lt;kcthread.h&gt;</code></p>
 
74
 
 
75
<p><a href="classkyotocabinet_1_1SlottedSpinLock-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_1SlottedSpinLock.html#ad4156a04310e33b731b277fa72d45df7">SlottedSpinLock</a> (size_t slotnum)</td></tr>
 
80
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ad4156a04310e33b731b277fa72d45df7"></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_1SlottedSpinLock.html#a5e698fdc29b0a4e17e4625a578a00fd5">~SlottedSpinLock</a> ()</td></tr>
 
82
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a5e698fdc29b0a4e17e4625a578a00fd5"></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_1SlottedSpinLock.html#acc13cadda0afb4e1cbba4b13dc015c6a">lock</a> (size_t idx)</td></tr>
 
84
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the lock of a slot.  <a href="#acc13cadda0afb4e1cbba4b13dc015c6a"></a><br/></td></tr>
 
85
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1SlottedSpinLock.html#a62aa49e24124f2fa3fa397001e5a6193">unlock</a> (size_t idx)</td></tr>
 
86
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Release the lock of a slot.  <a href="#a62aa49e24124f2fa3fa397001e5a6193"></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_1SlottedSpinLock.html#a296c34b628c4c6d43603d620d53b8f78">lock_all</a> ()</td></tr>
 
88
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the locks of all slots.  <a href="#a296c34b628c4c6d43603d620d53b8f78"></a><br/></td></tr>
 
89
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1SlottedSpinLock.html#a33943a61b8288cca50a3aef83c569d84">unlock_all</a> ()</td></tr>
 
90
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Release the locks of all slots.  <a href="#a33943a61b8288cca50a3aef83c569d84"></a><br/></td></tr>
 
91
</table>
 
92
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
 
93
<div class="textblock"><p>Slotted spin lock devices. </p>
 
94
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
95
<a class="anchor" id="ad4156a04310e33b731b277fa72d45df7"></a><!-- doxytag: member="kyotocabinet::SlottedSpinLock::SlottedSpinLock" ref="ad4156a04310e33b731b277fa72d45df7" args="(size_t slotnum)" -->
 
96
<div class="memitem">
 
97
<div class="memproto">
 
98
      <table class="memname">
 
99
        <tr>
 
100
          <td class="memname"><a class="el" href="classkyotocabinet_1_1SlottedSpinLock.html#ad4156a04310e33b731b277fa72d45df7">kyotocabinet::SlottedSpinLock::SlottedSpinLock</a> </td>
 
101
          <td>(</td>
 
102
          <td class="paramtype">size_t&#160;</td>
 
103
          <td class="paramname"><em>slotnum</em></td><td>)</td>
 
104
          <td><code> [explicit]</code></td>
 
105
        </tr>
 
106
      </table>
 
107
</div>
 
108
<div class="memdoc">
 
109
 
 
110
<p>Constructor. </p>
 
111
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
112
  <table class="params">
 
113
    <tr><td class="paramname">slotnum</td><td>the number of slots. </td></tr>
 
114
  </table>
 
115
  </dd>
 
116
</dl>
 
117
 
 
118
</div>
 
119
</div>
 
120
<a class="anchor" id="a5e698fdc29b0a4e17e4625a578a00fd5"></a><!-- doxytag: member="kyotocabinet::SlottedSpinLock::~SlottedSpinLock" ref="a5e698fdc29b0a4e17e4625a578a00fd5" args="()" -->
 
121
<div class="memitem">
 
122
<div class="memproto">
 
123
      <table class="memname">
 
124
        <tr>
 
125
          <td class="memname"><a class="el" href="classkyotocabinet_1_1SlottedSpinLock.html#a5e698fdc29b0a4e17e4625a578a00fd5">kyotocabinet::SlottedSpinLock::~SlottedSpinLock</a> </td>
 
126
          <td>(</td>
 
127
          <td class="paramname"></td><td>)</td>
 
128
          <td></td>
 
129
        </tr>
 
130
      </table>
 
131
</div>
 
132
<div class="memdoc">
 
133
 
 
134
<p>Destructor. </p>
 
135
 
 
136
</div>
 
137
</div>
 
138
<hr/><h2>Member Function Documentation</h2>
 
139
<a class="anchor" id="acc13cadda0afb4e1cbba4b13dc015c6a"></a><!-- doxytag: member="kyotocabinet::SlottedSpinLock::lock" ref="acc13cadda0afb4e1cbba4b13dc015c6a" args="(size_t idx)" -->
 
140
<div class="memitem">
 
141
<div class="memproto">
 
142
      <table class="memname">
 
143
        <tr>
 
144
          <td class="memname">void <a class="el" href="classkyotocabinet_1_1SlottedSpinLock.html#acc13cadda0afb4e1cbba4b13dc015c6a">kyotocabinet::SlottedSpinLock::lock</a> </td>
 
145
          <td>(</td>
 
146
          <td class="paramtype">size_t&#160;</td>
 
147
          <td class="paramname"><em>idx</em></td><td>)</td>
 
148
          <td></td>
 
149
        </tr>
 
150
      </table>
 
151
</div>
 
152
<div class="memdoc">
 
153
 
 
154
<p>Get the lock of a slot. </p>
 
155
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
156
  <table class="params">
 
157
    <tr><td class="paramname">idx</td><td>the index of a slot. </td></tr>
 
158
  </table>
 
159
  </dd>
 
160
</dl>
 
161
 
 
162
</div>
 
163
</div>
 
164
<a class="anchor" id="a62aa49e24124f2fa3fa397001e5a6193"></a><!-- doxytag: member="kyotocabinet::SlottedSpinLock::unlock" ref="a62aa49e24124f2fa3fa397001e5a6193" args="(size_t idx)" -->
 
165
<div class="memitem">
 
166
<div class="memproto">
 
167
      <table class="memname">
 
168
        <tr>
 
169
          <td class="memname">void <a class="el" href="classkyotocabinet_1_1SlottedSpinLock.html#a62aa49e24124f2fa3fa397001e5a6193">kyotocabinet::SlottedSpinLock::unlock</a> </td>
 
170
          <td>(</td>
 
171
          <td class="paramtype">size_t&#160;</td>
 
172
          <td class="paramname"><em>idx</em></td><td>)</td>
 
173
          <td></td>
 
174
        </tr>
 
175
      </table>
 
176
</div>
 
177
<div class="memdoc">
 
178
 
 
179
<p>Release the lock of a slot. </p>
 
180
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
181
  <table class="params">
 
182
    <tr><td class="paramname">idx</td><td>the index of a slot. </td></tr>
 
183
  </table>
 
184
  </dd>
 
185
</dl>
 
186
 
 
187
</div>
 
188
</div>
 
189
<a class="anchor" id="a296c34b628c4c6d43603d620d53b8f78"></a><!-- doxytag: member="kyotocabinet::SlottedSpinLock::lock_all" ref="a296c34b628c4c6d43603d620d53b8f78" args="()" -->
 
190
<div class="memitem">
 
191
<div class="memproto">
 
192
      <table class="memname">
 
193
        <tr>
 
194
          <td class="memname">void <a class="el" href="classkyotocabinet_1_1SlottedSpinLock.html#a296c34b628c4c6d43603d620d53b8f78">kyotocabinet::SlottedSpinLock::lock_all</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>Get the locks of all slots. </p>
 
204
 
 
205
</div>
 
206
</div>
 
207
<a class="anchor" id="a33943a61b8288cca50a3aef83c569d84"></a><!-- doxytag: member="kyotocabinet::SlottedSpinLock::unlock_all" ref="a33943a61b8288cca50a3aef83c569d84" args="()" -->
 
208
<div class="memitem">
 
209
<div class="memproto">
 
210
      <table class="memname">
 
211
        <tr>
 
212
          <td class="memname">void <a class="el" href="classkyotocabinet_1_1SlottedSpinLock.html#a33943a61b8288cca50a3aef83c569d84">kyotocabinet::SlottedSpinLock::unlock_all</a> </td>
 
213
          <td>(</td>
 
214
          <td class="paramname"></td><td>)</td>
 
215
          <td></td>
 
216
        </tr>
 
217
      </table>
 
218
</div>
 
219
<div class="memdoc">
 
220
 
 
221
<p>Release the locks of all slots. </p>
 
222
 
 
223
</div>
 
224
</div>
 
225
</div><!-- contents -->
 
226
 
 
227
 
 
228
<hr class="footer"/><address class="footer"><small>
 
229
Generated on Fri May 25 2012 01:21:36 for Kyoto Cabinet by &#160;<a href="http://www.doxygen.org/index.html">
 
230
<img class="footer" src="doxygen.png" alt="doxygen"/>
 
231
</a> 1.7.6.1
 
232
</small></address>
 
233
 
 
234
</body>
 
235
</html>