1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libcontextsubscriber: CDBWriter 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.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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>
<div class="contents">
<h1>CDBWriter Class Reference</h1><!-- doxytag: class="CDBWriter" -->A wrapper class to write data (create) tiny-cdb databases.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cdbwriter_8h-source.html">cdbwriter.h</a>></code>
<p>
<p>
<a href="class_c_d_b_writer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#e40a943a3cf86d6ca9b5350357d83a74">CDBWriter</a> (const QString &path, QObject *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="class_c_d_b_writer.html" title="A wrapper class to write data (create) tiny-cdb databases.">CDBWriter</a> to write to a cdb database at <em>dbpath</em>. <a href="#e40a943a3cf86d6ca9b5350357d83a74"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#e9ca0bb62aa913a150b988b3bf6c9bad">CDBWriter</a> (int <a class="el" href="class_c_d_b_writer.html#db50416b86fe2dcb95ec16e9a5bdc6ea">fd</a>, QObject *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="class_c_d_b_writer.html" title="A wrapper class to write data (create) tiny-cdb databases.">CDBWriter</a> to write to a cdb database at a file descriptor <em>fd</em>. <a href="#e9ca0bb62aa913a150b988b3bf6c9bad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#e8f20236cbe613623d71af092d0aeaf6">~CDBWriter</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the object closing the file beforehand. <a href="#e8f20236cbe613623d71af092d0aeaf6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#7badfc7cd1c94ef07a3c630c0f0bd0fb">add</a> (const QString &key, const QVariant &val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a new <em>key</em> with <em>val</em> to the database. <a href="#7badfc7cd1c94ef07a3c630c0f0bd0fb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#3c54b531d448d33660b7d089118dfd4c">insert</a> (const QString &key, const QVariant &val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a new <em>key</em> with <em>val</em> to the database. <a href="#3c54b531d448d33660b7d089118dfd4c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#ee735f7f3c2540e8dfe180bc2775dfb5">replace</a> (const QString &key, const QVariant &val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Insert a new <em>key</em> with <em>val</em> to the database. <a href="#ee735f7f3c2540e8dfe180bc2775dfb5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#8de500cd2916cca7709862624fd52728">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the writer and the underlying filesystem resource for writing. <a href="#8de500cd2916cca7709862624fd52728"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#aa1e44ad6f40ffb7de3a2ad2d361cd62">isWritable</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <em>true</em> if the writer is writable. <a href="#aa1e44ad6f40ffb7de3a2ad2d361cd62"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#2ff2ca31100e94d445741e80dcddfee0">fileDescriptor</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the file descriptor used by the writer. <a href="#2ff2ca31100e94d445741e80dcddfee0"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#cb6cbc68cd6370bbdbeb0f08163dbca5">put</a> (const QString &key, const QVariant &val, int flag)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Puts a new <em>key</em> with value <em>val</em> into the database. <a href="#cb6cbc68cd6370bbdbeb0f08163dbca5"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#142d82fc35b3ad495588ad2299cb5f2b">cdbm</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A cdb library structure used to read data. <a href="#142d82fc35b3ad495588ad2299cb5f2b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#db50416b86fe2dcb95ec16e9a5bdc6ea">fd</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A file descriptor pointing to the database. <a href="#db50416b86fe2dcb95ec16e9a5bdc6ea"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A wrapper class to write data (create) tiny-cdb databases.
<p>
This class is not a part of the public API. The writer operates on string-qvariant pairs. QVariant values can be associated with string keys. Several operations are supported - adding, replacing and inserting. Those operations differ in how they handle existing keys with same name.<p>
The writer automatically cloes the filesystem resource on destruction but can be also closed manually. Writing to a closed writer has no effect. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e40a943a3cf86d6ca9b5350357d83a74"></a><!-- doxytag: member="CDBWriter::CDBWriter" ref="e40a943a3cf86d6ca9b5350357d83a74" args="(const QString &path, QObject *parent=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CDBWriter::CDBWriter </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QObject * </td>
<td class="paramname"> <em>parent</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs a new <a class="el" href="class_c_d_b_writer.html" title="A wrapper class to write data (create) tiny-cdb databases.">CDBWriter</a> to write to a cdb database at <em>dbpath</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dbpath</em> </td><td>Path to the database. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e9ca0bb62aa913a150b988b3bf6c9bad"></a><!-- doxytag: member="CDBWriter::CDBWriter" ref="e9ca0bb62aa913a150b988b3bf6c9bad" args="(int fd, QObject *parent=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CDBWriter::CDBWriter </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>fdd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QObject * </td>
<td class="paramname"> <em>parent</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs a new <a class="el" href="class_c_d_b_writer.html" title="A wrapper class to write data (create) tiny-cdb databases.">CDBWriter</a> to write to a cdb database at a file descriptor <em>fd</em>.
<p>
You should not manipulate the <em>fd</em> after calling this function. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fd</em> </td><td>An open file descriptor. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e8f20236cbe613623d71af092d0aeaf6"></a><!-- doxytag: member="CDBWriter::~CDBWriter" ref="e8f20236cbe613623d71af092d0aeaf6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CDBWriter::~CDBWriter </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroys the object closing the file beforehand.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7badfc7cd1c94ef07a3c630c0f0bd0fb"></a><!-- doxytag: member="CDBWriter::add" ref="7badfc7cd1c94ef07a3c630c0f0bd0fb" args="(const QString &key, const QVariant &val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CDBWriter::add </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a new <em>key</em> with <em>val</em> to the database.
<p>
If a value for this key already exists, another one is added. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key name as string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>Value as string. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8de500cd2916cca7709862624fd52728"></a><!-- doxytag: member="CDBWriter::close" ref="8de500cd2916cca7709862624fd52728" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CDBWriter::close </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Closes the writer and the underlying filesystem resource for writing.
<p>
</div>
</div><p>
<a class="anchor" name="2ff2ca31100e94d445741e80dcddfee0"></a><!-- doxytag: member="CDBWriter::fileDescriptor" ref="2ff2ca31100e94d445741e80dcddfee0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CDBWriter::fileDescriptor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the file descriptor used by the writer.
<p>
Returns 0 when the writer is closed.
</div>
</div><p>
<a class="anchor" name="3c54b531d448d33660b7d089118dfd4c"></a><!-- doxytag: member="CDBWriter::insert" ref="3c54b531d448d33660b7d089118dfd4c" args="(const QString &key, const QVariant &val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CDBWriter::insert </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Insert a new <em>key</em> with <em>val</em> to the database.
<p>
If a value for this key already exists, nothing is done. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key name as string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>Value as string. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="aa1e44ad6f40ffb7de3a2ad2d361cd62"></a><!-- doxytag: member="CDBWriter::isWritable" ref="aa1e44ad6f40ffb7de3a2ad2d361cd62" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CDBWriter::isWritable </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns <em>true</em> if the writer is writable.
<p>
The writer is not writable after it has been closed or the target path is not accessible.
</div>
</div><p>
<a class="anchor" name="cb6cbc68cd6370bbdbeb0f08163dbca5"></a><!-- doxytag: member="CDBWriter::put" ref="cb6cbc68cd6370bbdbeb0f08163dbca5" args="(const QString &key, const QVariant &val, int flag)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CDBWriter::put </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"> <em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>flag</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Puts a new <em>key</em> with value <em>val</em> into the database.
<p>
Depending on the <em>flag</em> the key is added, inserted or replaced. The public methods of this class are wrapperes of this method with proper flags.
</div>
</div><p>
<a class="anchor" name="ee735f7f3c2540e8dfe180bc2775dfb5"></a><!-- doxytag: member="CDBWriter::replace" ref="ee735f7f3c2540e8dfe180bc2775dfb5" args="(const QString &key, const QVariant &val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CDBWriter::replace </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Insert a new <em>key</em> with <em>val</em> to the database.
<p>
If a value for this key already exists, the old value is replaced with the new one. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key name as string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>Value as string. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="142d82fc35b3ad495588ad2299cb5f2b"></a><!-- doxytag: member="CDBWriter::cdbm" ref="142d82fc35b3ad495588ad2299cb5f2b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="class_c_d_b_writer.html#142d82fc35b3ad495588ad2299cb5f2b">CDBWriter::cdbm</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A cdb library structure used to read data.
<p>
</div>
</div><p>
<a class="anchor" name="db50416b86fe2dcb95ec16e9a5bdc6ea"></a><!-- doxytag: member="CDBWriter::fd" ref="db50416b86fe2dcb95ec16e9a5bdc6ea" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_c_d_b_writer.html#db50416b86fe2dcb95ec16e9a5bdc6ea">CDBWriter::fd</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A file descriptor pointing to the database.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="cdbwriter_8h-source.html">cdbwriter.h</a><li><a class="el" href="cdbwriter_8cpp.html">cdbwriter.cpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 30 10:24:18 2009 for libcontextsubscriber by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
|
