| <!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 File 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="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.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="#typedef-members">Typedefs</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">url.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><b>Deprecated</b> - Use a third-party URL library. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include <proton/import_export.h></code><br /> |
| </div> |
| <p><a href="url_8h_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> |
| Typedefs</h2></td></tr> |
| <tr class="memitem:gafbe4340c29b1abd7394767456ad3b8ea"><td class="memItemLeft" align="right" valign="top"> |
| typedef struct <a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a></td></tr> |
| <tr class="memdesc:gafbe4340c29b1abd7394767456ad3b8ea"><td class="mdescLeft"> </td><td class="mdescRight">A parsed URL. <br /></td></tr> |
| <tr class="separator:gafbe4340c29b1abd7394767456ad3b8ea"><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:ga8b19840fe7ff1166c6583a7445eed325"><td class="memItemLeft" align="right" valign="top"> |
| <a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__url.html#ga8b19840fe7ff1166c6583a7445eed325">pn_url</a> (void)</td></tr> |
| <tr class="memdesc:ga8b19840fe7ff1166c6583a7445eed325"><td class="mdescLeft"> </td><td class="mdescRight">Create an empty URL. <br /></td></tr> |
| <tr class="separator:ga8b19840fe7ff1166c6583a7445eed325"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaaa9f2f29b90525fbf73739cae8b84776"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__url.html#gaaa9f2f29b90525fbf73739cae8b84776">pn_url_parse</a> (const char *url)</td></tr> |
| <tr class="memdesc:gaaa9f2f29b90525fbf73739cae8b84776"><td class="mdescLeft"> </td><td class="mdescRight">Parse a string URL as a pn_url_t. <a href="group__url.html#gaaa9f2f29b90525fbf73739cae8b84776">More...</a><br /></td></tr> |
| <tr class="separator:gaaa9f2f29b90525fbf73739cae8b84776"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gab65d8b2c49f5e3f720cea8a3c1a1e6d1"><td class="memItemLeft" align="right" valign="top"> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__url.html#gab65d8b2c49f5e3f720cea8a3c1a1e6d1">pn_url_free</a> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url)</td></tr> |
| <tr class="memdesc:gab65d8b2c49f5e3f720cea8a3c1a1e6d1"><td class="mdescLeft"> </td><td class="mdescRight">Free a URL. <br /></td></tr> |
| <tr class="separator:gab65d8b2c49f5e3f720cea8a3c1a1e6d1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga2f7548b8247ebddc8be3f0f5ebce151b"><td class="memItemLeft" align="right" valign="top"> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__url.html#ga2f7548b8247ebddc8be3f0f5ebce151b">pn_url_clear</a> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url)</td></tr> |
| <tr class="memdesc:ga2f7548b8247ebddc8be3f0f5ebce151b"><td class="mdescLeft"> </td><td class="mdescRight">Clear the contents of the URL. <br /></td></tr> |
| <tr class="separator:ga2f7548b8247ebddc8be3f0f5ebce151b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga7e10d384560ab3e2bc9bbe219883e21d"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__url.html#ga7e10d384560ab3e2bc9bbe219883e21d">pn_url_str</a> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url)</td></tr> |
| <tr class="memdesc:ga7e10d384560ab3e2bc9bbe219883e21d"><td class="mdescLeft"> </td><td class="mdescRight">Return the string form of a URL. <a href="group__url.html#ga7e10d384560ab3e2bc9bbe219883e21d">More...</a><br /></td></tr> |
| <tr class="separator:ga7e10d384560ab3e2bc9bbe219883e21d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr><td colspan="2"><div class="groupHeader">Getters for parts of the URL.</div></td></tr> |
| <tr><td colspan="2"><div class="groupText"><p>Values belong to the URL.</p> |
| <p>May return NULL if the value is not set. </p> |
| </div></td></tr> |
| <tr class="memitem:ga9162f3f1ba4bc374f079f9c01c3dee99"><td class="memItemLeft" align="right" valign="top"> |
| const char * </td><td class="memItemRight" valign="bottom"><b>pn_url_get_scheme</b> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url)</td></tr> |
| <tr class="separator:ga9162f3f1ba4bc374f079f9c01c3dee99"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga53ec7ab65dddea7383e64c6b2c58104e"><td class="memItemLeft" align="right" valign="top"> |
| const char * </td><td class="memItemRight" valign="bottom"><b>pn_url_get_username</b> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url)</td></tr> |
| <tr class="separator:ga53ec7ab65dddea7383e64c6b2c58104e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga04bdbeb6e80fe9c284bd53869106376e"><td class="memItemLeft" align="right" valign="top"> |
| const char * </td><td class="memItemRight" valign="bottom"><b>pn_url_get_password</b> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url)</td></tr> |
| <tr class="separator:ga04bdbeb6e80fe9c284bd53869106376e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga389ea60e7d9bb206d60e383eaa8df3b4"><td class="memItemLeft" align="right" valign="top"> |
| const char * </td><td class="memItemRight" valign="bottom"><b>pn_url_get_host</b> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url)</td></tr> |
| <tr class="separator:ga389ea60e7d9bb206d60e383eaa8df3b4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga9939dda9f21f76d336ea7618fb6c4f2c"><td class="memItemLeft" align="right" valign="top"> |
| const char * </td><td class="memItemRight" valign="bottom"><b>pn_url_get_port</b> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url)</td></tr> |
| <tr class="separator:ga9939dda9f21f76d336ea7618fb6c4f2c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gabaa60d37795438556e4db952a50e35a7"><td class="memItemLeft" align="right" valign="top"> |
| const char * </td><td class="memItemRight" valign="bottom"><b>pn_url_get_path</b> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url)</td></tr> |
| <tr class="separator:gabaa60d37795438556e4db952a50e35a7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr><td colspan="2"><div class="groupHeader">Setters for parts of the URL.</div></td></tr> |
| <tr><td colspan="2"><div class="groupText"><p>Values are copied.</p> |
| <p>Value can be NULL to indicate the part is not set. </p> |
| </div></td></tr> |
| <tr class="memitem:ga5eb2682f856fa187bc99f0f46774aeb8"><td class="memItemLeft" align="right" valign="top"> |
| void </td><td class="memItemRight" valign="bottom"><b>pn_url_set_scheme</b> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url, const char *scheme)</td></tr> |
| <tr class="separator:ga5eb2682f856fa187bc99f0f46774aeb8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gafefe82e512fbdede2f1f539cf07b8bff"><td class="memItemLeft" align="right" valign="top"> |
| void </td><td class="memItemRight" valign="bottom"><b>pn_url_set_username</b> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url, const char *username)</td></tr> |
| <tr class="separator:gafefe82e512fbdede2f1f539cf07b8bff"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga3b9cbf8a77179b15b2100870913d6aaf"><td class="memItemLeft" align="right" valign="top"> |
| void </td><td class="memItemRight" valign="bottom"><b>pn_url_set_password</b> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url, const char *password)</td></tr> |
| <tr class="separator:ga3b9cbf8a77179b15b2100870913d6aaf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga52876d19683cc9fb3318e29b297a0dfa"><td class="memItemLeft" align="right" valign="top"> |
| void </td><td class="memItemRight" valign="bottom"><b>pn_url_set_host</b> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url, const char *host)</td></tr> |
| <tr class="separator:ga52876d19683cc9fb3318e29b297a0dfa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga1a084548853885c874b1d0d435ef947c"><td class="memItemLeft" align="right" valign="top"> |
| void </td><td class="memItemRight" valign="bottom"><b>pn_url_set_port</b> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url, const char *port)</td></tr> |
| <tr class="separator:ga1a084548853885c874b1d0d435ef947c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gac72ebae7180d58003d489f2e4005d0c1"><td class="memItemLeft" align="right" valign="top"> |
| void </td><td class="memItemRight" valign="bottom"><b>pn_url_set_path</b> (<a class="el" href="group__url.html#gafbe4340c29b1abd7394767456ad3b8ea">pn_url_t</a> *url, const char *path)</td></tr> |
| <tr class="separator:gac72ebae7180d58003d489f2e4005d0c1"><td class="memSeparator" colspan="2"> </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> |
| </div></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="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> |
