| <!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: docker::spec 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="namespacedocker.html">docker</a></li><li class="navelem"><a class="el" href="namespacedocker_1_1spec.html">spec</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#namespaces">Namespaces</a> | |
| <a href="#func-members">Functions</a> | |
| <a href="#var-members">Variables</a> </div> |
| <div class="headertitle"> |
| <div class="title">docker::spec Namespace Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> |
| Namespaces</h2></td></tr> |
| <tr class="memitem:namespacedocker_1_1spec_1_1v1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedocker_1_1spec_1_1v1.html">v1</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:namespacedocker_1_1spec_1_1v2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedocker_1_1spec_1_1v2.html">v2</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:ae97b1ad01a0dc4023e66d4d64ad03918"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTry.html">Try</a>< ImageReference > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedocker_1_1spec.html#ae97b1ad01a0dc4023e66d4d64ad03918">parseImageReference</a> (const std::string &s)</td></tr> |
| <tr class="memdesc:ae97b1ad01a0dc4023e66d4d64ad03918"><td class="mdescLeft"> </td><td class="mdescRight">Parse the docker image reference. <a href="#ae97b1ad01a0dc4023e66d4d64ad03918">More...</a><br/></td></tr> |
| <tr class="separator:ae97b1ad01a0dc4023e66d4d64ad03918"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad8e529f836f39b93d35ae8e8906d22f5"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedocker_1_1spec.html#ad8e529f836f39b93d35ae8e8906d22f5">operator<<</a> (std::ostream &stream, const ImageReference &reference)</td></tr> |
| <tr class="separator:ad8e529f836f39b93d35ae8e8906d22f5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2447335923b7828ca358737b434f9c84"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classResult.html">Result</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedocker_1_1spec.html#a2447335923b7828ca358737b434f9c84">getRegistryPort</a> (const std::string &registry)</td></tr> |
| <tr class="memdesc:a2447335923b7828ca358737b434f9c84"><td class="mdescLeft"> </td><td class="mdescRight">Returns the port of a docker registry. <a href="#a2447335923b7828ca358737b434f9c84">More...</a><br/></td></tr> |
| <tr class="separator:a2447335923b7828ca358737b434f9c84"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aee13764dfda2fe6922fca9d55b8b1722"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTry.html">Try</a>< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedocker_1_1spec.html#aee13764dfda2fe6922fca9d55b8b1722">getRegistryScheme</a> (const std::string &registry)</td></tr> |
| <tr class="memdesc:aee13764dfda2fe6922fca9d55b8b1722"><td class="mdescLeft"> </td><td class="mdescRight">Returns the scheme of a docker registry. <a href="#aee13764dfda2fe6922fca9d55b8b1722">More...</a><br/></td></tr> |
| <tr class="separator:aee13764dfda2fe6922fca9d55b8b1722"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a431eea5222ff555e1f5722d7b18237af"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedocker_1_1spec.html#a431eea5222ff555e1f5722d7b18237af">getRegistryHost</a> (const std::string &registry)</td></tr> |
| <tr class="memdesc:a431eea5222ff555e1f5722d7b18237af"><td class="mdescLeft"> </td><td class="mdescRight">Returns the host of a docker registry. <a href="#a431eea5222ff555e1f5722d7b18237af">More...</a><br/></td></tr> |
| <tr class="separator:a431eea5222ff555e1f5722d7b18237af"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a15025401a33e0182a9d48f231cdb1177"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTry.html">Try</a>< <a class="el" href="classhashmap.html">hashmap</a>< std::string, <br class="typebreak"/> |
| Config::Auth > > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedocker_1_1spec.html#a15025401a33e0182a9d48f231cdb1177">parseAuthConfig</a> (const <a class="el" href="structJSON_1_1Object.html">JSON::Object</a> &_config)</td></tr> |
| <tr class="memdesc:a15025401a33e0182a9d48f231cdb1177"><td class="mdescLeft"> </td><td class="mdescRight">Returns the hashmap<registry_URL, spec::DockerConfigAuth> by parsing the docker config file. <a href="#a15025401a33e0182a9d48f231cdb1177">More...</a><br/></td></tr> |
| <tr class="separator:a15025401a33e0182a9d48f231cdb1177"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a00cf3a524412204d262986efeb28a71d"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedocker_1_1spec.html#a00cf3a524412204d262986efeb28a71d">parseAuthUrl</a> (const std::string &_url)</td></tr> |
| <tr class="memdesc:a00cf3a524412204d262986efeb28a71d"><td class="mdescLeft"> </td><td class="mdescRight">Find the host from a docker config auth url. <a href="#a00cf3a524412204d262986efeb28a71d">More...</a><br/></td></tr> |
| <tr class="separator:a00cf3a524412204d262986efeb28a71d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> |
| Variables</h2></td></tr> |
| <tr class="memitem:accd3285d08e68f60d53cd744210f564f"><td class="memItemLeft" align="right" valign="top">constexpr char </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedocker_1_1spec.html#accd3285d08e68f60d53cd744210f564f">WHITEOUT_PREFIX</a> [] = ".wh."</td></tr> |
| <tr class="separator:accd3285d08e68f60d53cd744210f564f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa24c4b17cbec1269257b75e62574b70f"><td class="memItemLeft" align="right" valign="top">constexpr char </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedocker_1_1spec.html#aa24c4b17cbec1269257b75e62574b70f">WHITEOUT_OPAQUE_PREFIX</a> [] = ".wh..wh..opq"</td></tr> |
| <tr class="separator:aa24c4b17cbec1269257b75e62574b70f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a class="anchor" id="a431eea5222ff555e1f5722d7b18237af"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string docker::spec::getRegistryHost </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>registry</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the host of a docker registry. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2447335923b7828ca358737b434f9c84"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classResult.html">Result</a><int> docker::spec::getRegistryPort </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>registry</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the port of a docker registry. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aee13764dfda2fe6922fca9d55b8b1722"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classTry.html">Try</a><std::string> docker::spec::getRegistryScheme </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>registry</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the scheme of a docker registry. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad8e529f836f39b93d35ae8e8906d22f5"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::ostream& docker::spec::operator<< </td> |
| <td>(</td> |
| <td class="paramtype">std::ostream & </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const ImageReference & </td> |
| <td class="paramname"><em>reference</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a15025401a33e0182a9d48f231cdb1177"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classTry.html">Try</a><<a class="el" href="classhashmap.html">hashmap</a><std::string, Config::Auth> > docker::spec::parseAuthConfig </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structJSON_1_1Object.html">JSON::Object</a> & </td> |
| <td class="paramname"><em>_config</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the hashmap<registry_URL, spec::DockerConfigAuth> by parsing the docker config file. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a00cf3a524412204d262986efeb28a71d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string docker::spec::parseAuthUrl </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>_url</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Find the host from a docker config auth url. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae97b1ad01a0dc4023e66d4d64ad03918"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classTry.html">Try</a><ImageReference> docker::spec::parseImageReference </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>s</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Parse the docker image reference. </p> |
| <p><a class="el" href="classDocker.html">Docker</a> expects the image reference to be in the following format: [REGISTRY_HOST[:REGISTRY_PORT]/]REPOSITORY[:TAG|:DIGEST]</p> |
| <p>This format is inherently ambiguous when dealing with repository names that include forward slashes. To disambiguate, the docker code looks for '.', or ':', or 'localhost' to decide if the first component is a registry or a repository name. For more detail, drill into the implementation of docker pull.</p> |
| <p>See docker implementation: <a href="https://github.com/docker/distribution/blob/master/reference/reference.go">https://github.com/docker/distribution/blob/master/reference/reference.go</a> </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Variable Documentation</h2> |
| <a class="anchor" id="aa24c4b17cbec1269257b75e62574b70f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">constexpr char docker::spec::WHITEOUT_OPAQUE_PREFIX[] = ".wh..wh..opq"</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="accd3285d08e68f60d53cd744210f564f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">constexpr char docker::spec::WHITEOUT_PREFIX[] = ".wh."</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </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> |
