blob: 0f6bc8fc006c079f8a0ae1406ebd452440ca0429 [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/validation.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">validation.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="common_2validation_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_VALIDATION_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_VALIDATION_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;string&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="include_2mesos_2mesos_8hpp.html">mesos/mesos.hpp</a>&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="error_8hpp.html">stout/error.hpp</a>&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</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="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span>mesos {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">namespace </span>internal {</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespacemesos_1_1internal_1_1common.html"> 29</a></span>&#160;<span class="keyword">namespace </span>common {</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="namespacemesos_1_1internal_1_1common_1_1validation.html"> 30</a></span>&#160;<span class="keyword">namespace </span>validation {</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"> 32</span>&#160;<span class="comment">// Validates if `id` meets the common requirements for IDs in Mesos.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment">// Note that some IDs in Mesos have additional/stricter requirements.</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<a class="code" href="classOption.html">Option&lt;Error&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1common_1_1validation.html#a48a2225e397b2024f2a617a01636cb34">validateID</a>(<span class="keyword">const</span> std::string&amp; <span class="keywordtype">id</span>);</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;<a class="code" href="classOption.html">Option&lt;Error&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1common_1_1validation.html#a48e58d38ca3563e082886f5b893f1a03">validateTaskID</a>(<span class="keyword">const</span> TaskID&amp; taskId);</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"> 38</span>&#160;<a class="code" href="classOption.html">Option&lt;Error&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1common_1_1validation.html#a840e0598dcc3c9a99a45fa5f3cf9619a">validateExecutorID</a>(<span class="keyword">const</span> ExecutorID&amp; executorId);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<a class="code" href="classOption.html">Option&lt;Error&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1common_1_1validation.html#aab590984496c9626e4bb3921693c708d">validateSlaveID</a>(<span class="keyword">const</span> SlaveID&amp; slaveId);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<a class="code" href="classOption.html">Option&lt;Error&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1common_1_1validation.html#a259b461a47004bdf977c6ff1b39fddcb">validateFrameworkID</a>(<span class="keyword">const</span> FrameworkID&amp; frameworkId);</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;<a class="code" href="classOption.html">Option&lt;Error&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1common_1_1validation.html#aae8bca9dce8b75faae743822547ba10c">validateSecret</a>(<span class="keyword">const</span> Secret&amp; secret);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<a class="code" href="classOption.html">Option&lt;Error&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1common_1_1validation.html#afa925189ea3e309d4a4b2531cdc5b386">validateEnvironment</a>(<span class="keyword">const</span> Environment&amp; <a class="code" href="namespacemesos_1_1internal_1_1tests.html#a1396c5e3b0a179220de2792d74770ec2">environment</a>);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<a class="code" href="classOption.html">Option&lt;Error&gt;</a> <a class="code" href="namespacemesos_1_1internal_1_1common_1_1validation.html#afb728578ef87e1dd707851482b14011b">validateCommandInfo</a>(<span class="keyword">const</span> CommandInfo&amp; command);</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">// namespace validation {</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;} <span class="comment">// namespace common {</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;} <span class="comment">// namespace internal {</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;} <span class="comment">// namespace mesos {</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor">#endif // __COMMON_VALIDATION_HPP__</span></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1common_1_1validation_html_a259b461a47004bdf977c6ff1b39fddcb"><div class="ttname"><a href="namespacemesos_1_1internal_1_1common_1_1validation.html#a259b461a47004bdf977c6ff1b39fddcb">mesos::internal::common::validation::validateFrameworkID</a></div><div class="ttdeci">Option&lt; Error &gt; validateFrameworkID(const FrameworkID &amp;frameworkId)</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1common_1_1validation_html_a48a2225e397b2024f2a617a01636cb34"><div class="ttname"><a href="namespacemesos_1_1internal_1_1common_1_1validation.html#a48a2225e397b2024f2a617a01636cb34">mesos::internal::common::validation::validateID</a></div><div class="ttdeci">Option&lt; Error &gt; validateID(const std::string &amp;id)</div></div>
<div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option&lt; Error &gt;</a></div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1common_1_1validation_html_aae8bca9dce8b75faae743822547ba10c"><div class="ttname"><a href="namespacemesos_1_1internal_1_1common_1_1validation.html#aae8bca9dce8b75faae743822547ba10c">mesos::internal::common::validation::validateSecret</a></div><div class="ttdeci">Option&lt; Error &gt; validateSecret(const Secret &amp;secret)</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1common_1_1validation_html_afa925189ea3e309d4a4b2531cdc5b386"><div class="ttname"><a href="namespacemesos_1_1internal_1_1common_1_1validation.html#afa925189ea3e309d4a4b2531cdc5b386">mesos::internal::common::validation::validateEnvironment</a></div><div class="ttdeci">Option&lt; Error &gt; validateEnvironment(const Environment &amp;environment)</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="namespacemesos_1_1internal_1_1common_1_1validation_html_afb728578ef87e1dd707851482b14011b"><div class="ttname"><a href="namespacemesos_1_1internal_1_1common_1_1validation.html#afb728578ef87e1dd707851482b14011b">mesos::internal::common::validation::validateCommandInfo</a></div><div class="ttdeci">Option&lt; Error &gt; validateCommandInfo(const CommandInfo &amp;command)</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1common_1_1validation_html_aab590984496c9626e4bb3921693c708d"><div class="ttname"><a href="namespacemesos_1_1internal_1_1common_1_1validation.html#aab590984496c9626e4bb3921693c708d">mesos::internal::common::validation::validateSlaveID</a></div><div class="ttdeci">Option&lt; Error &gt; validateSlaveID(const SlaveID &amp;slaveId)</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1tests_html_a1396c5e3b0a179220de2792d74770ec2"><div class="ttname"><a href="namespacemesos_1_1internal_1_1tests.html#a1396c5e3b0a179220de2792d74770ec2">mesos::internal::tests::environment</a></div><div class="ttdeci">Environment * environment</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="namespacemesos_1_1internal_1_1common_1_1validation_html_a840e0598dcc3c9a99a45fa5f3cf9619a"><div class="ttname"><a href="namespacemesos_1_1internal_1_1common_1_1validation.html#a840e0598dcc3c9a99a45fa5f3cf9619a">mesos::internal::common::validation::validateExecutorID</a></div><div class="ttdeci">Option&lt; Error &gt; validateExecutorID(const ExecutorID &amp;executorId)</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1common_1_1validation_html_a48e58d38ca3563e082886f5b893f1a03"><div class="ttname"><a href="namespacemesos_1_1internal_1_1common_1_1validation.html#a48e58d38ca3563e082886f5b893f1a03">mesos::internal::common::validation::validateTaskID</a></div><div class="ttdeci">Option&lt; Error &gt; validateTaskID(const TaskID &amp;taskId)</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>