| <!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::connect_config 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="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('namespaceproton_1_1connect__config.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="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">proton::connect_config Namespace Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><em>Unsettled API</em> |
| <a href="namespaceproton_1_1connect__config.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:aa26e0091906ace58b29b28bb4fac0768"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton_1_1connect__config.html#aa26e0091906ace58b29b28bb4fac0768">default_file</a> ()</td></tr> |
| <tr class="separator:aa26e0091906ace58b29b28bb4fac0768"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9d0cff314322d852ef1bbb8a48456df7"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton_1_1connect__config.html#a9d0cff314322d852ef1bbb8a48456df7">parse</a> (std::istream &is, <a class="el" href="classproton_1_1connection__options.html">connection_options</a> &opts)</td></tr> |
| <tr class="memdesc:a9d0cff314322d852ef1bbb8a48456df7"><td class="mdescLeft"> </td><td class="mdescRight">Parse <a class="el" href="connect-config.html">Connection Configuration</a> from <code>is</code> and update <code>opts</code>. <a href="namespaceproton_1_1connect__config.html#a9d0cff314322d852ef1bbb8a48456df7">More...</a><br /></td></tr> |
| <tr class="separator:a9d0cff314322d852ef1bbb8a48456df7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8b0a17a0a807bcb4e899359b6f6d4e5b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton_1_1connect__config.html#a8b0a17a0a807bcb4e899359b6f6d4e5b">parse_default</a> (<a class="el" href="classproton_1_1connection__options.html">connection_options</a> &opts)</td></tr> |
| <tr class="memdesc:a8b0a17a0a807bcb4e899359b6f6d4e5b"><td class="mdescLeft"> </td><td class="mdescRight">Parse <a class="el" href="connect-config.html">Connection Configuration</a> from <a class="el" href="namespaceproton_1_1connect__config.html#aa26e0091906ace58b29b28bb4fac0768">default_file()</a> and update <code>opts</code>. <a href="namespaceproton_1_1connect__config.html#a8b0a17a0a807bcb4e899359b6f6d4e5b">More...</a><br /></td></tr> |
| <tr class="separator:a8b0a17a0a807bcb4e899359b6f6d4e5b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><em>Unsettled API</em> </p> |
| <p>Functions for locating and using a <a class="el" href="connect-config.html">Connection Configuration</a> file, or a configuration string to set <a class="el" href="classproton_1_1connection__options.html">connection_options</a> </p> |
| </div><h2 class="groupheader">Function Documentation</h2> |
| <a id="aa26e0091906ace58b29b28bb4fac0768"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa26e0091906ace58b29b28bb4fac0768">◆ </a></span>default_file()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string proton::connect_config::default_file </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>name of the default <a class="el" href="connect-config.html">Connection Configuration</a> file. </dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="structproton_1_1error.html" title="The base Proton error.">proton::error</a></td><td>if no default file is found </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a9d0cff314322d852ef1bbb8a48456df7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9d0cff314322d852ef1bbb8a48456df7">◆ </a></span>parse()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string proton::connect_config::parse </td> |
| <td>(</td> |
| <td class="paramtype">std::istream & </td> |
| <td class="paramname"><em>is</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td> |
| <td class="paramname"><em>opts</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Parse <a class="el" href="connect-config.html">Connection Configuration</a> from <code>is</code> and update <code>opts</code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">is</td><td>input stream for configuration file/string </td></tr> |
| <tr><td class="paramname">opts</td><td>[out] connection options to update </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>address suitable for <a class="el" href="classproton_1_1container.html#a32d867e171bce707cc73c7003ec489db" title="Connect using the default Connection Configuration file.">container::connect()</a> from configuration </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a8b0a17a0a807bcb4e899359b6f6d4e5b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8b0a17a0a807bcb4e899359b6f6d4e5b">◆ </a></span>parse_default()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string proton::connect_config::parse_default </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td> |
| <td class="paramname"><em>opts</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Parse <a class="el" href="connect-config.html">Connection Configuration</a> from <a class="el" href="namespaceproton_1_1connect__config.html#aa26e0091906ace58b29b28bb4fac0768">default_file()</a> and update <code>opts</code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opts</td><td>[out] connection options to update </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>address suitable for <a class="el" href="classproton_1_1container.html#a32d867e171bce707cc73c7003ec489db" title="Connect using the default Connection Configuration file.">container::connect()</a> from configuration </dd></dl> |
| |
| </div> |
| </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="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="namespaceproton_1_1connect__config.html">connect_config</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> |