diff options
Diffstat (limited to 'libcontextsubscriber/doc/html/class_c_d_b_writer.html')
| -rw-r--r-- | libcontextsubscriber/doc/html/class_c_d_b_writer.html | 409 |
1 files changed, 409 insertions, 0 deletions
diff --git a/libcontextsubscriber/doc/html/class_c_d_b_writer.html b/libcontextsubscriber/doc/html/class_c_d_b_writer.html new file mode 100644 index 00000000..f23f2045 --- /dev/null +++ b/libcontextsubscriber/doc/html/class_c_d_b_writer.html @@ -0,0 +1,409 @@ +<!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>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.6.1 --> +<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" --> +<p>A wrapper class to write data (create) tiny-cdb databases. +<a href="#_details">More...</a></p> + +<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></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="class_c_d_b_writer.html#ae40a943a3cf86d6ca9b5350357d83a74">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="#ae40a943a3cf86d6ca9b5350357d83a74"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#ae9ca0bb62aa913a150b988b3bf6c9bad">CDBWriter</a> (int <a class="el" href="class_c_d_b_writer.html#adb50416b86fe2dcb95ec16e9a5bdc6ea">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="#ae9ca0bb62aa913a150b988b3bf6c9bad"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#ae8f20236cbe613623d71af092d0aeaf6">~CDBWriter</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the object closing the file beforehand. <a href="#ae8f20236cbe613623d71af092d0aeaf6"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#a7badfc7cd1c94ef07a3c630c0f0bd0fb">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="#a7badfc7cd1c94ef07a3c630c0f0bd0fb"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#a3c54b531d448d33660b7d089118dfd4c">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="#a3c54b531d448d33660b7d089118dfd4c"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#aee735f7f3c2540e8dfe180bc2775dfb5">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="#aee735f7f3c2540e8dfe180bc2775dfb5"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#a8de500cd2916cca7709862624fd52728">close</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the writer and the underlying filesystem resource for writing. <a href="#a8de500cd2916cca7709862624fd52728"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#aaa1e44ad6f40ffb7de3a2ad2d361cd62">isWritable</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <em>true</em> if the writer is writable. <a href="#aaa1e44ad6f40ffb7de3a2ad2d361cd62"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#a2ff2ca31100e94d445741e80dcddfee0">fileDescriptor</a> () const </td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the file descriptor used by the writer. <a href="#a2ff2ca31100e94d445741e80dcddfee0"></a><br/></td></tr> +<tr><td colspan="2"><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#acb6cbc68cd6370bbdbeb0f08163dbca5">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="#acb6cbc68cd6370bbdbeb0f08163dbca5"></a><br/></td></tr> +<tr><td colspan="2"><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#a142d82fc35b3ad495588ad2299cb5f2b">cdbm</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">A cdb library structure used to read data. <a href="#a142d82fc35b3ad495588ad2299cb5f2b"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_writer.html#adb50416b86fe2dcb95ec16e9a5bdc6ea">fd</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">A file descriptor pointing to the database. <a href="#adb50416b86fe2dcb95ec16e9a5bdc6ea"></a><br/></td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>A wrapper class to write data (create) tiny-cdb databases. </p> +<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> +<p>The writer automatically cloes the filesystem resource on destruction but can be also closed manually. Writing to a closed writer has no effect. </p> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="ae40a943a3cf86d6ca9b5350357d83a74"></a><!-- doxytag: member="CDBWriter::CDBWriter" ref="ae40a943a3cf86d6ca9b5350357d83a74" 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><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> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ae9ca0bb62aa913a150b988b3bf6c9bad"></a><!-- doxytag: member="CDBWriter::CDBWriter" ref="ae9ca0bb62aa913a150b988b3bf6c9bad" 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> +<p>You should not manipulate the <em>fd</em> after calling this function. </p> +<dl><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> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ae8f20236cbe613623d71af092d0aeaf6"></a><!-- doxytag: member="CDBWriter::~CDBWriter" ref="ae8f20236cbe613623d71af092d0aeaf6" 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> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a7badfc7cd1c94ef07a3c630c0f0bd0fb"></a><!-- doxytag: member="CDBWriter::add" ref="a7badfc7cd1c94ef07a3c630c0f0bd0fb" 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> +<p>If a value for this key already exists, another one is added. </p> +<dl><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> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a8de500cd2916cca7709862624fd52728"></a><!-- doxytag: member="CDBWriter::close" ref="a8de500cd2916cca7709862624fd52728" 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> +<a class="anchor" id="a2ff2ca31100e94d445741e80dcddfee0"></a><!-- doxytag: member="CDBWriter::fileDescriptor" ref="a2ff2ca31100e94d445741e80dcddfee0" 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> +<p>Returns 0 when the writer is closed. </p> + +</div> +</div> +<a class="anchor" id="a3c54b531d448d33660b7d089118dfd4c"></a><!-- doxytag: member="CDBWriter::insert" ref="a3c54b531d448d33660b7d089118dfd4c" 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> +<p>If a value for this key already exists, nothing is done. </p> +<dl><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> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="aaa1e44ad6f40ffb7de3a2ad2d361cd62"></a><!-- doxytag: member="CDBWriter::isWritable" ref="aaa1e44ad6f40ffb7de3a2ad2d361cd62" 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> +<p>The writer is not writable after it has been closed or the target path is not accessible. </p> + +</div> +</div> +<a class="anchor" id="acb6cbc68cd6370bbdbeb0f08163dbca5"></a><!-- doxytag: member="CDBWriter::put" ref="acb6cbc68cd6370bbdbeb0f08163dbca5" 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> +<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. </p> + +</div> +</div> +<a class="anchor" id="aee735f7f3c2540e8dfe180bc2775dfb5"></a><!-- doxytag: member="CDBWriter::replace" ref="aee735f7f3c2540e8dfe180bc2775dfb5" 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> +<p>If a value for this key already exists, the old value is replaced with the new one. </p> +<dl><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> + </dd> +</dl> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="a142d82fc35b3ad495588ad2299cb5f2b"></a><!-- doxytag: member="CDBWriter::cdbm" ref="a142d82fc35b3ad495588ad2299cb5f2b" 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#a142d82fc35b3ad495588ad2299cb5f2b">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> +<a class="anchor" id="adb50416b86fe2dcb95ec16e9a5bdc6ea"></a><!-- doxytag: member="CDBWriter::fd" ref="adb50416b86fe2dcb95ec16e9a5bdc6ea" 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#adb50416b86fe2dcb95ec16e9a5bdc6ea">CDBWriter::fd</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>A file descriptor pointing to the database. </p> + +</div> +</div> +<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> +<li><a class="el" href="cdbwriter_8cpp.html">cdbwriter.cpp</a></li> +</ul> +</div> +<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Nov 27 10:23:11 2009 for libcontextsubscriber by +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> |