blob: ce492fe4544155230ff9bb8f844ee2631ce2d3e3 [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: include/mesos/oci/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&#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_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_30eb538f4f91620b9070be4b9f22e7f6.html">oci</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_2oci_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>&#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 __MESOS_OCI_SPEC_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __MESOS_OCI_SPEC_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;mesos/oci/spec.pb.h&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="namespaceoci.html"> 22</a></span>&#160;<span class="keyword">namespace </span>oci {</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="namespaceoci_1_1spec.html"> 23</a></span>&#160;<span class="keyword">namespace </span>spec {</div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="namespaceoci_1_1spec_1_1image.html"> 24</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemesos_1_1uri_1_1docker.html#abbd9f55734f0b832bc5a87c3ee5d449e">image</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="namespaceoci_1_1spec_1_1image_1_1v1.html"> 25</a></span>&#160;<span class="keyword">namespace </span>v1 {</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="comment">// Constant strings for OCI image media types:</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment">// https://github.com/opencontainers/image-spec/blob/master/media-types.md</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespaceoci_1_1spec_1_1image_1_1v1.html#ae551767039bada7959540f8ec557ec6e"> 29</a></span>&#160;constexpr <span class="keywordtype">char</span> <a class="code" href="namespaceoci_1_1spec_1_1image_1_1v1.html#ae551767039bada7959540f8ec557ec6e">MEDIA_TYPE_INDEX</a>[] =</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="stringliteral">&quot;application/vnd.oci.image.index.v1+json&quot;</span>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="namespaceoci_1_1spec_1_1image_1_1v1.html#a9f494bb0f62a0340745f1f9b84635abc"> 32</a></span>&#160;constexpr <span class="keywordtype">char</span> <a class="code" href="namespaceoci_1_1spec_1_1image_1_1v1.html#a9f494bb0f62a0340745f1f9b84635abc">MEDIA_TYPE_MANIFEST</a>[] =</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="stringliteral">&quot;application/vnd.oci.image.manifest.v1+json&quot;</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="namespaceoci_1_1spec_1_1image_1_1v1.html#ac353b6ae7cd68545891d945fd1ad318b"> 35</a></span>&#160;constexpr <span class="keywordtype">char</span> <a class="code" href="namespaceoci_1_1spec_1_1image_1_1v1.html#ac353b6ae7cd68545891d945fd1ad318b">MEDIA_TYPE_CONFIG</a>[] =</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="stringliteral">&quot;application/vnd.oci.image.config.v1+json&quot;</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="namespaceoci_1_1spec_1_1image_1_1v1.html#a7b0e74ea590e624b5ce80778aeb9466a"> 38</a></span>&#160;constexpr <span class="keywordtype">char</span> <a class="code" href="namespaceoci_1_1spec_1_1image_1_1v1.html#a7b0e74ea590e624b5ce80778aeb9466a">MEDIA_TYPE_LAYER</a>[] =</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="stringliteral">&quot;application/vnd.oci.image.layer.v1.tar&quot;</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="namespaceoci_1_1spec_1_1image_1_1v1.html#abc9afae3cff1b2b40e6093fcdf873522"> 41</a></span>&#160;constexpr <span class="keywordtype">char</span> <a class="code" href="namespaceoci_1_1spec_1_1image_1_1v1.html#abc9afae3cff1b2b40e6093fcdf873522">MEDIA_TYPE_LAYER_GZIP</a>[] =</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="stringliteral">&quot;application/vnd.oci.image.layer.v1.tar+gzip&quot;</span>;</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"><a class="line" href="namespaceoci_1_1spec_1_1image_1_1v1.html#aed19b54ec8be371563d5406e1739cdf9"> 44</a></span>&#160;constexpr <span class="keywordtype">char</span> <a class="code" href="namespaceoci_1_1spec_1_1image_1_1v1.html#aed19b54ec8be371563d5406e1739cdf9">MEDIA_TYPE_NONDIST_LAYER</a>[] =</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="stringliteral">&quot;application/vnd.oci.image.layer.nondistributable.v1.tar&quot;</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="namespaceoci_1_1spec_1_1image_1_1v1.html#a93af2cec98cfd0932704da7b0f2de074"> 47</a></span>&#160;constexpr <span class="keywordtype">char</span> <a class="code" href="namespaceoci_1_1spec_1_1image_1_1v1.html#a93af2cec98cfd0932704da7b0f2de074">MEDIA_TYPE_NONDIST_LAYER_GZIP</a>[] =</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="stringliteral">&quot;application/vnd.oci.image.layer.nondistributable.v1.tar+gzip&quot;</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment">// Rootfs type of OCI image configuration.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="namespaceoci_1_1spec_1_1image_1_1v1.html#ae96a13d9d8951c224c4d80504a6fd3b1"> 51</a></span>&#160;constexpr <span class="keywordtype">char</span> <a class="code" href="namespaceoci_1_1spec_1_1image_1_1v1.html#ae96a13d9d8951c224c4d80504a6fd3b1">ROOTFS_TYPE</a>[] = <span class="stringliteral">&quot;layers&quot;</span>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<a class="code" href="classTry.html">Try&lt;T&gt;</a> <a class="code" href="namespaceoci_1_1spec_1_1image_1_1v1.html#a271fa79f0110d85036f40c31cca1a22e">parse</a>(<span class="keyword">const</span> std::string&amp; s);</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;} <span class="comment">// namespace v1 {</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;} <span class="comment">// namespace image {</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;} <span class="comment">// namespace spec {</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;} <span class="comment">// namespace oci {</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#endif // __MESOS_OCI_SPEC_HPP__</span></div>
<div class="ttc" id="namespaceoci_1_1spec_1_1image_1_1v1_html_a9f494bb0f62a0340745f1f9b84635abc"><div class="ttname"><a href="namespaceoci_1_1spec_1_1image_1_1v1.html#a9f494bb0f62a0340745f1f9b84635abc">oci::spec::image::v1::MEDIA_TYPE_MANIFEST</a></div><div class="ttdeci">constexpr char MEDIA_TYPE_MANIFEST[]</div><div class="ttdef"><b>Definition:</b> spec.hpp:32</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="namespaceoci_1_1spec_1_1image_1_1v1_html_ae551767039bada7959540f8ec557ec6e"><div class="ttname"><a href="namespaceoci_1_1spec_1_1image_1_1v1.html#ae551767039bada7959540f8ec557ec6e">oci::spec::image::v1::MEDIA_TYPE_INDEX</a></div><div class="ttdeci">constexpr char MEDIA_TYPE_INDEX[]</div><div class="ttdef"><b>Definition:</b> spec.hpp:29</div></div>
<div class="ttc" id="namespaceoci_1_1spec_1_1image_1_1v1_html_ae96a13d9d8951c224c4d80504a6fd3b1"><div class="ttname"><a href="namespaceoci_1_1spec_1_1image_1_1v1.html#ae96a13d9d8951c224c4d80504a6fd3b1">oci::spec::image::v1::ROOTFS_TYPE</a></div><div class="ttdeci">constexpr char ROOTFS_TYPE[]</div><div class="ttdef"><b>Definition:</b> spec.hpp:51</div></div>
<div class="ttc" id="namespaceoci_1_1spec_1_1image_1_1v1_html_abc9afae3cff1b2b40e6093fcdf873522"><div class="ttname"><a href="namespaceoci_1_1spec_1_1image_1_1v1.html#abc9afae3cff1b2b40e6093fcdf873522">oci::spec::image::v1::MEDIA_TYPE_LAYER_GZIP</a></div><div class="ttdeci">constexpr char MEDIA_TYPE_LAYER_GZIP[]</div><div class="ttdef"><b>Definition:</b> spec.hpp:41</div></div>
<div class="ttc" id="namespaceoci_1_1spec_1_1image_1_1v1_html_ac353b6ae7cd68545891d945fd1ad318b"><div class="ttname"><a href="namespaceoci_1_1spec_1_1image_1_1v1.html#ac353b6ae7cd68545891d945fd1ad318b">oci::spec::image::v1::MEDIA_TYPE_CONFIG</a></div><div class="ttdeci">constexpr char MEDIA_TYPE_CONFIG[]</div><div class="ttdef"><b>Definition:</b> spec.hpp:35</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="namespaceoci_1_1spec_1_1image_1_1v1_html_aed19b54ec8be371563d5406e1739cdf9"><div class="ttname"><a href="namespaceoci_1_1spec_1_1image_1_1v1.html#aed19b54ec8be371563d5406e1739cdf9">oci::spec::image::v1::MEDIA_TYPE_NONDIST_LAYER</a></div><div class="ttdeci">constexpr char MEDIA_TYPE_NONDIST_LAYER[]</div><div class="ttdef"><b>Definition:</b> spec.hpp:44</div></div>
<div class="ttc" id="namespaceoci_1_1spec_1_1image_1_1v1_html_a93af2cec98cfd0932704da7b0f2de074"><div class="ttname"><a href="namespaceoci_1_1spec_1_1image_1_1v1.html#a93af2cec98cfd0932704da7b0f2de074">oci::spec::image::v1::MEDIA_TYPE_NONDIST_LAYER_GZIP</a></div><div class="ttdeci">constexpr char MEDIA_TYPE_NONDIST_LAYER_GZIP[]</div><div class="ttdef"><b>Definition:</b> spec.hpp:47</div></div>
<div class="ttc" id="namespaceoci_1_1spec_1_1image_1_1v1_html_a271fa79f0110d85036f40c31cca1a22e"><div class="ttname"><a href="namespaceoci_1_1spec_1_1image_1_1v1.html#a271fa79f0110d85036f40c31cca1a22e">oci::spec::image::v1::parse</a></div><div class="ttdeci">Try&lt; T &gt; parse(const std::string &amp;s)</div><div class="ttdoc">Returns the OCI v1 descriptor, image index, image manifest and image configuration from the given str...</div><div class="ttdef"><b>Definition:</b> parse.hpp:36</div></div>
<div class="ttc" id="namespaceoci_1_1spec_1_1image_1_1v1_html_a7b0e74ea590e624b5ce80778aeb9466a"><div class="ttname"><a href="namespaceoci_1_1spec_1_1image_1_1v1.html#a7b0e74ea590e624b5ce80778aeb9466a">oci::spec::image::v1::MEDIA_TYPE_LAYER</a></div><div class="ttdeci">constexpr char MEDIA_TYPE_LAYER[]</div><div class="ttdef"><b>Definition:</b> spec.hpp:38</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>