| <!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: mesos::roles Namespace Reference</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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li><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="namespaces.html"><span>Namespace List</span></a></li> |
| <li><a href="namespacemembers.html"><span>Namespace Members</span></a></li> |
| </ul> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacemesos.html">mesos</a></li><li class="navelem"><a class="el" href="namespacemesos_1_1roles.html">roles</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">mesos::roles Namespace Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a6524417fdb4cb70c9f02354efe71ff57"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTry.html">Try</a>< std::vector< std::string > > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemesos_1_1roles.html#a6524417fdb4cb70c9f02354efe71ff57">parse</a> (const std::string &text)</td></tr> |
| <tr class="memdesc:a6524417fdb4cb70c9f02354efe71ff57"><td class="mdescLeft"> </td><td class="mdescRight">Parses Roles from text in the form "role1,role2,role3". <a href="#a6524417fdb4cb70c9f02354efe71ff57">More...</a><br/></td></tr> |
| <tr class="separator:a6524417fdb4cb70c9f02354efe71ff57"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa33464e694d17fab588e0ff5dce69701"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOption.html">Option</a>< <a class="el" href="classError.html">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemesos_1_1roles.html#aa33464e694d17fab588e0ff5dce69701">validate</a> (const std::string &role)</td></tr> |
| <tr class="memdesc:aa33464e694d17fab588e0ff5dce69701"><td class="mdescLeft"> </td><td class="mdescRight">Validates the given role name. <a href="#aa33464e694d17fab588e0ff5dce69701">More...</a><br/></td></tr> |
| <tr class="separator:aa33464e694d17fab588e0ff5dce69701"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1ac27bb0abea2900fdaa4a53ff7931e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOption.html">Option</a>< <a class="el" href="classError.html">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemesos_1_1roles.html#a1ac27bb0abea2900fdaa4a53ff7931e2">validate</a> (const std::vector< std::string > &roles)</td></tr> |
| <tr class="memdesc:a1ac27bb0abea2900fdaa4a53ff7931e2"><td class="mdescLeft"> </td><td class="mdescRight">Validates the given list of roles. <a href="#a1ac27bb0abea2900fdaa4a53ff7931e2">More...</a><br/></td></tr> |
| <tr class="separator:a1ac27bb0abea2900fdaa4a53ff7931e2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a class="anchor" id="a6524417fdb4cb70c9f02354efe71ff57"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classTry.html">Try</a><std::vector<std::string> > mesos::roles::parse </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>s</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Parses Roles from text in the form "role1,role2,role3". </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">text</td><td>String to be parsed </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classError.html">Error</a> if validation fails, otherwise a list of role names.</dd></dl> |
| <p>Parses Roles from text in the form "role1,role2,role3".</p> |
| <p>Returns the OCI <a class="el" href="namespacemesos_1_1v1.html">v1</a> descriptor, image index, image manifest and image configuration from the given string.</p> |
| <p>Returns the docker v2 image manifest from the given string. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa33464e694d17fab588e0ff5dce69701"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classOption.html">Option</a><<a class="el" href="classError.html">Error</a>> mesos::roles::validate </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>role</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Validates the given role name. </p> |
| <p>A role name must be a valid directory name, so it cannot:</p> |
| <ul> |
| <li>Be an empty string</li> |
| <li>Be <code>.</code> or <code>..</code></li> |
| <li>Start with <code>-</code></li> |
| <li>Contain invalid characters (slash, backspace, or whitespace).</li> |
| </ul> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">role</td><td>Role name to be validated </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classError.html">Error</a> if validation fails for any role, <a class="el" href="structNone.html">None</a> otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1ac27bb0abea2900fdaa4a53ff7931e2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classOption.html">Option</a><<a class="el" href="classError.html">Error</a>> mesos::roles::validate </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< std::string > & </td> |
| <td class="paramname"><em>roles</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Validates the given list of roles. </p> |
| <p>Returns <a class="el" href="classError.html">Error</a> if any role is invalid.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">roles</td><td>List of role names to be validated </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classError.html">Error</a> if validation fails, <a class="el" href="structNone.html">None</a> otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| </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> |
