<!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/pool.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">pool.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="pool_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/pool.h</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @brief C wrapper for DMLite Pool API.</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_POOL_H</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor"></span><span class="preprocessor">#define DMLITE_POOL_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 "<a class="code" href="dmlite_8h.html" title="C wrapper for DMLite.">dmlite.h</a>"</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</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="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "<a class="code" href="inode_8h.html" title="C wrapper for DMLite INode API.">inode.h</a>"</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "<a class="code" href="utils_8h.html" title="C wrapper for DMLite utils.">utils.h</a>"</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="code" href="pool_8h.html#a9bb293dace047a8bbdb0d50656c0af28"> 13</a></span> <span class="preprocessor">#define POOL_TYPE_MAX 16</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="code" href="pool_8h.html#aedd2af8d5756c2202fa665cfcf530647"> 14</a></span> <span class="preprocessor"></span><span class="preprocessor">#define POOL_MAX 16</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor"></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 Pool data */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="code" href="structdmlite__pool.html"> 21</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structdmlite__pool.html" title="Pool data.">dmlite_pool</a> {</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="code" href="structdmlite__pool.html#a9582a33935df251c5d5acd125f0be769"> 22</a></span>  <span class="keywordtype">char</span> <a class="code" href="structdmlite__pool.html#a9582a33935df251c5d5acd125f0be769">pool_type</a>[<a class="code" href="pool_8h.html#a9bb293dace047a8bbdb0d50656c0af28">POOL_TYPE_MAX</a>];</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="code" href="structdmlite__pool.html#ab9fe6f7bef64da2759a75e94852c8447"> 23</a></span>  <span class="keywordtype">char</span> <a class="code" href="structdmlite__pool.html#ab9fe6f7bef64da2759a75e94852c8447">pool_name</a>[<a class="code" href="pool_8h.html#aedd2af8d5756c2202fa665cfcf530647">POOL_MAX</a>];</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="code" href="structdmlite__pool.html#aa496b057e065f9e6259b6314c948d4ef"> 25</a></span>  <a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key->value pairs.">dmlite_any_dict</a>* <a class="code" href="structdmlite__pool.html#aa496b057e065f9e6259b6314c948d4ef">extra</a>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> } <a class="code" href="pool_8h.html#a8954849071d3e6f0b1d232cd4b093094" title="Pool data.">dmlite_pool</a>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/** @brief Chunk of data */</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="structdmlite__chunk.html"> 29</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structdmlite__chunk.html" title="Chunk of data.">dmlite_chunk</a> {</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="code" href="structdmlite__chunk.html#ad6188185f6e485ca9a30102d5548e040"> 30</a></span>  off_t <a class="code" href="structdmlite__chunk.html#ad6188185f6e485ca9a30102d5548e040">offset</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="code" href="structdmlite__chunk.html#a95e2cfe8b8a5022f1b1e5bdb72821f4e"> 31</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structdmlite__chunk.html#a95e2cfe8b8a5022f1b1e5bdb72821f4e">size</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="structdmlite__chunk.html#a298b923b06e04c6381b053f5bbc9fd86"> 32</a></span>  <a class="code" href="structdmlite__url.html" title="Handles URL.">dmlite_url</a> <a class="code" href="structdmlite__chunk.html#a298b923b06e04c6381b053f5bbc9fd86">url</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> } <a class="code" href="pool_8h.html#afc65ec277b2f275d10ec2e2909ad0f06" title="Chunk of data.">dmlite_chunk</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/** @brief Collection of chunks that form a replica</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * @details On read, there may be duplicated chunks.</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="code" href="structdmlite__location.html"> 38</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structdmlite__location.html" title="Collection of chunks that form a replica.">dmlite_location</a> {</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="structdmlite__location.html#aa2d74f4ab09fba7f95ab5b82051ddbcc"> 39</a></span>  <a class="code" href="structdmlite__chunk.html" title="Chunk of data.">dmlite_chunk</a>* <a class="code" href="structdmlite__location.html#aa2d74f4ab09fba7f95ab5b82051ddbcc">chunks</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="structdmlite__location.html#afb2dd5b0bc8f55b3bc03bb06ba9c40c3"> 40</a></span>  <span class="keywordtype">unsigned</span> <a class="code" href="structdmlite__location.html#afb2dd5b0bc8f55b3bc03bb06ba9c40c3">nchunks</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> } <a class="code" href="pool_8h.html#ac28d19d4bb9d9ef82be72cb68b8b0486" title="Collection of chunks that form a replica.">dmlite_location</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></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"> 44</span> <span class="comment"> * @brief Gets the list of pools.</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * @param context The DM context.</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * @param nPools The number of pools.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * @param pools An array with the pools. <b>Use dmlite_freepools to free</b>.</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">int</span> <a class="code" href="pool_8h.html#aac2ad7754e53979b0960185ac52b6842" title="Gets the list of pools.">dmlite_getpools</a>(<a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* context, <span class="keywordtype">unsigned</span>* nPools, <a class="code" href="structdmlite__pool.html" title="Pool data.">dmlite_pool</a>** pools);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @brief Frees an array of pools.</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * @param nPools The number of pools in the array.</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @param pools The array to free.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">int</span> <a class="code" href="pool_8h.html#a3c606f570110ee659fdd342b6968ff61" title="Frees an array of pools.">dmlite_pools_free</a>(<span class="keywordtype">unsigned</span> nPools, <a class="code" href="structdmlite__pool.html" title="Pool data.">dmlite_pool</a>* pools);</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">/**</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @brief Gets a single replica (synchronous).</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * @param context The DM context.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * @param path The logical file name.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * @return A pointer to a dmlite_location struct, or NULL on error.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <a class="code" href="structdmlite__location.html" title="Collection of chunks that form a replica.">dmlite_location</a>* <a class="code" href="pool_8h.html#abb28a4b4b0bac3a77c8c0ac07497321c" title="Gets a single replica (synchronous).">dmlite_get</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>* path);</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> <span class="comment">/**</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * @brief Gets a single replica (synchronous).</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * @param context The DM context.</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * @param inode The file inode.</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @return A pointer to a dmlite_location struct, or NULL on error.</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> <a class="code" href="structdmlite__location.html" title="Collection of chunks that form a replica.">dmlite_location</a>* <a class="code" href="pool_8h.html#a22f23ac606effa915ccdd65cde465a36" title="Gets a single replica (synchronous).">dmlite_iget</a>(<a class="code" href="dmlite_8h.html#a77bae7cd641b2dcbd360749ec213887f" title="Handle for a initialized context.">dmlite_context</a>* context, ino_t inode);</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 Gets the location of a replica.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @param context The DM context.</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * @param replica The replica to translate.</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * @return A pointer to a dmlite_location struct, or NULL on error.</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <a class="code" href="structdmlite__location.html" title="Collection of chunks that form a replica.">dmlite_location</a>* <a class="code" href="pool_8h.html#a55066f61909bae9c7d1268c0b76deab9" title="Gets the location of a replica.">dmlite_getlocation</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__replica.html">dmlite_replica</a>* replica);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></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"> * @brief Puts a file (synchronous).</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * @param context The DM context.</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * @param path The logical file name to put.</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @return A pointer to a dmlite_location struct, or NULL on error.</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <a class="code" href="structdmlite__location.html" title="Collection of chunks that form a replica.">dmlite_location</a>* <a class="code" href="pool_8h.html#a585c0603d56d0737dcfeba2e8c0ac87b" title="Puts a file (synchronous).">dmlite_put</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>* path);</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="comment">/**</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * @brief Aborts a put request.</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @param context The DM context.</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * @param loc As returned by dmlite_put.</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keywordtype">int</span> <a class="code" href="pool_8h.html#adfb5a9f6cddb249d284ffbfc751ba11f" title="Aborts a put request.">dmlite_put_abort</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__location.html" title="Collection of chunks that form a replica.">dmlite_location</a>* loc);</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="comment">/**</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * @brief Frees a location struct.</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @param loc The struct to free.</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keywordtype">int</span> <a class="code" href="pool_8h.html#a990069dd9608cf27737dc7bbde283272" title="Frees a location struct.">dmlite_location_free</a>(<a class="code" href="structdmlite__location.html" title="Collection of chunks that form a replica.">dmlite_location</a>* loc);</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#endif </span><span class="comment">/* DMLITE_POOL_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>
