blob: aaf2e40f3fd7abe6776b7b5d0bc0ba3d967d8f75 [file] [log] [blame]
<!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.5"/>
<title>Apache Mesos: src/slave/containerizer/mesos/provisioner/appc/cache.hpp 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">Apache Mesos
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_80f0d4a0945c74dfa611dba2ec326a39.html">slave</a></li><li class="navelem"><a class="el" href="dir_fbb1f3397356a940a2dbc4baf07ee5bb.html">containerizer</a></li><li class="navelem"><a class="el" href="dir_06602996fd31a3e264808d1450975cb2.html">mesos</a></li><li class="navelem"><a class="el" href="dir_f319675d4a0209ee44e08f6c8dad3e25.html">provisioner</a></li><li class="navelem"><a class="el" href="dir_4f41d30518de1e59bcb759f18fc06d2a.html">appc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">cache.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="src_2slave_2containerizer_2mesos_2provisioner_2appc_2cache_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// distributed with this work for additional information</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef __APPC_PROVISIONER_CACHE_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __APPC_PROVISIONER_CACHE_HPP__</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="owned_8hpp.html">process/owned.hpp</a>&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="hashmap_8hpp.html">stout/hashmap.hpp</a>&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="include_2mesos_2mesos_8hpp.html">mesos/mesos.hpp</a>&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="include_2mesos_2appc_2spec_8hpp.html">mesos/appc/spec.hpp</a>&gt;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">namespace </span>mesos {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">namespace </span>internal {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">namespace </span>slave {</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="namespacemesos_1_1internal_1_1slave_1_1appc.html"> 34</a></span>&#160;<span class="keyword">namespace </span>appc {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache.html"> 42</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache.html">Cache</a></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;{</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">static</span> <a class="code" href="classTry.html">Try&lt;process::Owned&lt;Cache&gt;</a>&gt; <a class="code" href="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache.html#a11b5dd7cc60cff5ca5433b4f6719d57f">create</a>(<span class="keyword">const</span> <a class="code" href="classPath.html">Path</a>&amp; storeDir);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="classTry.html">Try&lt;Nothing&gt;</a> <a class="code" href="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache.html#a25eba68d6d270ed5793a9631609c833d">recover</a>();</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="code" href="classTry.html">Try&lt;Nothing&gt;</a> <a class="code" href="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache.html#af1ae34e4ecb351cf7e7f3086c95145ad">add</a>(<span class="keyword">const</span> std::string&amp; imageId);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <a class="code" href="classOption.html">Option&lt;std::string&gt;</a> <a class="code" href="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache.html#af64aec7cf1c51852e71b9c45ed2f67df">find</a>(<span class="keyword">const</span> Image::Appc&amp; <a class="code" href="namespacemesos_1_1uri_1_1docker.html#abbd9f55734f0b832bc5a87c3ee5d449e">image</a>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">struct </span>Key</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; {</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; Key(<span class="keyword">const</span> Image::Appc&amp; image);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; Key(<span class="keyword">const</span> std::string&amp; <a class="code" href="namespaceos_1_1Shell.html#acfe16ef2b1146ad49a8651c0a457ce46">name</a>,</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">const</span> std::map&lt;std::string, std::string&gt;&amp; labels);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="namespacemesos_1_1internal_1_1slave.html#a9be31fa94f9a49c22650ce5e3a3954c0">operator==</a>(<span class="keyword">const</span> Key&amp; other) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; std::string <a class="code" href="namespaceos_1_1Shell.html#acfe16ef2b1146ad49a8651c0a457ce46">name</a>;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; std::map&lt;std::string, std::string&gt; labels;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; };</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">struct </span>KeyHasher</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; {</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordtype">size_t</span> operator()(<span class="keyword">const</span> Key&amp; key) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; };</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <a class="code" href="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache.html">Cache</a>(<span class="keyword">const</span> <a class="code" href="classPath.html">Path</a>&amp; imagesDir);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">const</span> <a class="code" href="classPath.html">Path</a> storeDir;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="comment">// Mappings: Key -&gt; image id.</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <a class="code" href="classhashmap.html">hashmap&lt;Cache::Key, std::string, KeyHasher&gt;</a> imageIds;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;};</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;} <span class="comment">// namespace appc {</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;} <span class="comment">// namespace slave {</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;} <span class="comment">// namespace internal {</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;} <span class="comment">// namespace mesos {</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="preprocessor">#endif // __APPC_PROVISIONER_CACHE_HPP__</span></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache_html_a25eba68d6d270ed5793a9631609c833d"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache.html#a25eba68d6d270ed5793a9631609c833d">mesos::internal::slave::appc::Cache::recover</a></div><div class="ttdeci">Try&lt; Nothing &gt; recover()</div><div class="ttdoc">Recovers/rebuilds the cache from its image store directory. </div></div>
<div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option&lt; std::string &gt;</a></div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1slave_html_a9be31fa94f9a49c22650ce5e3a3954c0"><div class="ttname"><a href="namespacemesos_1_1internal_1_1slave.html#a9be31fa94f9a49c22650ce5e3a3954c0">mesos::internal::slave::operator==</a></div><div class="ttdeci">bool operator==(const DockerVolume &amp;left, const DockerVolume &amp;right)</div><div class="ttdef"><b>Definition:</b> state.hpp:29</div></div>
<div class="ttc" id="classTry_html"><div class="ttname"><a href="classTry.html">Try</a></div><div class="ttdef"><b>Definition:</b> try.hpp:34</div></div>
<div class="ttc" id="include_2mesos_2mesos_8hpp_html"><div class="ttname"><a href="include_2mesos_2mesos_8hpp.html">mesos.hpp</a></div></div>
<div class="ttc" id="classhashmap_html"><div class="ttname"><a href="classhashmap.html">hashmap</a></div><div class="ttdef"><b>Definition:</b> hashmap.hpp:36</div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache_html_a11b5dd7cc60cff5ca5433b4f6719d57f"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache.html#a11b5dd7cc60cff5ca5433b4f6719d57f">mesos::internal::slave::appc::Cache::create</a></div><div class="ttdeci">static Try&lt; process::Owned&lt; Cache &gt; &gt; create(const Path &amp;storeDir)</div><div class="ttdoc">Factory method for creating cache. </div></div>
<div class="ttc" id="include_2mesos_2appc_2spec_8hpp_html"><div class="ttname"><a href="include_2mesos_2appc_2spec_8hpp.html">spec.hpp</a></div></div>
<div class="ttc" id="classPath_html"><div class="ttname"><a href="classPath.html">Path</a></div><div class="ttdoc">Represents a POSIX or Windows file system path and offers common path manipulations. </div><div class="ttdef"><b>Definition:</b> path.hpp:79</div></div>
<div class="ttc" id="namespacemesos_1_1uri_1_1docker_html_abbd9f55734f0b832bc5a87c3ee5d449e"><div class="ttname"><a href="namespacemesos_1_1uri_1_1docker.html#abbd9f55734f0b832bc5a87c3ee5d449e">mesos::uri::docker::image</a></div><div class="ttdeci">URI image(const std::string &amp;repository, const std::string &amp;reference, const std::string &amp;registry, const Option&lt; std::string &gt; &amp;scheme=None(), const Option&lt; int &gt; &amp;port=None())</div><div class="ttdef"><b>Definition:</b> docker.hpp:30</div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache_html_af1ae34e4ecb351cf7e7f3086c95145ad"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache.html#af1ae34e4ecb351cf7e7f3086c95145ad">mesos::internal::slave::appc::Cache::add</a></div><div class="ttdeci">Try&lt; Nothing &gt; add(const std::string &amp;imageId)</div><div class="ttdoc">Adds an image to the cache by the image&amp;#39;s id. </div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache_html"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache.html">mesos::internal::slave::appc::Cache</a></div><div class="ttdoc">Encapsulates Appc image cache. </div><div class="ttdef"><b>Definition:</b> cache.hpp:42</div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache_html_af64aec7cf1c51852e71b9c45ed2f67df"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1appc_1_1Cache.html#af64aec7cf1c51852e71b9c45ed2f67df">mesos::internal::slave::appc::Cache::find</a></div><div class="ttdeci">Option&lt; std::string &gt; find(const Image::Appc &amp;image) const </div><div class="ttdoc">Finds image id of an image if it is present in the cache/store. </div></div>
<div class="ttc" id="owned_8hpp_html"><div class="ttname"><a href="owned_8hpp.html">owned.hpp</a></div></div>
<div class="ttc" id="namespaceos_1_1Shell_html_acfe16ef2b1146ad49a8651c0a457ce46"><div class="ttname"><a href="namespaceos_1_1Shell.html#acfe16ef2b1146ad49a8651c0a457ce46">os::Shell::name</a></div><div class="ttdeci">constexpr const char * name</div><div class="ttdef"><b>Definition:</b> shell.hpp:41</div></div>
<div class="ttc" id="hashmap_8hpp_html"><div class="ttname"><a href="hashmap_8hpp.html">hashmap.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>