<!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/cpp/pooldriver.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_5eb0003806ff55b9e42d6823777110d1.html">cpp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pooldriver.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="pooldriver_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/cpp/pooldriver.h</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span><span class="comment">/// @brief Pool handling API.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span><span class="comment">/// @author Alejandro Álvarez Ayllón <aalvarez@cern.ch></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span><span class="preprocessor">#ifndef DMLITE_CPP_POOLDRIVER_H</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor"></span><span class="preprocessor">#define DMLITE_CPP_POOLDRIVER_H</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "../common/config.h"</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="base_8h.html" title="Base interfaces.">base.h</a>"</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="exceptions_8h.html" title="Exceptions used by the API.">exceptions.h</a>"</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "<a class="code" href="p_2inode_8h.html" title="Low-level access 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="urls_8h.html" title="Common methods and functions for URL and path.">utils/urls.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"> 13</span> <span class="preprocessor">#include <map></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <vector></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="keyword">namespace </span>dmlite {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="comment">// Forward declarations.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">class </span>Pool;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keyword">class </span>StackInstance;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="comment"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> /// Represents a chunk of a file.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="code" href="structdmlite_1_1_chunk.html"> 23</a></span> <span class="comment"></span> <span class="keyword">struct </span><a class="code" href="structdmlite_1_1_chunk.html" title="Represents a chunk of a file.">Chunk</a> {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="structdmlite_1_1_chunk.html#a725971c75bc246aa1d83ed7482b2bfca">Chunk</a>();</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="structdmlite_1_1_chunk.html#a725971c75bc246aa1d83ed7482b2bfca">Chunk</a>(<span class="keyword">const</span> std::string& <a class="code" href="structdmlite_1_1_chunk.html#a7a7274cbdd1be26d9bc1544f98aa1996">url</a>, uint64_t <a class="code" href="structdmlite_1_1_chunk.html#afe2645e759a73c23f244f1983cf7578b">offset</a>, uint64_t <a class="code" href="structdmlite_1_1_chunk.html#a4bb3d2a04dd9d1ff3fb0be4f7461a610">size</a>);<span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> /// Chunk from a serialized string</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span> <span class="keyword">explicit</span> <a class="code" href="structdmlite_1_1_chunk.html#a725971c75bc246aa1d83ed7482b2bfca">Chunk</a>(<span class="keyword">const</span> std::string& str);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="structdmlite_1_1_chunk.html#afe2645e759a73c23f244f1983cf7578b"> 29</a></span>  uint64_t <a class="code" href="structdmlite_1_1_chunk.html#afe2645e759a73c23f244f1983cf7578b">offset</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="code" href="structdmlite_1_1_chunk.html#a4bb3d2a04dd9d1ff3fb0be4f7461a610"> 30</a></span>  uint64_t <a class="code" href="structdmlite_1_1_chunk.html#a4bb3d2a04dd9d1ff3fb0be4f7461a610">size</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="code" href="structdmlite_1_1_chunk.html#a7a7274cbdd1be26d9bc1544f98aa1996"> 31</a></span>  <a class="code" href="structdmlite_1_1_url.html">Url</a> <a class="code" href="structdmlite_1_1_chunk.html#a7a7274cbdd1be26d9bc1544f98aa1996">url</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">bool</span> <a class="code" href="structdmlite_1_1_chunk.html#ae012d056d0e2811558ee83c8d1daa5b8">operator == </a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_chunk.html" title="Represents a chunk of a file.">Chunk</a>&) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">bool</span> <a class="code" href="structdmlite_1_1_chunk.html#a44d1d0f3d9677f0c38162f612b3f1c04">operator != </a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_chunk.html" title="Represents a chunk of a file.">Chunk</a>&) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">bool</span> <a class="code" href="structdmlite_1_1_chunk.html#ade10baf7f90e7baf588681b3cca27ecc">operator < </a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_chunk.html" title="Represents a chunk of a file.">Chunk</a>&) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">bool</span> <a class="code" href="structdmlite_1_1_chunk.html#aee37b98ab8d51f2e71a4553798ec9332">operator > </a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_chunk.html" title="Represents a chunk of a file.">Chunk</a>&) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  std::string <a class="code" href="structdmlite_1_1_chunk.html#a27ec88f49ea54b0cdf05c2f1769f8ff1">toString</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  };</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment"></span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> /// Represent the complete location of a file.</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="structdmlite_1_1_location.html"> 42</a></span> <span class="comment"></span> <span class="keyword">struct </span><a class="code" href="structdmlite_1_1_location.html" title="Represent the complete location of a file.">Location</a>: <span class="keyword">public</span> std::vector<Chunk> {</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="structdmlite_1_1_location.html#ad2868b1fa39c5820f0d0f5f35766560c"> 43</a></span>  <a class="code" href="structdmlite_1_1_location.html#ad2868b1fa39c5820f0d0f5f35766560c">Location</a>() {}</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="structdmlite_1_1_location.html#afacde2d92118952eaaee161b609c064e"> 44</a></span>  <a class="code" href="structdmlite_1_1_location.html#afacde2d92118952eaaee161b609c064e">Location</a>(<span class="keywordtype">int</span> nitems, <span class="keyword">const</span> <a class="code" href="structdmlite_1_1_chunk.html" title="Represents a chunk of a file.">Chunk</a>& proto): std::vector<<a class="code" href="structdmlite_1_1_chunk.html" title="Represents a chunk of a file.">Chunk</a>>(nitems, proto) {}</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="structdmlite_1_1_location.html#ace1227a79eafd7a93318293ffd717d05"> 46</a></span>  <a class="code" href="structdmlite_1_1_location.html#ace1227a79eafd7a93318293ffd717d05">Location</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_location.html" title="Represent the complete location of a file.">Location</a>& l): std::vector<<a class="code" href="structdmlite_1_1_chunk.html" title="Represents a chunk of a file.">Chunk</a>>(l) {}</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Location from serialized string</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">explicit</span> <a class="code" href="structdmlite_1_1_location.html#ad2868b1fa39c5820f0d0f5f35766560c">Location</a>(<span class="keyword">const</span> std::string& str);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  std::string <a class="code" href="structdmlite_1_1_location.html#a5ee9e8e05f70ba35d61f392ca08b16be">toString</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  };</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> /// Handler for a pool. Works similary to a file handler.</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="classdmlite_1_1_pool_handler.html"> 55</a></span> <span class="comment"></span> <span class="keyword">class </span><a class="code" href="classdmlite_1_1_pool_handler.html" title="Handler for a pool. Works similary to a file handler.">PoolHandler</a> {</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> /// Destructor</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_pool_handler.html#a61d3edd129569552cd67b0c12b0e698c" title="Destructor.">~PoolHandler</a>();</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"> /// Get the pool type of this pool.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span> <span class="keyword">virtual</span> std::string <a class="code" href="classdmlite_1_1_pool_handler.html#aa4c4ebd7e5c081e9ad8576281d68e0a5" title="Get the pool type of this pool.">getPoolType</a>(<span class="keywordtype">void</span>) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> /// Get the pool name of this pool.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"></span> <span class="keyword">virtual</span> std::string <a class="code" href="classdmlite_1_1_pool_handler.html#a365ba9a640874d40f54a84c837113d47" title="Get the pool name of this pool.">getPoolName</a>(<span class="keywordtype">void</span>) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</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> <span class="comment"> /// Get the total space of this pool.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span> <span class="keyword">virtual</span> uint64_t <a class="code" href="classdmlite_1_1_pool_handler.html#aedfe4abef2d24c435772d78efafbdb84" title="Get the total space of this pool.">getTotalSpace</a>(<span class="keywordtype">void</span>) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</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"> /// Get the free space of this pool.</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span> <span class="keyword">virtual</span> uint64_t <a class="code" href="classdmlite_1_1_pool_handler.html#a1b8965596c777874b07fa37f5fa3dd58" title="Get the free space of this pool.">getFreeSpace</a>(<span class="keywordtype">void</span>) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"></span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> /// Check if the pool is actually available.</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlite_1_1_pool_handler.html#a7f250db4d04295dff5361f154bf3b5e8" title="Check if the pool is actually available.">poolIsAvailable</a>(<span class="keywordtype">bool</span> write = <span class="keyword">true</span>) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment"></span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> /// Check if a replica is available.</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlite_1_1_pool_handler.html#a89b0379f4d5c4810ec1e26b92ba7a767" title="Check if a replica is available.">replicaIsAvailable</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_replica.html" title="File replica metadata.">Replica</a>& replica) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"></span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> /// Get the actual location of the file replica. This is pool-specific.</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="structdmlite_1_1_location.html" title="Represent the complete location of a file.">Location</a> <a class="code" href="classdmlite_1_1_pool_handler.html#a484ade8a15decd1c3b5416dcf72029d2" title="Get the actual location of the file replica. This is pool-specific.">whereToRead</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_replica.html" title="File replica metadata.">Replica</a>& replica) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"></span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /// Remove a replica from the pool.</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_pool_handler.html#a413524be72d9f3ffd4517988710757d1" title="Remove a replica from the pool.">removeReplica</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_replica.html" title="File replica metadata.">Replica</a>& replica) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</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"> /// Get where to put a file.</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="structdmlite_1_1_location.html" title="Represent the complete location of a file.">Location</a> <a class="code" href="classdmlite_1_1_pool_handler.html#ae57fe0670b060e974dff7b0d76cc9ed4" title="Get where to put a file.">whereToWrite</a>(<span class="keyword">const</span> std::string& path) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> /// Cancel a write.</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_pool_handler.html#af6fd5e6eae7577a7f757dc17771edeb8" title="Cancel a write.">cancelWrite</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_location.html" title="Represent the complete location of a file.">Location</a>& loc) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  };</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> /// Interface for a pool driver</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="code" href="classdmlite_1_1_pool_driver.html"> 92</a></span> <span class="comment"></span> <span class="keyword">class </span><a class="code" href="classdmlite_1_1_pool_driver.html" title="Interface for a pool driver.">PoolDriver</a>: <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_base_interface.html" title="Base class for interfaces.">BaseInterface</a> {</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> /// Destructor</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_pool_driver.html#a7bf369841b1c8d71729df30a620df831" title="Destructor.">~PoolDriver</a>();</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> /// Create a handler.</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_pool_handler.html" title="Handler for a pool. Works similary to a file handler.">PoolHandler</a>* <a class="code" href="classdmlite_1_1_pool_driver.html#af92dde70ca72b6633f6626218a617bf4" title="Create a handler.">createPoolHandler</a>(<span class="keyword">const</span> std::string& poolName) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</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"> /// Called just before adding the pool to the database.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> /// To be used by a plugin, in case it needs to do some previous preparations.</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> /// (i.e. legacy filesystem will actually create the pool here)</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_pool_driver.html#a9b8b2dcafb0f252b116eba56a787772c">toBeCreated</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_pool.html" title="Internal interface for handling pool metadata.">Pool</a>& pool) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</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="comment"> /// Called just after a pool is added to the database.</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_pool_driver.html#a873cce35f77ae378f8ecaf34524a98be" title="Called just after a pool is added to the database.">justCreated</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_pool.html" title="Internal interface for handling pool metadata.">Pool</a>& pool) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="comment"></span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> /// Called when updating a pool.</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_pool_driver.html#a97807ab1d84cb967c3e4580847ba9f3f" title="Called when updating a pool.">update</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_pool.html" title="Internal interface for handling pool metadata.">Pool</a>& pool) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</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"> /// Called just before a pool of this type is removed.</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> /// @note The driver may remove the pool itself (i.e. filesystem)</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_pool_driver.html#a1faf72689d0b0f7dea5abbf0ac1d7632">toBeDeleted</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_pool.html" title="Internal interface for handling pool metadata.">Pool</a>& pool) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</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="comment"> /// PoolDriver factory</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"><a class="code" href="classdmlite_1_1_pool_driver_factory.html"> 117</a></span> <span class="comment"></span> <span class="keyword">class </span><a class="code" href="classdmlite_1_1_pool_driver_factory.html" title="PoolDriver factory.">PoolDriverFactory</a>: <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_base_factory.html" title="Base class for factories.">BaseFactory</a> {</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> /// Destructor.</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_pool_driver_factory.html#a60f4ba56cf28bd24364772ba9ada6c90" title="Destructor.">~PoolDriverFactory</a>();</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"></span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> /// Supported pool type</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"></span> <span class="keyword">virtual</span> std::string <a class="code" href="classdmlite_1_1_pool_driver_factory.html#ab20bf8053385db3e9d1703663364b44b" title="Supported pool type.">implementedPool</a>() <span class="keywordflow">throw</span> ();</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="code" href="classdmlite_1_1_pool_driver_factory.html#a7653c7bbf485a8f140d1c9d112a59ad9"> 126</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classdmlite_1_1_stack_instance.html">StackInstance</a>;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"></span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> /// Instantiate the implemented pool driver.</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_pool_driver.html" title="Interface for a pool driver.">PoolDriver</a>* <a class="code" href="classdmlite_1_1_pool_driver_factory.html#a10621f30102fcfdbb56bfdbc1e76ad62" title="Instantiate the implemented pool driver.">createPoolDriver</a>(<span class="keywordtype">void</span>) throw (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  };</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> };</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#endif // DMLITE_CPP_POOLDRIVER_H</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>
