blob: 6b964041fb6d0695133c5e0ee455d8d28c161da9 [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/common/command_utils.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_fdedb0aba14d44ce9d99bc100e026e6a.html">common</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">command_utils.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="command__utils_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 __COMMON_COMMAND_UTILS_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __COMMON_COMMAND_UTILS_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;<a class="code" href="libprocess_2include_2process_2process_8hpp.html">process/process.hpp</a>&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"> 22</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="option_8hpp.html">stout/option.hpp</a>&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="path_8hpp.html">stout/path.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="keyword">namespace </span>mesos {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span>internal {</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="namespacemesos_1_1internal_1_1command.html"> 27</a></span>&#160;<span class="keyword">namespace </span>command {</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"><a class="line" href="namespacemesos_1_1internal_1_1command.html#ab14fc4c04c507bafcc3c10b4be19f728"> 29</a></span>&#160;<span class="keyword">enum class</span> <a class="code" href="namespacemesos_1_1internal_1_1command.html#ab14fc4c04c507bafcc3c10b4be19f728">Compression</a></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; <a class="code" href="namespacemesos_1_1internal_1_1command.html#ab14fc4c04c507bafcc3c10b4be19f728af1cd28417b03cfab3a8e16d66e34e18a">GZIP</a>,</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="namespacemesos_1_1internal_1_1command.html#ab14fc4c04c507bafcc3c10b4be19f728a800edd55a1e18b397e3d5d826f85ce34">BZIP2</a>,</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="namespacemesos_1_1internal_1_1command.html#ab14fc4c04c507bafcc3c10b4be19f728a27db3b98d01e664c17a6620b222c6469">XZ</a></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"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<a class="code" href="classprocess_1_1Future.html">process::Future&lt;Nothing&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1command.html#a6fa52ad212c7cc54ddcca193bb3bc5a4">tar</a>(</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">const</span> <a class="code" href="classPath.html">Path</a>&amp; input,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">const</span> <a class="code" href="classPath.html">Path</a>&amp; output,</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">const</span> <a class="code" href="classOption.html">Option&lt;Path&gt;</a>&amp; directory = <a class="code" href="structNone.html">None</a>(),</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">const</span> <a class="code" href="classOption.html">Option&lt;Compression&gt;</a>&amp; compression = <a class="code" href="structNone.html">None</a>());</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<a class="code" href="classprocess_1_1Future.html">process::Future&lt;Nothing&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1command.html#a298fb91e3560074658b123b93ec8d26c">untar</a>(</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">const</span> <a class="code" href="classPath.html">Path</a>&amp; input,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">const</span> <a class="code" href="classOption.html">Option&lt;Path&gt;</a>&amp; directory = <a class="code" href="structNone.html">None</a>());</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="comment">// TODO(Jojy): Add more overloads/options for untar (eg., keep existing files)</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<a class="code" href="classprocess_1_1Future.html">process::Future&lt;std::string&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1command.html#ace37bb3ed28b0e5dc3bc151ac9ffe011">sha512</a>(<span class="keyword">const</span> <a class="code" href="classPath.html">Path</a>&amp; input);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<a class="code" href="classprocess_1_1Future.html">process::Future&lt;Nothing&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1command.html#a2b3b7a8163ec2b5f2d08f459f59be459">gzip</a>(<span class="keyword">const</span> <a class="code" href="classPath.html">Path</a>&amp; input);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="comment">// TODO(jojy): Add support for other compression algorithms.</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<a class="code" href="classprocess_1_1Future.html">process::Future&lt;Nothing&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1command.html#a4f230f32dd37430f4a9da1e66fe9888d">decompress</a>(<span class="keyword">const</span> <a class="code" href="classPath.html">Path</a>&amp; input);</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;} <span class="comment">// namespace command {</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;} <span class="comment">// namespace internal {</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;} <span class="comment">// namespace mesos {</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="preprocessor">#endif // __COMMON_COMMAND_UTILS_HPP__</span></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1command_html_a2b3b7a8163ec2b5f2d08f459f59be459"><div class="ttname"><a href="namespacemesos_1_1internal_1_1command.html#a2b3b7a8163ec2b5f2d08f459f59be459">mesos::internal::command::gzip</a></div><div class="ttdeci">process::Future&lt; Nothing &gt; gzip(const Path &amp;input)</div><div class="ttdoc">Compresses the given input file in GZIP format. </div></div>
<div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option&lt; Path &gt;</a></div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1command_html_ab14fc4c04c507bafcc3c10b4be19f728a27db3b98d01e664c17a6620b222c6469"><div class="ttname"><a href="namespacemesos_1_1internal_1_1command.html#ab14fc4c04c507bafcc3c10b4be19f728a27db3b98d01e664c17a6620b222c6469">mesos::internal::command::Compression::XZ</a></div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1command_html_ab14fc4c04c507bafcc3c10b4be19f728af1cd28417b03cfab3a8e16d66e34e18a"><div class="ttname"><a href="namespacemesos_1_1internal_1_1command.html#ab14fc4c04c507bafcc3c10b4be19f728af1cd28417b03cfab3a8e16d66e34e18a">mesos::internal::command::Compression::GZIP</a></div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1command_html_ace37bb3ed28b0e5dc3bc151ac9ffe011"><div class="ttname"><a href="namespacemesos_1_1internal_1_1command.html#ace37bb3ed28b0e5dc3bc151ac9ffe011">mesos::internal::command::sha512</a></div><div class="ttdeci">process::Future&lt; std::string &gt; sha512(const Path &amp;input)</div><div class="ttdoc">Computes SHA 512 checksum of a file. </div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1command_html_a298fb91e3560074658b123b93ec8d26c"><div class="ttname"><a href="namespacemesos_1_1internal_1_1command.html#a298fb91e3560074658b123b93ec8d26c">mesos::internal::command::untar</a></div><div class="ttdeci">process::Future&lt; Nothing &gt; untar(const Path &amp;input, const Option&lt; Path &gt; &amp;directory=None())</div><div class="ttdoc">Untar(unarchive) the given file. </div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1command_html_a6fa52ad212c7cc54ddcca193bb3bc5a4"><div class="ttname"><a href="namespacemesos_1_1internal_1_1command.html#a6fa52ad212c7cc54ddcca193bb3bc5a4">mesos::internal::command::tar</a></div><div class="ttdeci">process::Future&lt; Nothing &gt; tar(const Path &amp;input, const Path &amp;output, const Option&lt; Path &gt; &amp;directory=None(), const Option&lt; Compression &gt; &amp;compression=None())</div><div class="ttdoc">Tar(archive) the file/directory to produce output file. </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_1internal_1_1command_html_ab14fc4c04c507bafcc3c10b4be19f728"><div class="ttname"><a href="namespacemesos_1_1internal_1_1command.html#ab14fc4c04c507bafcc3c10b4be19f728">mesos::internal::command::Compression</a></div><div class="ttdeci">Compression</div><div class="ttdef"><b>Definition:</b> command_utils.hpp:29</div></div>
<div class="ttc" id="path_8hpp_html"><div class="ttname"><a href="path_8hpp.html">path.hpp</a></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="namespacemesos_1_1internal_1_1command_html_a4f230f32dd37430f4a9da1e66fe9888d"><div class="ttname"><a href="namespacemesos_1_1internal_1_1command.html#a4f230f32dd37430f4a9da1e66fe9888d">mesos::internal::command::decompress</a></div><div class="ttdeci">process::Future&lt; Nothing &gt; decompress(const Path &amp;input)</div><div class="ttdoc">Decompresses given input file based on its compression format. </div></div>
<div class="ttc" id="structNone_html"><div class="ttname"><a href="structNone.html">None</a></div><div class="ttdef"><b>Definition:</b> none.hpp:27</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1command_html_ab14fc4c04c507bafcc3c10b4be19f728a800edd55a1e18b397e3d5d826f85ce34"><div class="ttname"><a href="namespacemesos_1_1internal_1_1command.html#ab14fc4c04c507bafcc3c10b4be19f728a800edd55a1e18b397e3d5d826f85ce34">mesos::internal::command::Compression::BZIP2</a></div></div>
<div class="ttc" id="libprocess_2include_2process_2process_8hpp_html"><div class="ttname"><a href="libprocess_2include_2process_2process_8hpp.html">process.hpp</a></div></div>
<div class="ttc" id="classprocess_1_1Future_html"><div class="ttname"><a href="classprocess_1_1Future.html">process::Future&lt; Nothing &gt;</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>