| <!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: include/mesos/appc/spec.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 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> |
| <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 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_a00cdca4cac44d29e96ac7c7cae2bc86.html">mesos</a></li><li class="navelem"><a class="el" href="dir_a95b951a61f0c01cd6d836e7b9e96edf.html">appc</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">spec.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="include_2mesos_2appc_2spec_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> <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> <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> <span class="comment">// distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <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> <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> <span class="comment">// "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment">//</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <span class="comment">//</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <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> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <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> <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> <span class="comment">// limitations under the License.</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef __PROVISIONER_APPC_SPEC_HPP__</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __PROVISIONER_APPC_SPEC_HPP__</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <<a class="code" href="error_8hpp.html">stout/error.hpp</a>></span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="code" href="option_8hpp.html">stout/option.hpp</a>></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <mesos/appc/spec.pb.h></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> |
| <div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="namespaceappc.html"> 27</a></span> <span class="keyword">namespace </span>appc {</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="namespaceappc_1_1spec.html"> 28</a></span> <span class="keyword">namespace </span>spec {</div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// Parse the ImageManifest in the specified JSON string.</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <a class="code" href="classTry.html">Try<ImageManifest></a> <a class="code" href="namespaceappc_1_1spec.html#a2107ae129dd83fbd20b22195247f16b5">parse</a>(<span class="keyword">const</span> std::string& value);</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> </div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// Returns the rootfs of an image, given its path as per the spec.</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> std::string <a class="code" href="namespaceappc_1_1spec.html#a9ec5fa86206ca47bf16b1fc7ee73833a">getImageRootfsPath</a>(<span class="keyword">const</span> std::string& imagePath);</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</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> <span class="comment">// Returns the path of an image's manifest, given its path as per the spec.</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> std::string <a class="code" href="namespaceappc_1_1spec.html#ab9fd627d0bf0137bfda5ca77c69812e6">getImageManifestPath</a>(<span class="keyword">const</span> std::string& imagePath);</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// Returns ImageManifest object for an image at given path.</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <a class="code" href="classTry.html">Try<ImageManifest></a> <a class="code" href="namespaceappc_1_1spec.html#a92f905563062102504a99f237f41e46a">getManifest</a>(<span class="keyword">const</span> std::string& imagePath);</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// Validate if the specified image manifest conforms to the Appc spec.</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <a class="code" href="classOption.html">Option<Error></a> <a class="code" href="namespaceappc_1_1spec.html#a7227a4fa4752fab1ee58e060f2638269">validateManifest</a>(<span class="keyword">const</span> ImageManifest& <a class="code" href="namespacemesos_1_1uri_1_1docker.html#a001e34ad4b471e43d16e9f03e39a4566">manifest</a>);</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// Validate if the specified image ID conforms to the Appc spec.</span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <a class="code" href="classOption.html">Option<Error></a> <a class="code" href="namespaceappc_1_1spec.html#acac56516dd62cae5e594d604ce63345a">validateImageID</a>(<span class="keyword">const</span> std::string& imageId);</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> </div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// Validate if the specified image has the disk layout that conforms</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// to the Appc spec.</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <a class="code" href="classOption.html">Option<Error></a> <a class="code" href="namespaceappc_1_1spec.html#a3edc4cd2f5e89d41c97886f7eab7feef">validateLayout</a>(<span class="keyword">const</span> std::string& imagePath);</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// Validates the image path if it conforms to the Appc image spec.</span></div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <a class="code" href="classOption.html">Option<Error></a> <a class="code" href="namespaceappc_1_1spec.html#a1f003511d7ad7c4792223d0b11b60f62">validate</a>(<span class="keyword">const</span> std::string& imageDir);</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> } <span class="comment">// namespace spec {</span></div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> } <span class="comment">// namespace appc {</span></div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#endif // __PROVISIONER_APPC_SPEC_HPP__</span></div> |
| <div class="ttc" id="namespaceappc_1_1spec_html_a7227a4fa4752fab1ee58e060f2638269"><div class="ttname"><a href="namespaceappc_1_1spec.html#a7227a4fa4752fab1ee58e060f2638269">appc::spec::validateManifest</a></div><div class="ttdeci">Option< Error > validateManifest(const ImageManifest &manifest)</div></div> |
| <div class="ttc" id="namespaceappc_1_1spec_html_ab9fd627d0bf0137bfda5ca77c69812e6"><div class="ttname"><a href="namespaceappc_1_1spec.html#ab9fd627d0bf0137bfda5ca77c69812e6">appc::spec::getImageManifestPath</a></div><div class="ttdeci">std::string getImageManifestPath(const std::string &imagePath)</div></div> |
| <div class="ttc" id="namespaceappc_1_1spec_html_a1f003511d7ad7c4792223d0b11b60f62"><div class="ttname"><a href="namespaceappc_1_1spec.html#a1f003511d7ad7c4792223d0b11b60f62">appc::spec::validate</a></div><div class="ttdeci">Option< Error > validate(const std::string &imageDir)</div></div> |
| <div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option< Error ></a></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="namespacemesos_1_1uri_1_1docker_html_a001e34ad4b471e43d16e9f03e39a4566"><div class="ttname"><a href="namespacemesos_1_1uri_1_1docker.html#a001e34ad4b471e43d16e9f03e39a4566">mesos::uri::docker::manifest</a></div><div class="ttdeci">URI manifest(const std::string &repository, const std::string &reference, const std::string &registry, const Option< std::string > &scheme=None(), const Option< int > &port=None())</div><div class="ttdef"><b>Definition:</b> docker.hpp:47</div></div> |
| <div class="ttc" id="namespaceappc_1_1spec_html_a2107ae129dd83fbd20b22195247f16b5"><div class="ttname"><a href="namespaceappc_1_1spec.html#a2107ae129dd83fbd20b22195247f16b5">appc::spec::parse</a></div><div class="ttdeci">Try< ImageManifest > parse(const std::string &value)</div><div class="ttdef"><b>Definition:</b> parse.hpp:36</div></div> |
| <div class="ttc" id="option_8hpp_html"><div class="ttname"><a href="option_8hpp.html">option.hpp</a></div></div> |
| <div class="ttc" id="error_8hpp_html"><div class="ttname"><a href="error_8hpp.html">error.hpp</a></div></div> |
| <div class="ttc" id="namespaceappc_1_1spec_html_a3edc4cd2f5e89d41c97886f7eab7feef"><div class="ttname"><a href="namespaceappc_1_1spec.html#a3edc4cd2f5e89d41c97886f7eab7feef">appc::spec::validateLayout</a></div><div class="ttdeci">Option< Error > validateLayout(const std::string &imagePath)</div></div> |
| <div class="ttc" id="namespaceappc_1_1spec_html_acac56516dd62cae5e594d604ce63345a"><div class="ttname"><a href="namespaceappc_1_1spec.html#acac56516dd62cae5e594d604ce63345a">appc::spec::validateImageID</a></div><div class="ttdeci">Option< Error > validateImageID(const std::string &imageId)</div></div> |
| <div class="ttc" id="namespaceappc_1_1spec_html_a92f905563062102504a99f237f41e46a"><div class="ttname"><a href="namespaceappc_1_1spec.html#a92f905563062102504a99f237f41e46a">appc::spec::getManifest</a></div><div class="ttdeci">Try< ImageManifest > getManifest(const std::string &imagePath)</div></div> |
| <div class="ttc" id="namespaceappc_1_1spec_html_a9ec5fa86206ca47bf16b1fc7ee73833a"><div class="ttname"><a href="namespaceappc_1_1spec.html#a9ec5fa86206ca47bf16b1fc7ee73833a">appc::spec::getImageRootfsPath</a></div><div class="ttdeci">std::string getImageRootfsPath(const std::string &imagePath)</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.5 |
| </small></address> |
| </body> |
| </html> |
