<!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>Elektra Projekt: KDB Backends :: KDB access functions</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="modules.html"><span>Modules</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>KDB Backends :: KDB access functions</h1>
<p>Methods to access the backend handle.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__backendhandle.html#ga97fab712e488c7ec3e198492106724ab">kdbhSetBackendData</a> (KDB *handle, void *data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__backendhandle.html#gae463be8651422015fd12811ed66d20f3">kdbhGetBackendData</a> (const KDB *handle)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">KDBCap * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__backendhandle.html#gad077fae396d9be2b9d5e01b6f9f60318">kdbhSetCapability</a> (KDB *handle, KDBCap *cap)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">KDBCap * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__backendhandle.html#ga090cfa7483afbb159b75c975eb1d513c">kdbhGetCapability</a> (const KDB *handle)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Trie * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__backendhandle.html#ga591d15bf10d8f4366ec7e1e9b8c6ddc7">kdbhGetTrie</a> (const KDB *handle)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__backendhandle.html#ga1c5c086715963f34f2a88fac89b62f82">kdbhSetTrie</a> (KDB *handle, Trie *trie)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const Key * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__backendhandle.html#ga8b5612940fc9bc56e99c15ecc427cbb2">kdbhGetMountpoint</a> (KDB *handle)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__backendhandle.html#ga65c8878c24776c77716ac9e8abe1a29f">kdbhSetMountpoint</a> (KDB *handle, const Key *mountpoint)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">KeySet * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__backendhandle.html#gab14dc8708c2ae4ffcba6cfb130019115">kdbhGetConfig</a> (KDB *handle)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Methods to access the backend handle. </p>
<p>To use them: </p>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include <kdb.h></span>
</pre></div><p>These functions provide access to the information stored in Backend Handles. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gae463be8651422015fd12811ed66d20f3"></a><!-- doxytag: member="kdbhandle.c::kdbhGetBackendData" ref="gae463be8651422015fd12811ed66d20f3" args="(const KDB *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* kdbhGetBackendData </td>
<td>(</td>
<td class="paramtype">const KDB * </td>
<td class="paramname"> <em>handle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the previously set backend-specific <code>data</code> from the <code>handle</code>.</p>
<p>This is useful when your backend have a backend-global context or environment.</p>
<p>This method will probably be called everytime one of your kdb*() implementations is called. And if you change something inside the data, you don't have to <a class="el" href="group__backendhandle.html#ga97fab712e488c7ec3e198492106724ab">kdbhSetBackendData()</a> again, bacause you are manipulating your data, and not a copy of it.</p>
<dl class="user"><dt><b>Example:</b></dt><dd><div class="fragment"><pre class="fragment"><span class="keyword">struct </span>MyBackendData {
<span class="keywordtype">int</span> context1;
<span class="keywordtype">int</span> context2;
};
<span class="keywordtype">int</span> kdbOpen_mybackend(KDB *handle) {
<span class="keyword">struct </span>MyBackendData *context;
context=malloc(<span class="keyword">sizeof</span>(<span class="keyword">struct</span> MyBackendData));
<span class="comment">// a random initialization...</span>
context->context1=1;
context->context2=2;
<a class="code" href="group__backendhandle.html#ga97fab712e488c7ec3e198492106724ab">kdbhSetBackendData</a>(*handle,context);
<span class="keywordflow">return</span> 0;
}
<span class="keywordtype">int</span> kdbGetKey_maybackend(KDB handle) {
<span class="keyword">struct </span>MyBackendData *context;
context=<a class="code" href="group__backendhandle.html#gae463be8651422015fd12811ed66d20f3">kdbhGetBackendData</a>(handle);
<span class="comment">// No do something with the context</span>
. . .
<span class="keywordflow">return</span> 0;
}
</pre></div></dd></dl>
<p>On the <a class="el" href="group__kdb.html#gad9bb8bd3f1296bfa77cc9a1b41b7a859">kdbClose()</a> implementation of your backend, you must remember to free all resources associated to your data.</p>
<dl class="user"><dt><b>Example of kdbClose() implementation that correctly cleans the context:</b></dt><dd><div class="fragment"><pre class="fragment"><span class="keywordtype">int</span> kdbClose_mybackend(KDB &handle) {
<span class="keyword">struct </span>MyBackendData *context;
context=<a class="code" href="group__backendhandle.html#gae463be8651422015fd12811ed66d20f3">kdbhGetBackendData</a>(handle);
free(context);
<span class="keywordflow">return</span> 0;
}
</pre></div> </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the data previously set be <a class="el" href="group__backendhandle.html#ga97fab712e488c7ec3e198492106724ab">kdbhSetBackendData()</a> </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>contains internal information of <a class="el" href="group__kdb.html#gab7be60c387892d2235907836c5060e1f">opened </a> key database </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga090cfa7483afbb159b75c975eb1d513c"></a><!-- doxytag: member="kdbhandle.c::kdbhGetCapability" ref="ga090cfa7483afbb159b75c975eb1d513c" args="(const KDB *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KDBCap* kdbhGetCapability </td>
<td>(</td>
<td class="paramtype">const KDB * </td>
<td class="paramname"> <em>handle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets capability for handle.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>contains internal information of <a class="el" href="group__kdb.html#gab7be60c387892d2235907836c5060e1f">opened </a> key database </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The backend name set in <code>handle</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="gab14dc8708c2ae4ffcba6cfb130019115"></a><!-- doxytag: member="kdbhandle.c::kdbhGetConfig" ref="gab14dc8708c2ae4ffcba6cfb130019115" args="(KDB *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KeySet* kdbhGetConfig </td>
<td>(</td>
<td class="paramtype">KDB * </td>
<td class="paramname"> <em>handle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns configuration for handle.</p>
<p>Every backend may have its own configuration using a Keyset.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>contains internal information of <a class="el" href="group__kdb.html#gab7be60c387892d2235907836c5060e1f">opened </a> key database </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the keyset containing configuration for a backend </dd></dl>
</div>
</div>
<a class="anchor" id="ga8b5612940fc9bc56e99c15ecc427cbb2"></a><!-- doxytag: member="kdbhandle.c::kdbhGetMountpoint" ref="ga8b5612940fc9bc56e99c15ecc427cbb2" args="(KDB *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const Key* kdbhGetMountpoint </td>
<td>(</td>
<td class="paramtype">KDB * </td>
<td class="paramname"> <em>handle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets mountpoint for handle.</p>
<p>Every mounted backend has a specific mountpoint where it is mounted. You may need to know where you were mounted inside a backend to calculate relative pathes.</p>
<p>The <a class="el" href="group__keyname.html#ga8e805c726a60da921d3736cda7813513">keyName()</a> is where the backend is mounted, keyString() gives the name of which backend is mounted.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>contains internal information of <a class="el" href="group__kdb.html#gab7be60c387892d2235907836c5060e1f">opened </a> key database </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__backendhandle.html#ga65c8878c24776c77716ac9e8abe1a29f">kdbhSetMountpoint()</a> </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The Key containing the mountpoint. </dd></dl>
</div>
</div>
<a class="anchor" id="ga591d15bf10d8f4366ec7e1e9b8c6ddc7"></a><!-- doxytag: member="kdbhandle.c::kdbhGetTrie" ref="ga591d15bf10d8f4366ec7e1e9b8c6ddc7" args="(const KDB *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Trie* kdbhGetTrie </td>
<td>(</td>
<td class="paramtype">const KDB * </td>
<td class="paramname"> <em>handle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets trie for handle.</p>
<p>The trie is a datastructure containing the mounted backends.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>contains internal information of <a class="el" href="group__kdb.html#gab7be60c387892d2235907836c5060e1f">opened </a> key database </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__backendhandle.html#ga1c5c086715963f34f2a88fac89b62f82">kdbhSetTrie()</a> </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The backend name set in <code>handle</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga97fab712e488c7ec3e198492106724ab"></a><!-- doxytag: member="kdbhandle.c::kdbhSetBackendData" ref="ga97fab712e488c7ec3e198492106724ab" args="(KDB *handle, void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* kdbhSetBackendData </td>
<td>(</td>
<td class="paramtype">KDB * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set some backend-specific <code>data</code> in the <code>handle</code>.</p>
<p>This is useful when your backend have a backend-global context or environment.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>contains internal information of <a class="el" href="group__kdb.html#gab7be60c387892d2235907836c5060e1f">opened </a> key database </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>a pointer to general data specific to a backend implementation. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__backendhandle.html#gae463be8651422015fd12811ed66d20f3">kdbhGetBackendData()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad077fae396d9be2b9d5e01b6f9f60318"></a><!-- doxytag: member="kdbhandle.c::kdbhSetCapability" ref="gad077fae396d9be2b9d5e01b6f9f60318" args="(KDB *handle, KDBCap *cap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KDBCap* kdbhSetCapability </td>
<td>(</td>
<td class="paramtype">KDB * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">KDBCap * </td>
<td class="paramname"> <em>cap</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets capabilty for handle.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cap</em> </td><td>a pointer to capability structure </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>contains internal information of <a class="el" href="group__kdb.html#gab7be60c387892d2235907836c5060e1f">opened </a> key database </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The backend name set in <code>handle</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga65c8878c24776c77716ac9e8abe1a29f"></a><!-- doxytag: member="kdbhandle.c::kdbhSetMountpoint" ref="ga65c8878c24776c77716ac9e8abe1a29f" args="(KDB *handle, const Key *mountpoint)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kdbhSetMountpoint </td>
<td>(</td>
<td class="paramtype">KDB * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Key * </td>
<td class="paramname"> <em>mountpoint</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets mountpoint for handle.</p>
<p>You must not change the mountpoint inside your backend, it was set correctly already for you.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>contains internal information of <a class="el" href="group__kdb.html#gab7be60c387892d2235907836c5060e1f">opened </a> key database </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mountpoint</em> </td><td>the key containing as name where backend is mounted and as value the backendname </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__backendhandle.html#ga8b5612940fc9bc56e99c15ecc427cbb2">kdbhGetMountpoint()</a> </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>nothing </dd></dl>
</div>
</div>
<a class="anchor" id="ga1c5c086715963f34f2a88fac89b62f82"></a><!-- doxytag: member="kdbhandle.c::kdbhSetTrie" ref="ga1c5c086715963f34f2a88fac89b62f82" args="(KDB *handle, Trie *trie)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kdbhSetTrie </td>
<td>(</td>
<td class="paramtype">KDB * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Trie * </td>
<td class="paramname"> <em>trie</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets trie for handle.</p>
<p>The trie is a datastructure containing the mounted backends. This must not done inside backends, it was set correctly already for you.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>contains internal information of <a class="el" href="group__kdb.html#gab7be60c387892d2235907836c5060e1f">opened </a> key database </td></tr>
<tr><td valign="top"></td><td valign="top"><em>trie</em> </td><td>the datastructure referencing to the other handles of backends </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__backendhandle.html#ga591d15bf10d8f4366ec7e1e9b8c6ddc7">kdbhGetTrie()</a> </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>nothing </dd></dl>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 8 Nov 2009 for Elektra Projekt 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>
