Google Git
Sign in
apache / qpid-site / 04beb6e78eda47fdfc2fcfc1d2eeb9a270f89a87 / . / input / releases / qpid-proton-0.32.0 / proton / cpp / api / classproton_1_1url.html
blob: 4c664e3171c3fe03518d6bc4cca563fa48b85bbf [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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C++ API: url</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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">Qpid Proton C++ API
&#160;<span id="projectnumber">0.32.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classproton_1_1url.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classproton_1_1url-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">url</div> </div>
</div><!--header-->
<div class="contents">
<p><b>Deprecated</b> - Use a third-party URL library.
<a href="classproton_1_1url.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="url_8hpp_source.html">url.hpp</a>&gt;</code></p>
<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:a2ac6e124f5c2a7a3c8464099b5c4fde7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a2ac6e124f5c2a7a3c8464099b5c4fde7">url</a> (const std::string &amp;url_str)</td></tr>
<tr class="memdesc:a2ac6e124f5c2a7a3c8464099b5c4fde7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse <code>url_str</code> as an AMQP URL. <a href="classproton_1_1url.html#a2ac6e124f5c2a7a3c8464099b5c4fde7">More...</a><br /></td></tr>
<tr class="separator:a2ac6e124f5c2a7a3c8464099b5c4fde7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0665da617d0ca28be2721c5f16368dd5"><td class="memItemLeft" align="right" valign="top"><a id="a0665da617d0ca28be2721c5f16368dd5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a0665da617d0ca28be2721c5f16368dd5">url</a> (const <a class="el" href="classproton_1_1url.html">url</a> &amp;)</td></tr>
<tr class="memdesc:a0665da617d0ca28be2721c5f16368dd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy a URL. <br /></td></tr>
<tr class="separator:a0665da617d0ca28be2721c5f16368dd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b36f225c464c30fdf521b23d24761e4"><td class="memItemLeft" align="right" valign="top"><a id="a6b36f225c464c30fdf521b23d24761e4"></a>
<a class="el" href="classproton_1_1url.html">url</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a6b36f225c464c30fdf521b23d24761e4">operator=</a> (const <a class="el" href="classproton_1_1url.html">url</a> &amp;)</td></tr>
<tr class="memdesc:a6b36f225c464c30fdf521b23d24761e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy a URL. <br /></td></tr>
<tr class="separator:a6b36f225c464c30fdf521b23d24761e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="memItemLeft" align="right" valign="top"><a id="a644718bb2fb240de962dc3c9a1fdf0dc"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a644718bb2fb240de962dc3c9a1fdf0dc">empty</a> () const</td></tr>
<tr class="memdesc:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the URL is empty. <br /></td></tr>
<tr class="separator:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3888dcd59dd5acd1ca5b9bee4c2e252a"><td class="memItemLeft" align="right" valign="top"><a id="a3888dcd59dd5acd1ca5b9bee4c2e252a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a3888dcd59dd5acd1ca5b9bee4c2e252a">operator std::string</a> () const</td></tr>
<tr class="memdesc:a3888dcd59dd5acd1ca5b9bee4c2e252a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the URL as a string. <br /></td></tr>
<tr class="separator:a3888dcd59dd5acd1ca5b9bee4c2e252a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">URL fields</div></td></tr>
<tr class="memitem:a92a94824a297a0a35f69f91309f4f484"><td class="memItemLeft" align="right" valign="top"><a id="a92a94824a297a0a35f69f91309f4f484"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a92a94824a297a0a35f69f91309f4f484">scheme</a> () const</td></tr>
<tr class="memdesc:a92a94824a297a0a35f69f91309f4f484"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code>amqp</code> or <code>amqps</code>. <br /></td></tr>
<tr class="separator:a92a94824a297a0a35f69f91309f4f484"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9444df7d81bd265e0a8e1726fd12b058"><td class="memItemLeft" align="right" valign="top"><a id="a9444df7d81bd265e0a8e1726fd12b058"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a9444df7d81bd265e0a8e1726fd12b058">user</a> () const</td></tr>
<tr class="memdesc:a9444df7d81bd265e0a8e1726fd12b058"><td class="mdescLeft">&#160;</td><td class="mdescRight">The user name for authentication. <br /></td></tr>
<tr class="separator:a9444df7d81bd265e0a8e1726fd12b058"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d831b27c411bf8939849914c29e452e"><td class="memItemLeft" align="right" valign="top"><a id="a7d831b27c411bf8939849914c29e452e"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a7d831b27c411bf8939849914c29e452e">password</a> () const</td></tr>
<tr class="memdesc:a7d831b27c411bf8939849914c29e452e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The password. <br /></td></tr>
<tr class="separator:a7d831b27c411bf8939849914c29e452e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f0eba713a692bc0aa00b2b8ec0e9ba1"><td class="memItemLeft" align="right" valign="top"><a id="a5f0eba713a692bc0aa00b2b8ec0e9ba1"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a5f0eba713a692bc0aa00b2b8ec0e9ba1">host</a> () const</td></tr>
<tr class="memdesc:a5f0eba713a692bc0aa00b2b8ec0e9ba1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The host name or IP address. <br /></td></tr>
<tr class="separator:a5f0eba713a692bc0aa00b2b8ec0e9ba1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f16e8b68942ad0d21494d056b4e13d7"><td class="memItemLeft" align="right" valign="top"><a id="a6f16e8b68942ad0d21494d056b4e13d7"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a6f16e8b68942ad0d21494d056b4e13d7">port</a> () const</td></tr>
<tr class="memdesc:a6f16e8b68942ad0d21494d056b4e13d7"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code>port</code> can be a number or a symbolic name such as "amqp". <br /></td></tr>
<tr class="separator:a6f16e8b68942ad0d21494d056b4e13d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa54f07362c271f7f550c3f904022329b"><td class="memItemLeft" align="right" valign="top"><a id="aa54f07362c271f7f550c3f904022329b"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#aa54f07362c271f7f550c3f904022329b">port_int</a> () const</td></tr>
<tr class="memdesc:aa54f07362c271f7f550c3f904022329b"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code>port_int</code> is the numeric value of the port. <br /></td></tr>
<tr class="separator:aa54f07362c271f7f550c3f904022329b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a36cd36a47626cec96d0803dd3a9594"><td class="memItemLeft" align="right" valign="top"><a id="a0a36cd36a47626cec96d0803dd3a9594"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a0a36cd36a47626cec96d0803dd3a9594">host_port</a> () const</td></tr>
<tr class="memdesc:a0a36cd36a47626cec96d0803dd3a9594"><td class="mdescLeft">&#160;</td><td class="mdescRight">host_port returns just the <code>host:port</code> part of the URL <br /></td></tr>
<tr class="separator:a0a36cd36a47626cec96d0803dd3a9594"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4cb5f95f1d720ef0cc94b74152cf50b"><td class="memItemLeft" align="right" valign="top"><a id="ac4cb5f95f1d720ef0cc94b74152cf50b"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#ac4cb5f95f1d720ef0cc94b74152cf50b">path</a> () const</td></tr>
<tr class="memdesc:ac4cb5f95f1d720ef0cc94b74152cf50b"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code>path</code> is everything after the final "/". <br /></td></tr>
<tr class="separator:ac4cb5f95f1d720ef0cc94b74152cf50b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:af0f2c496befc10e2fc0cf4999a733b4c"><td class="memItemLeft" align="right" valign="top"><a id="af0f2c496befc10e2fc0cf4999a733b4c"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#af0f2c496befc10e2fc0cf4999a733b4c">AMQP</a></td></tr>
<tr class="memdesc:af0f2c496befc10e2fc0cf4999a733b4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">"amqp" prefix <br /></td></tr>
<tr class="separator:af0f2c496befc10e2fc0cf4999a733b4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2756fc4457346e3df1cc83fbfac6275b"><td class="memItemLeft" align="right" valign="top"><a id="a2756fc4457346e3df1cc83fbfac6275b"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a2756fc4457346e3df1cc83fbfac6275b">AMQPS</a></td></tr>
<tr class="memdesc:a2756fc4457346e3df1cc83fbfac6275b"><td class="mdescLeft">&#160;</td><td class="mdescRight">"amqps" prefix <br /></td></tr>
<tr class="separator:a2756fc4457346e3df1cc83fbfac6275b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a348cf3a521a7c6de31462917c8ab4364"><td class="memItemLeft" align="right" valign="top"><a id="a348cf3a521a7c6de31462917c8ab4364"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1url.html#a348cf3a521a7c6de31462917c8ab4364">to_string</a> (const <a class="el" href="classproton_1_1url.html">url</a> &amp;)</td></tr>
<tr class="memdesc:a348cf3a521a7c6de31462917c8ab4364"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return URL as a string. <br /></td></tr>
<tr class="separator:a348cf3a521a7c6de31462917c8ab4364"><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><b>Deprecated</b> - Use a third-party URL library. </p>
<p>A URL parser.</p>
<p>Proton URLs take the form <code>&lt;scheme&gt;://&lt;username&gt;:&lt;password&gt;@&lt;host&gt;:&lt;port&gt;/&lt;path&gt;</code>.</p>
<ul>
<li>Scheme can be <code>amqp</code> or <code>amqps</code>. Host is a DNS name or IP address (v4 or v6).</li>
<li>Port can be a number or a symbolic service name such as <code>amqp</code>.</li>
<li>Path is normally used as a link source or target address. On a broker it typically corresponds to a queue or topic name. </li>
</ul>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2ac6e124f5c2a7a3c8464099b5c4fde7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ac6e124f5c2a7a3c8464099b5c4fde7">&#9670;&nbsp;</a></span>url()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1url.html">url</a> </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>url_str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse <code>url_str</code> as an AMQP URL. </p>
<dl class="section note"><dt>Note</dt><dd>Converts automatically from string. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="structproton_1_1url__error.html" title="Deprecated - Use a third-party URL library.">url_error</a></td><td>if URL is invalid. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>proton/<a class="el" href="url_8hpp_source.html">url.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="classproton_1_1url.html">url</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>