| <!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: proton/url.h 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="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&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 |
|  <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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('url_8h_source.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="headertitle"> |
| <div class="title">url.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="url_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"><a class="line" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea"> 1</a></span> <span class="preprocessor">#ifndef PROTON_URL_H</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_URL_H 1</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <proton/import_export.h></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> <a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a>;</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> PN_DEPRECATED(<span class="stringliteral">"Use a third-party URL library"</span>)</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="group__url.html#ga8b19840fe7ff1166c6583a7445eed325"> 47</a></span> PNX_EXTERN <a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *<a class="code" href="group__url.html#ga8b19840fe7ff1166c6583a7445eed325">pn_url</a>(<span class="keywordtype">void</span>);</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="group__url.html#gaaa9f2f29b90525fbf73739cae8b84776"> 68</a></span> PNX_EXTERN <a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *<a class="code" href="group__url.html#gaaa9f2f29b90525fbf73739cae8b84776">pn_url_parse</a>(const <span class="keywordtype">char</span> *url);</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="group__url.html#gab65d8b2c49f5e3f720cea8a3c1a1e6d1"> 74</a></span> PNX_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__url.html#gab65d8b2c49f5e3f720cea8a3c1a1e6d1">pn_url_free</a>(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url);</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="group__url.html#ga2f7548b8247ebddc8be3f0f5ebce151b"> 80</a></span> PNX_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__url.html#ga2f7548b8247ebddc8be3f0f5ebce151b">pn_url_clear</a>(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url);</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="group__url.html#ga7e10d384560ab3e2bc9bbe219883e21d"> 89</a></span> PNX_EXTERN const <span class="keywordtype">char</span> *<a class="code" href="group__url.html#ga7e10d384560ab3e2bc9bbe219883e21d">pn_url_str</a>(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url);</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> PNX_EXTERN const <span class="keywordtype">char</span> *pn_url_get_scheme(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url);</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> PNX_EXTERN const <span class="keywordtype">char</span> *pn_url_get_username(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url);</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> PNX_EXTERN const <span class="keywordtype">char</span> *pn_url_get_password(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url);</div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> PNX_EXTERN const <span class="keywordtype">char</span> *pn_url_get_host(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url);</div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> PNX_EXTERN const <span class="keywordtype">char</span> *pn_url_get_port(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url);</div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> PNX_EXTERN const <span class="keywordtype">char</span> *pn_url_get_path(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url);</div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> PNX_EXTERN <span class="keywordtype">void</span> pn_url_set_scheme(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url, const <span class="keywordtype">char</span> *scheme);</div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> PNX_EXTERN <span class="keywordtype">void</span> pn_url_set_username(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url, const <span class="keywordtype">char</span> *username);</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> PNX_EXTERN <span class="keywordtype">void</span> pn_url_set_password(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url, const <span class="keywordtype">char</span> *password);</div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> PNX_EXTERN <span class="keywordtype">void</span> pn_url_set_host(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url, const <span class="keywordtype">char</span> *host);</div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> PNX_EXTERN <span class="keywordtype">void</span> pn_url_set_port(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url, const <span class="keywordtype">char</span> *port);</div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> PN_DEPRECATED("Use a third-party URL library")</div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> PNX_EXTERN <span class="keywordtype">void</span> pn_url_set_path(<a class="code" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url, const <span class="keywordtype">char</span> *path);</div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> }</div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div> |
| <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor">#endif </span><span class="comment">/* url.h */</span><span class="preprocessor"></span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <div class="ttc" id="agroup__url_html_ga7e10d384560ab3e2bc9bbe219883e21d"><div class="ttname"><a href="group__url.html#ga7e10d384560ab3e2bc9bbe219883e21d">pn_url_str</a></div><div class="ttdeci">const char * pn_url_str(pn_url_t *url)</div><div class="ttdoc">Return the string form of a URL.</div></div> |
| <div class="ttc" id="agroup__url_html_ga2f7548b8247ebddc8be3f0f5ebce151b"><div class="ttname"><a href="group__url.html#ga2f7548b8247ebddc8be3f0f5ebce151b">pn_url_clear</a></div><div class="ttdeci">void pn_url_clear(pn_url_t *url)</div><div class="ttdoc">Clear the contents of the URL.</div></div> |
| <div class="ttc" id="agroup__url_html_gafbe4340c29b1abd7394767456ad3b8ea"><div class="ttname"><a href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a></div><div class="ttdeci">struct pn_url_t pn_url_t</div><div class="ttdoc">A parsed URL.</div><div class="ttdef"><b>Definition:</b> url.h:41</div></div> |
| <div class="ttc" id="agroup__url_html_gab65d8b2c49f5e3f720cea8a3c1a1e6d1"><div class="ttname"><a href="group__url.html#gab65d8b2c49f5e3f720cea8a3c1a1e6d1">pn_url_free</a></div><div class="ttdeci">void pn_url_free(pn_url_t *url)</div><div class="ttdoc">Free a URL.</div></div> |
| <div class="ttc" id="agroup__url_html_gaaa9f2f29b90525fbf73739cae8b84776"><div class="ttname"><a href="group__url.html#gaaa9f2f29b90525fbf73739cae8b84776">pn_url_parse</a></div><div class="ttdeci">pn_url_t * pn_url_parse(const char *url)</div><div class="ttdoc">Parse a string URL as a pn_url_t.</div></div> |
| <div class="ttc" id="agroup__url_html_ga8b19840fe7ff1166c6583a7445eed325"><div class="ttname"><a href="group__url.html#ga8b19840fe7ff1166c6583a7445eed325">pn_url</a></div><div class="ttdeci">pn_url_t * pn_url(void)</div><div class="ttdoc">Create an empty URL.</div></div> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="url_8h.html">url.h</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> |
