<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>dmlite: include/dmlite/c/dmlite.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">dmlite
 <span id="projectnumber">0.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_c6836824bdef15bafab59627cccf2d55.html">dmlite</a></li><li class="navelem"><a class="el" href="dir_d445b4083d3c7359781dc9ee11dbbc0e.html">c</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">dmlite.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="dmlite_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/** @file include/dmlite/c/dmlite.h</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @brief C wrapper for DMLite</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @author Alejandro Álvarez Ayllon <aalvarez@cern.ch></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#ifndef DMLITE_DMLITE_H</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor"></span><span class="preprocessor">#define DMLITE_DMLITE_H</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../common/config.h"</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "../common/errno.h"</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "<a class="code" href="any_8h.html" title="Opaque handler to pass different types of values to the API.">any.h</a>"</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <stdlib.h></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <sys/stat.h></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <utime.h></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/** @brief Handle for the plugin manager. */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c"> 21</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c" title="Handle for the plugin manager.">dmlite_manager</a> <a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c" title="Handle for the plugin manager.">dmlite_manager</a>;<span class="comment"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/** @brief Handle for a initialized context. */</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f"> 23</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a> <a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/** @brief Security credentials</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @details It is up to the caller to allocate and free this pointers.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * DMLite will keep a copy internaly.</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * Non used values MUST be NULL.</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="code" href="structdmlite__credentials.html"> 30</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structdmlite__credentials.html" title="Security credentials.">dmlite_credentials</a> {</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="code" href="structdmlite__credentials.html#a286d7c8b77486232535885b2de432c7f"> 31</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structdmlite__credentials.html#a286d7c8b77486232535885b2de432c7f">mech</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="structdmlite__credentials.html#a7d1f76bd2b9d060c97643877faf7b373"> 32</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structdmlite__credentials.html#a7d1f76bd2b9d060c97643877faf7b373">client_name</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="code" href="structdmlite__credentials.html#a2aaedbf09ed4be25e291d03ba30f5edd"> 33</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structdmlite__credentials.html#a2aaedbf09ed4be25e291d03ba30f5edd">remote_address</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="code" href="structdmlite__credentials.html#a65817fd0c325d2dcc70e77d184b3a90e"> 34</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structdmlite__credentials.html#a65817fd0c325d2dcc70e77d184b3a90e">session_id</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="code" href="structdmlite__credentials.html#a0aa50496115e120dfdc5a045942ee03f"> 36</a></span>  <span class="keywordtype">unsigned</span> <a class="code" href="structdmlite__credentials.html#a0aa50496115e120dfdc5a045942ee03f">nfqans</a>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="structdmlite__credentials.html#a76ef3b263cc9ba95400a844112e55fd5"> 37</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>** <a class="code" href="structdmlite__credentials.html#a76ef3b263cc9ba95400a844112e55fd5">fqans</a>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="structdmlite__credentials.html#a20a3490deaae248dcd5ca7d907e3f5ee"> 39</a></span>  <a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key->value pairs.">dmlite_any_dict</a>* <a class="code" href="structdmlite__credentials.html#a20a3490deaae248dcd5ca7d907e3f5ee">extra</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> } <a class="code" href="dmlite_8h.html#adb1c991ebb19cb9146be886cc58ef9ec" title="Security credentials.">dmlite_credentials</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">/** @brief Used to handle user and group information</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="structdmlite__security__ent.html"> 44</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structdmlite__security__ent.html" title="Used to handle user and group information.">dmlite_security_ent</a> {</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="structdmlite__security__ent.html#ab133d824dcf0baa4e6038e7748bd0a84"> 45</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structdmlite__security__ent.html#ab133d824dcf0baa4e6038e7748bd0a84">name</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="structdmlite__security__ent.html#ab1fadd51416ddbb77abfe63a0579dacb"> 46</a></span>  <a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key->value pairs.">dmlite_any_dict</a>* <a class="code" href="structdmlite__security__ent.html#ab1fadd51416ddbb77abfe63a0579dacb">extra</a>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> } <a class="code" href="dmlite_8h.html#a7ab16df6780bbca4b8941574f74ea6de" title="Used to handle user and group information.">dmlite_security_ent</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">/** @brief Security context </span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="code" href="structdmlite__security__context.html"> 51</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structdmlite__security__context.html" title="Security context.">dmlite_security_context</a> {</div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="structdmlite__security__context.html#ac7c6bad48fe43a8c30498cc5c864b649"> 52</a></span>  <a class="code" href="structdmlite__credentials.html" title="Security credentials.">dmlite_credentials</a>* <a class="code" href="structdmlite__security__context.html#ac7c6bad48fe43a8c30498cc5c864b649">credentials</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="code" href="structdmlite__security__context.html#a23d1b1aee932108ea6e7c33191a4c276"> 54</a></span>  <span class="keywordtype">unsigned</span> <a class="code" href="structdmlite__security__context.html#a23d1b1aee932108ea6e7c33191a4c276">ngroups</a>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="structdmlite__security__context.html#ae95d406a7640ed656a97f23d0fefae53"> 55</a></span>  <a class="code" href="structdmlite__security__ent.html" title="Used to handle user and group information.">dmlite_security_ent</a> <a class="code" href="structdmlite__security__context.html#ae95d406a7640ed656a97f23d0fefae53">user</a>; </div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="code" href="structdmlite__security__context.html#a8226939acae4b30179bf770fec71ac7c"> 56</a></span>  <a class="code" href="structdmlite__security__ent.html" title="Used to handle user and group information.">dmlite_security_ent</a>* <a class="code" href="structdmlite__security__context.html#a8226939acae4b30179bf770fec71ac7c">groups</a>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> } <a class="code" href="dmlite_8h.html#a8543eab14c44e797ae1dc4f4a9e6e03c" title="Security context.">dmlite_security_context</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * @brief Gets the API version.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">unsigned</span> <a class="code" href="dmlite_8h.html#a902972b0dca1a65635df1b22807b6815" title="Gets the API version.">dmlite_api_version</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @brief Initializes a dmlite_manager.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * @return NULL on failure.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c" title="Handle for the plugin manager.">dmlite_manager</a>* <a class="code" href="dmlite_8h.html#a15f3bcd947b3e6e986bec8e057cabbcb" title="Initializes a dmlite_manager.">dmlite_manager_new</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * @brief Destroys the manager.</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @param manager The manager to be destroyed.</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#a0806281d24da7e2d8cca536658720b37" title="Destroys the manager.">dmlite_manager_free</a>(<a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c" title="Handle for the plugin manager.">dmlite_manager</a>* manager);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * @brief Loads a library.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @param manager The plugin manager.</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * @param lib The .so file. Usually, (path)/plugin_name.so.</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * @param id The plugin ID. Usually, plugin_name.</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#aee86270e504a42b242c435eba8bcbffb" title="Loads a library.">dmlite_manager_load_plugin</a>(<a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c" title="Handle for the plugin manager.">dmlite_manager</a> *manager, <span class="keyword">const</span> <span class="keywordtype">char</span>* lib, <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keywordtype">id</span>);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"></span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * @brief Sets a configuration parameter.</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * @param manager The plugin manager.</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @param key The parameter to set.</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * @param value The value.</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#a0878664d702beae061c60cedae8942d2" title="Sets a configuration parameter.">dmlite_manager_set</a>(<a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c" title="Handle for the plugin manager.">dmlite_manager</a>* manager, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* value);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * @brief Loads a configuration file.</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * @param manager The plugin manager.</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @param file The configuration file</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#a06e73e1c3b5f87f2aaf1e498e617742c" title="Loads a configuration file.">dmlite_manager_load_configuration</a>(<a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c" title="Handle for the plugin manager.">dmlite_manager</a>* manager, <span class="keyword">const</span> <span class="keywordtype">char</span>* file);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @brief Returns the associated value with the given key.</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @param manager The plugin manager.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @param key The configuration parameter.</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @param buffer Where to leave the string.</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @param bufsize The buffer size.</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#ac0e7b79b9047a962a7221493dfe640bb" title="Returns the associated value with the given key.">dmlite_manager_get</a>(<a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c" title="Handle for the plugin manager.">dmlite_manager</a>* handle, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">char</span>* buffer, <span class="keywordtype">size_t</span> bufsize);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"></span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * @brief Returns the last error code.</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * @param manager The plugin manager used in the failing function.</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * @return The last error code, WITHOUT the error type byte.</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#aeaec92bf5a2c09bbae425577f89cc17b" title="Returns the last error code.">dmlite_manager_errno</a>(<a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c" title="Handle for the plugin manager.">dmlite_manager</a>* manager);</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"></span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @brief Returns the type of the last error.</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * @param manager The plugin manager used in the failing function.</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @return The last error type byte.</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#a5d8ccd27f0ea12358039e331f59927c8" title="Returns the type of the last error.">dmlite_manager_errtype</a>(<a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c" title="Handle for the plugin manager.">dmlite_manager</a>* manager);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"></span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * @brief Returns the string that describes the last error.</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * @param manager The plugin manager used in the failing function.</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * @return A pointer to the error string. Do NOT free it.</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="dmlite_8h.html#a53822fa7340a952d67398c62d5d3347b" title="Returns the string that describes the last error.">dmlite_manager_error</a>(<a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c" title="Handle for the plugin manager.">dmlite_manager</a>* manager);</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"></span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * @brief Returns a usable context from the loaded libraries.</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * @param manager The plugin manager.</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * @return NULL on failure. The error code can be checked with dmlite_manager_error.</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * @note A context is NOT thread safe.</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* <a class="code" href="dmlite_8h.html#a569c27f0c0506101bed76ebeb2571101" title="Returns a usable context from the loaded libraries.">dmlite_context_new</a>(<a class="code" href="dmlite_8h.html#a88805b43446040e573261415b7eb194c" title="Handle for the plugin manager.">dmlite_manager</a>* manager);</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"></span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * @brief Destroys the context.</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * @param context The context to free.</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#a5198afb88407b957fa6e8483fd9ea93f" title="Destroys the context.">dmlite_context_free</a>(<a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* context);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"></span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * @brief Returns the error code from the last failure.</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * @param context The context that was used in the failed function.</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * @return The error code.</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#af8ba66f78e926ece406f78f81a73e678" title="Returns the error code from the last failure.">dmlite_errno</a>(<a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* context);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"></span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * @brief Returns the type of the last error.</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @param context The context that was used in the failed function.</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @return The error type.</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#ab463b81242b4f48e4f995bfe4545f47a" title="Returns the type of the last error.">dmlite_errtype</a>(<a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* context);</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"></span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * @brief Error string from the last failed function.</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * @param context The context that was used in the failed function.</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * @return A string with the error description. Do NOT free it.</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="dmlite_8h.html#a041d86c686f6fef3f6ac3f7bfc2e4b5a" title="Error string from the last failed function.">dmlite_error</a>(<a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* context);</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"></span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * @brief Sets the user security credentials.</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * @param context The DM context.</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * @param cred The security credentials.</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#a13a75a915cb8624069f135f798b70e0a" title="Sets the user security credentials.">dmlite_setcredentials</a>(<a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* context, <span class="keyword">const</span> <a class="code" href="structdmlite__credentials.html" title="Security credentials.">dmlite_credentials</a>* cred);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"></span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * @brief Returns the security context. There is no need to free.</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * @param context The DM context.</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * @return The security context.</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="keyword">const</span> <a class="code" href="structdmlite__security__context.html" title="Security context.">dmlite_security_context</a>* <a class="code" href="dmlite_8h.html#a2b3970ed5fbf28a748e420cc1900790a" title="Returns the security context. There is no need to free.">dmlite_get_security_context</a>(<a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* context);</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"></span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * @brief Sets a configuration parameter tied to a context.</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * @details This can be used to pass advanced parameters to a plugin.</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * @param context The DM context.</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * @param k The configuration key.</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * @param v Value.</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#aa11bd1749cd1486d36c677db40078855" title="Sets a configuration parameter tied to a context.">dmlite_set</a>(<a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* context, <span class="keyword">const</span> <span class="keywordtype">char</span>* k, <span class="keyword">const</span> <a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* v);</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"></span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> * @brief Sets a configuration parameter tied to a context (array version).</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * @param context The DM context.</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * @param k The configuration key.</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * @param n The configuration key.</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * @param v Array of values.</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#aa6910031b5d438636bac75a62f5b59ac" title="Sets a configuration parameter tied to a context (array version).">dmlite_set_array</a>(<a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* context, <span class="keyword">const</span> <span class="keywordtype">char</span>* k,</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keywordtype">unsigned</span> n, <a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* <span class="keyword">const</span>* v);</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"></span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> * @brief Removes a configuration parameter.</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * @param context The DM context.</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * @param k The configuration key.</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#a3544ddf1c3b1b05fb4d4c0449f5af5a3" title="Removes a configuration parameter.">dmlite_unset</a>(<a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* context, <span class="keyword">const</span> <span class="keywordtype">char</span>* k);</div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"></span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * @brief Removes all configuration parameters previously set.</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * @param context The DM context.</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="keywordtype">int</span> <a class="code" href="dmlite_8h.html#ab55240b83dd066ebc57f9457b878b3af" title="Removes all configuration parameters previously set.">dmlite_unset_all</a>(<a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* context);</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> </div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="preprocessor">#endif </span><span class="comment">/* DMLITE_DMLITE_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jul 12 2013 07:34:22 for dmlite by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
