| <!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: connection_options</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('classproton_1_1connection__options.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> | |
| <a href="classproton_1_1connection__options-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">connection_options</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Options for creating a connection. |
| <a href="classproton_1_1connection__options.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="connection__options_8hpp_source.html">connection_options.hpp</a>></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:a8034b8d17ca30a4cfc3db8c6a898dc4d"><td class="memItemLeft" align="right" valign="top"><a id="a8034b8d17ca30a4cfc3db8c6a898dc4d"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a8034b8d17ca30a4cfc3db8c6a898dc4d">connection_options</a> ()</td></tr> |
| <tr class="memdesc:a8034b8d17ca30a4cfc3db8c6a898dc4d"><td class="mdescLeft"> </td><td class="mdescRight">Create an empty set of options. <br /></td></tr> |
| <tr class="separator:a8034b8d17ca30a4cfc3db8c6a898dc4d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a90933e18af82770dfa522b0e3b356f3e"><td class="memItemLeft" align="right" valign="top"><a id="a90933e18af82770dfa522b0e3b356f3e"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a90933e18af82770dfa522b0e3b356f3e">connection_options</a> (class <a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> &h)</td></tr> |
| <tr class="memdesc:a90933e18af82770dfa522b0e3b356f3e"><td class="mdescLeft"> </td><td class="mdescRight">Shorthand for <code><a class="el" href="classproton_1_1connection__options.html#a8034b8d17ca30a4cfc3db8c6a898dc4d" title="Create an empty set of options.">connection_options()</a>.handler(h)</code>. <br /></td></tr> |
| <tr class="separator:a90933e18af82770dfa522b0e3b356f3e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa946cf564c3b226b0172b3b78f59928a"><td class="memItemLeft" align="right" valign="top"><a id="aa946cf564c3b226b0172b3b78f59928a"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#aa946cf564c3b226b0172b3b78f59928a">connection_options</a> (const <a class="el" href="classproton_1_1connection__options.html">connection_options</a> &)</td></tr> |
| <tr class="memdesc:aa946cf564c3b226b0172b3b78f59928a"><td class="mdescLeft"> </td><td class="mdescRight">Copy options. <br /></td></tr> |
| <tr class="separator:aa946cf564c3b226b0172b3b78f59928a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2c612e142b60cf61ce50d88582465167"><td class="memItemLeft" align="right" valign="top"><a id="a2c612e142b60cf61ce50d88582465167"></a> |
| <a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a2c612e142b60cf61ce50d88582465167">operator=</a> (const <a class="el" href="classproton_1_1connection__options.html">connection_options</a> &)</td></tr> |
| <tr class="memdesc:a2c612e142b60cf61ce50d88582465167"><td class="mdescLeft"> </td><td class="mdescRight">Copy options. <br /></td></tr> |
| <tr class="separator:a2c612e142b60cf61ce50d88582465167"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7bca23aeb3455378ef2d35975758e504"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a7bca23aeb3455378ef2d35975758e504">handler</a> (class <a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> &)</td></tr> |
| <tr class="memdesc:a7bca23aeb3455378ef2d35975758e504"><td class="mdescLeft"> </td><td class="mdescRight">Set a connection handler. <a href="classproton_1_1connection__options.html#a7bca23aeb3455378ef2d35975758e504">More...</a><br /></td></tr> |
| <tr class="separator:a7bca23aeb3455378ef2d35975758e504"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad0e93961fd048b2ee5e8bdac2b041686"><td class="memItemLeft" align="right" valign="top"><a id="ad0e93961fd048b2ee5e8bdac2b041686"></a> |
| <a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#ad0e93961fd048b2ee5e8bdac2b041686">max_frame_size</a> (uint32_t max)</td></tr> |
| <tr class="memdesc:ad0e93961fd048b2ee5e8bdac2b041686"><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum frame size. It is unlimited by default. <br /></td></tr> |
| <tr class="separator:ad0e93961fd048b2ee5e8bdac2b041686"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af66706fdb4a2f3f4d9943be9ee4b1347"><td class="memItemLeft" align="right" valign="top"><a id="af66706fdb4a2f3f4d9943be9ee4b1347"></a> |
| <a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#af66706fdb4a2f3f4d9943be9ee4b1347">max_sessions</a> (uint16_t max)</td></tr> |
| <tr class="memdesc:af66706fdb4a2f3f4d9943be9ee4b1347"><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum number of open sessions. The default is 32767. <br /></td></tr> |
| <tr class="separator:af66706fdb4a2f3f4d9943be9ee4b1347"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7c838237bfba8a5a04c2b97e6f023448"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a7c838237bfba8a5a04c2b97e6f023448">idle_timeout</a> (<a class="el" href="classproton_1_1duration.html">duration</a>)</td></tr> |
| <tr class="memdesc:a7c838237bfba8a5a04c2b97e6f023448"><td class="mdescLeft"> </td><td class="mdescRight">Set the idle timeout. <a href="classproton_1_1connection__options.html#a7c838237bfba8a5a04c2b97e6f023448">More...</a><br /></td></tr> |
| <tr class="separator:a7c838237bfba8a5a04c2b97e6f023448"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4c6429303ccb719d9c585c88f300e007"><td class="memItemLeft" align="right" valign="top"><a id="a4c6429303ccb719d9c585c88f300e007"></a> |
| <a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a4c6429303ccb719d9c585c88f300e007">container_id</a> (const std::string &id)</td></tr> |
| <tr class="memdesc:a4c6429303ccb719d9c585c88f300e007"><td class="mdescLeft"> </td><td class="mdescRight">Set the container ID. <br /></td></tr> |
| <tr class="separator:a4c6429303ccb719d9c585c88f300e007"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0300a2a68ecca3f684e91e637a45e028"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a0300a2a68ecca3f684e91e637a45e028">virtual_host</a> (const std::string &name)</td></tr> |
| <tr class="memdesc:a0300a2a68ecca3f684e91e637a45e028"><td class="mdescLeft"> </td><td class="mdescRight">Set the virtual host name for the connection. <a href="classproton_1_1connection__options.html#a0300a2a68ecca3f684e91e637a45e028">More...</a><br /></td></tr> |
| <tr class="separator:a0300a2a68ecca3f684e91e637a45e028"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a10afa48d580025f71f0a6dd31bd1de24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a10afa48d580025f71f0a6dd31bd1de24">user</a> (const std::string &)</td></tr> |
| <tr class="memdesc:a10afa48d580025f71f0a6dd31bd1de24"><td class="mdescLeft"> </td><td class="mdescRight">Set the user name used to authenticate the connection. <a href="classproton_1_1connection__options.html#a10afa48d580025f71f0a6dd31bd1de24">More...</a><br /></td></tr> |
| <tr class="separator:a10afa48d580025f71f0a6dd31bd1de24"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a78a90a1387cf91915dbe39b888955d75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a78a90a1387cf91915dbe39b888955d75">password</a> (const std::string &)</td></tr> |
| <tr class="memdesc:a78a90a1387cf91915dbe39b888955d75"><td class="mdescLeft"> </td><td class="mdescRight">Set the password used to authenticate the connection. <a href="classproton_1_1connection__options.html#a78a90a1387cf91915dbe39b888955d75">More...</a><br /></td></tr> |
| <tr class="separator:a78a90a1387cf91915dbe39b888955d75"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4eb280b5a62adb5b2075d6316a590c70"><td class="memItemLeft" align="right" valign="top"><a id="a4eb280b5a62adb5b2075d6316a590c70"></a> |
| <a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a4eb280b5a62adb5b2075d6316a590c70">ssl_client_options</a> (const class <a class="el" href="classproton_1_1ssl__client__options.html">ssl_client_options</a> &)</td></tr> |
| <tr class="memdesc:a4eb280b5a62adb5b2075d6316a590c70"><td class="mdescLeft"> </td><td class="mdescRight">Set SSL client options. <br /></td></tr> |
| <tr class="separator:a4eb280b5a62adb5b2075d6316a590c70"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5ce3c4591be545f5ae67f22ef64fb9ef"><td class="memItemLeft" align="right" valign="top"><a id="a5ce3c4591be545f5ae67f22ef64fb9ef"></a> |
| <a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a5ce3c4591be545f5ae67f22ef64fb9ef">ssl_server_options</a> (const class <a class="el" href="classproton_1_1ssl__server__options.html">ssl_server_options</a> &)</td></tr> |
| <tr class="memdesc:a5ce3c4591be545f5ae67f22ef64fb9ef"><td class="mdescLeft"> </td><td class="mdescRight">Set SSL server options. <br /></td></tr> |
| <tr class="separator:a5ce3c4591be545f5ae67f22ef64fb9ef"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aedcd8a70f24d08ab0bb6178524ae6a0d"><td class="memItemLeft" align="right" valign="top"><a id="aedcd8a70f24d08ab0bb6178524ae6a0d"></a> |
| <a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#aedcd8a70f24d08ab0bb6178524ae6a0d">sasl_enabled</a> (bool)</td></tr> |
| <tr class="memdesc:aedcd8a70f24d08ab0bb6178524ae6a0d"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable SASL. <br /></td></tr> |
| <tr class="separator:aedcd8a70f24d08ab0bb6178524ae6a0d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afbabea03db40dee25da7bbdc7e918322"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#afbabea03db40dee25da7bbdc7e918322">sasl_allow_insecure_mechs</a> (bool)</td></tr> |
| <tr class="memdesc:afbabea03db40dee25da7bbdc7e918322"><td class="mdescLeft"> </td><td class="mdescRight">Force the enabling of SASL mechanisms that disclose cleartext passwords over the connection. <a href="classproton_1_1connection__options.html#afbabea03db40dee25da7bbdc7e918322">More...</a><br /></td></tr> |
| <tr class="separator:afbabea03db40dee25da7bbdc7e918322"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a52f0724b86920647ef8624922aa54ab6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a52f0724b86920647ef8624922aa54ab6">sasl_allowed_mechs</a> (const std::string &)</td></tr> |
| <tr class="memdesc:a52f0724b86920647ef8624922aa54ab6"><td class="mdescLeft"> </td><td class="mdescRight">Specify the SASL mechanisms allowed for this connection. <a href="classproton_1_1connection__options.html#a52f0724b86920647ef8624922aa54ab6">More...</a><br /></td></tr> |
| <tr class="separator:a52f0724b86920647ef8624922aa54ab6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af49134c3e2ac611a4dbf37fb85f2f9e9"><td class="memItemLeft" align="right" valign="top"><a id="af49134c3e2ac611a4dbf37fb85f2f9e9"></a> |
| <a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#af49134c3e2ac611a4dbf37fb85f2f9e9">offered_capabilities</a> (const std::vector< <a class="el" href="classproton_1_1symbol.html">symbol</a> > &)</td></tr> |
| <tr class="memdesc:af49134c3e2ac611a4dbf37fb85f2f9e9"><td class="mdescLeft"> </td><td class="mdescRight"><b>Unsettled API</b> - Extension capabilities offered to the remote peer. <br /></td></tr> |
| <tr class="separator:af49134c3e2ac611a4dbf37fb85f2f9e9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a37785c499f7e1b0f30dcbe8a0b9458e9"><td class="memItemLeft" align="right" valign="top"><a id="a37785c499f7e1b0f30dcbe8a0b9458e9"></a> |
| <a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a37785c499f7e1b0f30dcbe8a0b9458e9">desired_capabilities</a> (const std::vector< <a class="el" href="classproton_1_1symbol.html">symbol</a> > &)</td></tr> |
| <tr class="memdesc:a37785c499f7e1b0f30dcbe8a0b9458e9"><td class="mdescLeft"> </td><td class="mdescRight"><b>Unsettled API</b> - Extension capabilities desired from the remote peer. <br /></td></tr> |
| <tr class="separator:a37785c499f7e1b0f30dcbe8a0b9458e9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad8e93a44cab5e65949046fb036c237a6"><td class="memItemLeft" align="right" valign="top"><a id="ad8e93a44cab5e65949046fb036c237a6"></a> |
| <a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#ad8e93a44cab5e65949046fb036c237a6">sasl_config_name</a> (const std::string &)</td></tr> |
| <tr class="memdesc:ad8e93a44cab5e65949046fb036c237a6"><td class="mdescLeft"> </td><td class="mdescRight"><b>Unsettled API</b> - Set the SASL configuration name. <br /></td></tr> |
| <tr class="separator:ad8e93a44cab5e65949046fb036c237a6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0fc40d55673b5c89e4b5a13c630edca5"><td class="memItemLeft" align="right" valign="top"><a id="a0fc40d55673b5c89e4b5a13c630edca5"></a> |
| <a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a0fc40d55673b5c89e4b5a13c630edca5">sasl_config_path</a> (const std::string &)</td></tr> |
| <tr class="memdesc:a0fc40d55673b5c89e4b5a13c630edca5"><td class="mdescLeft"> </td><td class="mdescRight"><b>Unsettled API</b> - Set the SASL configuration path. <br /></td></tr> |
| <tr class="separator:a0fc40d55673b5c89e4b5a13c630edca5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad053f0ac823eefd100731c1b5248e7e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#ad053f0ac823eefd100731c1b5248e7e8">reconnect</a> (const <a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a> &)</td></tr> |
| <tr class="memdesc:ad053f0ac823eefd100731c1b5248e7e8"><td class="mdescLeft"> </td><td class="mdescRight"><b>Unsettled API</b> - Set reconnect timing options. <a href="classproton_1_1connection__options.html#ad053f0ac823eefd100731c1b5248e7e8">More...</a><br /></td></tr> |
| <tr class="separator:ad053f0ac823eefd100731c1b5248e7e8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abc8a2670fc733415dca0a723f23d0729"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#abc8a2670fc733415dca0a723f23d0729">reconnect_url</a> (const std::string &)</td></tr> |
| <tr class="memdesc:abc8a2670fc733415dca0a723f23d0729"><td class="mdescLeft"> </td><td class="mdescRight"><b>Unsettled API</b> - Set reconnect URL. <a href="classproton_1_1connection__options.html#abc8a2670fc733415dca0a723f23d0729">More...</a><br /></td></tr> |
| <tr class="separator:abc8a2670fc733415dca0a723f23d0729"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abcfa30511c5b02318105ff214ea6eab7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#abcfa30511c5b02318105ff214ea6eab7">failover_urls</a> (const std::vector< std::string > &)</td></tr> |
| <tr class="memdesc:abcfa30511c5b02318105ff214ea6eab7"><td class="mdescLeft"> </td><td class="mdescRight"><b>Unsettled API</b> - Set Fail-over URLs. <a href="classproton_1_1connection__options.html#abcfa30511c5b02318105ff214ea6eab7">More...</a><br /></td></tr> |
| <tr class="separator:abcfa30511c5b02318105ff214ea6eab7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a68a8c198dfa16653afc4a70a2b845604"><td class="memItemLeft" align="right" valign="top"><a id="a68a8c198dfa16653afc4a70a2b845604"></a> |
| <a class="el" href="classproton_1_1connection__options.html">connection_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection__options.html#a68a8c198dfa16653afc4a70a2b845604">update</a> (const <a class="el" href="classproton_1_1connection__options.html">connection_options</a> &other)</td></tr> |
| <tr class="memdesc:a68a8c198dfa16653afc4a70a2b845604"><td class="mdescLeft"> </td><td class="mdescRight">Update option values from values set in other. <br /></td></tr> |
| <tr class="separator:a68a8c198dfa16653afc4a70a2b845604"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Options for creating a connection. </p> |
| <p>Options can be "chained" like this:</p> |
| <div class="fragment"><div class="line">c = container.connect(url, <a class="code" href="classproton_1_1connection__options.html#a8034b8d17ca30a4cfc3db8c6a898dc4d">connection_options</a>().<a class="code" href="classproton_1_1connection__options.html#a7bca23aeb3455378ef2d35975758e504">handler</a>(h).<a class="code" href="classproton_1_1connection__options.html#ad0e93961fd048b2ee5e8bdac2b041686">max_frame_size</a>(1234));</div> |
| </div><!-- fragment --><p>You can also create an options object with common settings and use it as a base for different connections that have mostly the same settings:</p> |
| <div class="fragment"><div class="line"><a class="code" href="classproton_1_1connection__options.html#a8034b8d17ca30a4cfc3db8c6a898dc4d">connection_options</a> opts;</div> |
| <div class="line">opts.idle_timeout(1000).max_frame_size(10000);</div> |
| <div class="line">c1 = container.connect(url1, opts.handler(h1));</div> |
| <div class="line">c2 = container.connect(url2, opts.handler(h2));</div> |
| </div><!-- fragment --><p>Normal value semantics: copy or assign creates a separate copy of the options. </p> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="broker_8cpp-example.html#_a34">broker.cpp</a>, <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#_a5">multithreaded_client_flow_control.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#_a1">service_bus.cpp</a>, <a class="el" href="simple_recv_8cpp-example.html#_a4">simple_recv.cpp</a>, and <a class="el" href="simple_send_8cpp-example.html#_a4">simple_send.cpp</a>.</dd> |
| </dl> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a7bca23aeb3455378ef2d35975758e504"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7bca23aeb3455378ef2d35975758e504">◆ </a></span>handler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1connection__options.html">connection_options</a>& handler </td> |
| <td>(</td> |
| <td class="paramtype">class <a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> & </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set a connection handler. </p> |
| <p>The handler must not be deleted until <a class="el" href="classproton_1_1messaging__handler.html#a8a60c2f6628f44a9587deea8c8729f0f" title="The final event for a connection: there will be no more reconnect attempts and no more event function...">messaging_handler::on_transport_close()</a> is called. </p> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="broker_8cpp-example.html#a36">broker.cpp</a>.</dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a7c838237bfba8a5a04c2b97e6f023448"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7c838237bfba8a5a04c2b97e6f023448">◆ </a></span>idle_timeout()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1connection__options.html">connection_options</a>& idle_timeout </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classproton_1_1duration.html">duration</a> </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the idle timeout. </p> |
| <p>The default is no timeout.</p> |
| <p>If set, the local peer will disconnect if it receives no AMQP frames for an interval longer than <code>duration</code>. Also known as "heartbeating", this is a way to detect dead peers even in the presence of a live TCP connection. </p> |
| |
| </div> |
| </div> |
| <a id="a0300a2a68ecca3f684e91e637a45e028"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0300a2a68ecca3f684e91e637a45e028">◆ </a></span>virtual_host()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1connection__options.html">connection_options</a>& virtual_host </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the virtual host name for the connection. </p> |
| <p>For client connections, it defaults to the host name used to set up the connection. For server connections, it is unset by default.</p> |
| <p>If making a client connection by SSL/TLS, this name is also used for certificate verification and Server Name Indication. </p> |
| |
| </div> |
| </div> |
| <a id="a10afa48d580025f71f0a6dd31bd1de24"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a10afa48d580025f71f0a6dd31bd1de24">◆ </a></span>user()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1connection__options.html">connection_options</a>& user </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the user name used to authenticate the connection. </p> |
| <p>It is unset by default.</p> |
| <p>This value overrides any user name that is specified in the URL used for <code><a class="el" href="classproton_1_1container.html#adbd9ed231804512a47cca3c81f00cdf1" title="Connect to conn_url and send an open request to the remote peer.">container::connect</a></code>. It is ignored if the connection is created by <code><a class="el" href="classproton_1_1container.html#a9e138b28e9589583915cf5c5e0e7a524" title="Listen for new connections on listen_url.">container::listen</a></code> because a listening connection's identity is provided by the remote client. </p> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="simple_recv_8cpp-example.html#a5">simple_recv.cpp</a>, and <a class="el" href="simple_send_8cpp-example.html#a5">simple_send.cpp</a>.</dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a78a90a1387cf91915dbe39b888955d75"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a78a90a1387cf91915dbe39b888955d75">◆ </a></span>password()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1connection__options.html">connection_options</a>& password </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the password used to authenticate the connection. </p> |
| <p>This value is ignored if the connection is created by <code><a class="el" href="classproton_1_1container.html#a9e138b28e9589583915cf5c5e0e7a524" title="Listen for new connections on listen_url.">container::listen</a></code>. </p> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="simple_recv_8cpp-example.html#a6">simple_recv.cpp</a>, and <a class="el" href="simple_send_8cpp-example.html#a6">simple_send.cpp</a>.</dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="afbabea03db40dee25da7bbdc7e918322"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afbabea03db40dee25da7bbdc7e918322">◆ </a></span>sasl_allow_insecure_mechs()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1connection__options.html">connection_options</a>& sasl_allow_insecure_mechs </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Force the enabling of SASL mechanisms that disclose cleartext passwords over the connection. </p> |
| <p>By default, such mechanisms are disabled. </p> |
| |
| </div> |
| </div> |
| <a id="a52f0724b86920647ef8624922aa54ab6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a52f0724b86920647ef8624922aa54ab6">◆ </a></span>sasl_allowed_mechs()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1connection__options.html">connection_options</a>& sasl_allowed_mechs </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Specify the SASL mechanisms allowed for this connection. </p> |
| <p>The value is a space-separated list of mechanism names.</p> |
| <p>The mechanisms allowed by default are determined by your SASL library and system configuration, with two exceptions: GSSAPI and GSS-SPNEGO are disabled by default. To enable them, you must explicitly add them using this option.</p> |
| <p>Clients must set the allowed mechanisms before the the outgoing connection is attempted. Servers must set them before the listening connection is setup. </p> |
| |
| </div> |
| </div> |
| <a id="ad053f0ac823eefd100731c1b5248e7e8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad053f0ac823eefd100731c1b5248e7e8">◆ </a></span>reconnect()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1connection__options.html">connection_options</a>& reconnect </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classproton_1_1reconnect__options.html">reconnect_options</a> & </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><b>Unsettled API</b> - Set reconnect timing options. </p> |
| <p>If reconnect timing options are set, but no specific reconnect or failover urls are set then the original url used for the connection will be used as the reconnect url. </p> |
| |
| </div> |
| </div> |
| <a id="abc8a2670fc733415dca0a723f23d0729"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abc8a2670fc733415dca0a723f23d0729">◆ </a></span>reconnect_url()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1connection__options.html">connection_options</a>& reconnect_url </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><b>Unsettled API</b> - Set reconnect URL. </p> |
| <p>If the connection to the primary connection url fails then try to reconnect using the reconnect url.</p> |
| <p>If this option is set then it will by default set the default reconnect timing options.</p> |
| <p>If this option is changed using <a class="el" href="classproton_1_1connection.html#aa8322acd886ff87d19f153ba21270945">connection::update_options</a> before a reconnection attempt (for example in the <a class="el" href="classproton_1_1messaging__handler.html#ab719e98555bab69986acf4ab1fe43665">messaging_handler::on_transport_error</a> callback) then the new value of the reconnect url will be used for the reconnect attempt rather then any previous value.</p> |
| <p>If both the failover_urls and reconnect_url options are set then the behavior is not defined. </p> |
| |
| </div> |
| </div> |
| <a id="abcfa30511c5b02318105ff214ea6eab7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abcfa30511c5b02318105ff214ea6eab7">◆ </a></span>failover_urls()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1connection__options.html">connection_options</a>& failover_urls </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< std::string > & </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><b>Unsettled API</b> - Set Fail-over URLs. </p> |
| <p>If the connection to the primary connection url fails then try each of the fail-over connection urls in turn.</p> |
| <p>If both the failover_urls and reconnect_url options are set then the behavior is not defined. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>proton/<a class="el" href="connection__options_8hpp_source.html">connection_options.hpp</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <div class="ttc" id="aclassproton_1_1connection__options_html_ad0e93961fd048b2ee5e8bdac2b041686"><div class="ttname"><a href="classproton_1_1connection__options.html#ad0e93961fd048b2ee5e8bdac2b041686">proton::connection_options::max_frame_size</a></div><div class="ttdeci">connection_options & max_frame_size(uint32_t max)</div><div class="ttdoc">Set the maximum frame size. It is unlimited by default.</div></div> |
| <div class="ttc" id="aclassproton_1_1connection__options_html_a7bca23aeb3455378ef2d35975758e504"><div class="ttname"><a href="classproton_1_1connection__options.html#a7bca23aeb3455378ef2d35975758e504">proton::connection_options::handler</a></div><div class="ttdeci">connection_options & handler(class messaging_handler &)</div><div class="ttdoc">Set a connection handler.</div></div> |
| <div class="ttc" id="aclassproton_1_1connection__options_html_a8034b8d17ca30a4cfc3db8c6a898dc4d"><div class="ttname"><a href="classproton_1_1connection__options.html#a8034b8d17ca30a4cfc3db8c6a898dc4d">proton::connection_options::connection_options</a></div><div class="ttdeci">connection_options()</div><div class="ttdoc">Create an empty set of options.</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="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="classproton_1_1connection__options.html">connection_options</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> |
