Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / master / api / cpp / docs / api / structdmlc_1_1io_1_1URI.html
blob: 53e4e23856e842e88c214ecfedf2923ea11d0cfc [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: dmlc::io::URI Struct 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="namespacedmlc_1_1io.html">io</a></li><li class="navelem"><a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structdmlc_1_1io_1_1URI-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dmlc::io::URI Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>common data structure for <a class="el" href="structdmlc_1_1io_1_1URI.html" title="common data structure for URI">URI</a>
<a href="structdmlc_1_1io_1_1URI.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h_source.html">io.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for dmlc::io::URI:</div>
<div class="dyncontent">
<div class="center"><img src="structdmlc_1_1io_1_1URI__coll__graph.png" border="0" usemap="#dmlc_1_1io_1_1URI_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae8edd37a9babb583d2edca1ac3a59162"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1io_1_1URI.html#ae8edd37a9babb583d2edca1ac3a59162">URI</a> (void)</td></tr>
<tr class="memdesc:ae8edd37a9babb583d2edca1ac3a59162"><td class="mdescLeft">&#160;</td><td class="mdescRight">enable default constructor <a href="structdmlc_1_1io_1_1URI.html#ae8edd37a9babb583d2edca1ac3a59162">More...</a><br /></td></tr>
<tr class="separator:ae8edd37a9babb583d2edca1ac3a59162"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48993d32687bd27d23a9f7ae56b364e5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1io_1_1URI.html#a48993d32687bd27d23a9f7ae56b364e5">URI</a> (const char *uri)</td></tr>
<tr class="memdesc:a48993d32687bd27d23a9f7ae56b364e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">construct from <a class="el" href="structdmlc_1_1io_1_1URI.html" title="common data structure for URI">URI</a> string <a href="structdmlc_1_1io_1_1URI.html#a48993d32687bd27d23a9f7ae56b364e5">More...</a><br /></td></tr>
<tr class="separator:a48993d32687bd27d23a9f7ae56b364e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6aefa55a0899302d926972f5cb47e8c3"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1io_1_1URI.html#a6aefa55a0899302d926972f5cb47e8c3">str</a> (void) const</td></tr>
<tr class="memdesc:a6aefa55a0899302d926972f5cb47e8c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">string representation <a href="structdmlc_1_1io_1_1URI.html#a6aefa55a0899302d926972f5cb47e8c3">More...</a><br /></td></tr>
<tr class="separator:a6aefa55a0899302d926972f5cb47e8c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a78b53e079a958bac413f49601670aa3b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1io_1_1URI.html#a78b53e079a958bac413f49601670aa3b">protocol</a></td></tr>
<tr class="memdesc:a78b53e079a958bac413f49601670aa3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">protocol <a href="structdmlc_1_1io_1_1URI.html#a78b53e079a958bac413f49601670aa3b">More...</a><br /></td></tr>
<tr class="separator:a78b53e079a958bac413f49601670aa3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a210e9bff4da5dac23a113da6526396f4"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1io_1_1URI.html#a210e9bff4da5dac23a113da6526396f4">host</a></td></tr>
<tr class="memdesc:a210e9bff4da5dac23a113da6526396f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">host name, namenode for HDFS, bucket name for s3 <a href="structdmlc_1_1io_1_1URI.html#a210e9bff4da5dac23a113da6526396f4">More...</a><br /></td></tr>
<tr class="separator:a210e9bff4da5dac23a113da6526396f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94b175008085c6dbdc1b76befe2afdef"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1io_1_1URI.html#a94b175008085c6dbdc1b76befe2afdef">name</a></td></tr>
<tr class="memdesc:a94b175008085c6dbdc1b76befe2afdef"><td class="mdescLeft">&#160;</td><td class="mdescRight">name of the path <a href="structdmlc_1_1io_1_1URI.html#a94b175008085c6dbdc1b76befe2afdef">More...</a><br /></td></tr>
<tr class="separator:a94b175008085c6dbdc1b76befe2afdef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>common data structure for <a class="el" href="structdmlc_1_1io_1_1URI.html" title="common data structure for URI">URI</a> </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae8edd37a9babb583d2edca1ac3a59162"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8edd37a9babb583d2edca1ac3a59162">&#9670;&nbsp;</a></span>URI() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dmlc::io::URI::URI </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></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>enable default constructor </p>
</div>
</div>
<a id="a48993d32687bd27d23a9f7ae56b364e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48993d32687bd27d23a9f7ae56b364e5">&#9670;&nbsp;</a></span>URI() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dmlc::io::URI::URI </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>uri</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>construct from <a class="el" href="structdmlc_1_1io_1_1URI.html" title="common data structure for URI">URI</a> string </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6aefa55a0899302d926972f5cb47e8c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6aefa55a0899302d926972f5cb47e8c3">&#9670;&nbsp;</a></span>str()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string dmlc::io::URI::str </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</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>string representation </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a210e9bff4da5dac23a113da6526396f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a210e9bff4da5dac23a113da6526396f4">&#9670;&nbsp;</a></span>host</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string dmlc::io::URI::host</td>
</tr>
</table>
</div><div class="memdoc">
<p>host name, namenode for HDFS, bucket name for s3 </p>
</div>
</div>
<a id="a94b175008085c6dbdc1b76befe2afdef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94b175008085c6dbdc1b76befe2afdef">&#9670;&nbsp;</a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string dmlc::io::URI::name</td>
</tr>
</table>
</div><div class="memdoc">
<p>name of the path </p>
</div>
</div>
<a id="a78b53e079a958bac413f49601670aa3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78b53e079a958bac413f49601670aa3b">&#9670;&nbsp;</a></span>protocol</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string dmlc::io::URI::protocol</td>
</tr>
</table>
</div><div class="memdoc">
<p>protocol </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h_source.html">io.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:40 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>