| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.6"/> |
| <title>Paho C++: mqtt::connect_options Class 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="navtree.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| $(window).load(resizeHeight); |
| </script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </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="projectlogo"><img alt="Logo" src="pahologo.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Paho C++ |
|  <span id="projectnumber">1.0</span> |
| </div> |
| <div id="projectbrief">The Paho MQTT C++ Client Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.6 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| 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.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| </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"> |
| $(document).ready(function(){initNavTree('classmqtt_1_1connect__options.html','');}); |
| </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)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Friends</a></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-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classmqtt_1_1connect__options-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mqtt::connect_options Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Holds the set of options that control how the client connects to a server. |
| <a href="classmqtt_1_1connect__options.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="connect__options_8h_source.html">connect_options.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:aa235e73ac246fdabb1663125171dce41"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#aa235e73ac246fdabb1663125171dce41">ptr_t</a> = std::shared_ptr< <a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> ></td></tr> |
| <tr class="memdesc:aa235e73ac246fdabb1663125171dce41"><td class="mdescLeft"> </td><td class="mdescRight">Smart/shared pointer to an object of this class. <a href="#aa235e73ac246fdabb1663125171dce41">More...</a><br/></td></tr> |
| <tr class="separator:aa235e73ac246fdabb1663125171dce41"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a642c3f4a4fe7e45c48be198606ab5abd"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a642c3f4a4fe7e45c48be198606ab5abd">const_ptr_t</a> = std::shared_ptr< const <a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> ></td></tr> |
| <tr class="memdesc:a642c3f4a4fe7e45c48be198606ab5abd"><td class="mdescLeft"> </td><td class="mdescRight">Smart/shared pointer to a const object of this class. <a href="#a642c3f4a4fe7e45c48be198606ab5abd">More...</a><br/></td></tr> |
| <tr class="separator:a642c3f4a4fe7e45c48be198606ab5abd"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:a5811ad2a2bbbb02b04d79b08530349a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5811ad2a2bbbb02b04d79b08530349a3"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a5811ad2a2bbbb02b04d79b08530349a3">connect_options</a> ()</td></tr> |
| <tr class="memdesc:a5811ad2a2bbbb02b04d79b08530349a3"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new object using the default values. <br/></td></tr> |
| <tr class="separator:a5811ad2a2bbbb02b04d79b08530349a3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2776f635241ecd1f0542b6523058677c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a2776f635241ecd1f0542b6523058677c">connect_options</a> (<a class="el" href="classmqtt_1_1buffer__ref.html">string_ref</a> userName, <a class="el" href="classmqtt_1_1buffer__ref.html">binary_ref</a> password)</td></tr> |
| <tr class="memdesc:a2776f635241ecd1f0542b6523058677c"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new object using the specified user name and password. <a href="#a2776f635241ecd1f0542b6523058677c">More...</a><br/></td></tr> |
| <tr class="separator:a2776f635241ecd1f0542b6523058677c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a92652c78aa9ffe1199228ffa3eaaac3b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a92652c78aa9ffe1199228ffa3eaaac3b">connect_options</a> (const <a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> &opt)</td></tr> |
| <tr class="memdesc:a92652c78aa9ffe1199228ffa3eaaac3b"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a92652c78aa9ffe1199228ffa3eaaac3b">More...</a><br/></td></tr> |
| <tr class="separator:a92652c78aa9ffe1199228ffa3eaaac3b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2ee26dc86e1a303abaa8f5f8e5e7c21f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a2ee26dc86e1a303abaa8f5f8e5e7c21f">connect_options</a> (<a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> &&opt)</td></tr> |
| <tr class="memdesc:a2ee26dc86e1a303abaa8f5f8e5e7c21f"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <a href="#a2ee26dc86e1a303abaa8f5f8e5e7c21f">More...</a><br/></td></tr> |
| <tr class="separator:a2ee26dc86e1a303abaa8f5f8e5e7c21f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a90a1c129374e0babbf668b61dd5c6c05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a90a1c129374e0babbf668b61dd5c6c05">operator=</a> (const <a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> &opt)</td></tr> |
| <tr class="memdesc:a90a1c129374e0babbf668b61dd5c6c05"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment. <a href="#a90a1c129374e0babbf668b61dd5c6c05">More...</a><br/></td></tr> |
| <tr class="separator:a90a1c129374e0babbf668b61dd5c6c05"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a91ac2a642e61b7b3b9f7a667aa272b8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a91ac2a642e61b7b3b9f7a667aa272b8a">operator=</a> (<a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> &&opt)</td></tr> |
| <tr class="memdesc:a91ac2a642e61b7b3b9f7a667aa272b8a"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment. <a href="#a91ac2a642e61b7b3b9f7a667aa272b8a">More...</a><br/></td></tr> |
| <tr class="separator:a91ac2a642e61b7b3b9f7a667aa272b8a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adbb10d7dacb950790a78d72df99ce493"><td class="memItemLeft" align="right" valign="top">std::chrono::seconds </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#adbb10d7dacb950790a78d72df99ce493">get_keep_alive_interval</a> () const </td></tr> |
| <tr class="memdesc:adbb10d7dacb950790a78d72df99ce493"><td class="mdescLeft"> </td><td class="mdescRight">Gets the "keep alive" interval. <a href="#adbb10d7dacb950790a78d72df99ce493">More...</a><br/></td></tr> |
| <tr class="separator:adbb10d7dacb950790a78d72df99ce493"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab0295bc9433f5c5d7190da29c6e1f0a9"><td class="memItemLeft" align="right" valign="top">std::chrono::seconds </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ab0295bc9433f5c5d7190da29c6e1f0a9">get_connect_timeout</a> () const </td></tr> |
| <tr class="memdesc:ab0295bc9433f5c5d7190da29c6e1f0a9"><td class="mdescLeft"> </td><td class="mdescRight">Gets the connection timeout. <a href="#ab0295bc9433f5c5d7190da29c6e1f0a9">More...</a><br/></td></tr> |
| <tr class="separator:ab0295bc9433f5c5d7190da29c6e1f0a9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ade1380d6113d9309291bc0ac6784078c"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ade1380d6113d9309291bc0ac6784078c">get_user_name</a> () const </td></tr> |
| <tr class="memdesc:ade1380d6113d9309291bc0ac6784078c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the user name to use for the connection. <a href="#ade1380d6113d9309291bc0ac6784078c">More...</a><br/></td></tr> |
| <tr class="separator:ade1380d6113d9309291bc0ac6784078c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4065ae5e674b0c9d80b8691f56ff7449"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmqtt_1_1buffer__ref.html">binary_ref</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a4065ae5e674b0c9d80b8691f56ff7449">get_password</a> () const </td></tr> |
| <tr class="memdesc:a4065ae5e674b0c9d80b8691f56ff7449"><td class="mdescLeft"> </td><td class="mdescRight">Gets the password to use for the connection. <a href="#a4065ae5e674b0c9d80b8691f56ff7449">More...</a><br/></td></tr> |
| <tr class="separator:a4065ae5e674b0c9d80b8691f56ff7449"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac45ec604a735add8f663e732fa73b509"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ac45ec604a735add8f663e732fa73b509">get_password_str</a> () const </td></tr> |
| <tr class="memdesc:ac45ec604a735add8f663e732fa73b509"><td class="mdescLeft"> </td><td class="mdescRight">Gets the password to use for the connection. <a href="#ac45ec604a735add8f663e732fa73b509">More...</a><br/></td></tr> |
| <tr class="separator:ac45ec604a735add8f663e732fa73b509"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a56ee18bbd4efba3b5bdfdbf95eec50a1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a56ee18bbd4efba3b5bdfdbf95eec50a1">get_max_inflight</a> () const </td></tr> |
| <tr class="memdesc:a56ee18bbd4efba3b5bdfdbf95eec50a1"><td class="mdescLeft"> </td><td class="mdescRight">Gets the maximum number of messages that can be in-flight simultaneously. <a href="#a56ee18bbd4efba3b5bdfdbf95eec50a1">More...</a><br/></td></tr> |
| <tr class="separator:a56ee18bbd4efba3b5bdfdbf95eec50a1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a017b54a34ef9b2ba16ef5a00b0c72e7c"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a017b54a34ef9b2ba16ef5a00b0c72e7c">get_will_topic</a> () const </td></tr> |
| <tr class="memdesc:a017b54a34ef9b2ba16ef5a00b0c72e7c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the topic to be used for last will and testament (LWT). <a href="#a017b54a34ef9b2ba16ef5a00b0c72e7c">More...</a><br/></td></tr> |
| <tr class="separator:a017b54a34ef9b2ba16ef5a00b0c72e7c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2a5deebcf884743ddc30a6ebdda95c3f"><td class="memItemLeft" align="right" valign="top">const_message_ptr </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a2a5deebcf884743ddc30a6ebdda95c3f">get_will_message</a> () const </td></tr> |
| <tr class="memdesc:a2a5deebcf884743ddc30a6ebdda95c3f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the message to be sent as last will and testament (LWT). <a href="#a2a5deebcf884743ddc30a6ebdda95c3f">More...</a><br/></td></tr> |
| <tr class="separator:a2a5deebcf884743ddc30a6ebdda95c3f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7bba282230d34a8796fc1b52d45df2cd"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classmqtt_1_1will__options.html">will_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a7bba282230d34a8796fc1b52d45df2cd">get_will_options</a> () const </td></tr> |
| <tr class="memdesc:a7bba282230d34a8796fc1b52d45df2cd"><td class="mdescLeft"> </td><td class="mdescRight">Get the LWT options to use for the connection. <a href="#a7bba282230d34a8796fc1b52d45df2cd">More...</a><br/></td></tr> |
| <tr class="separator:a7bba282230d34a8796fc1b52d45df2cd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8279ac8ef4a9df3bea4a24303e25c339"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a8279ac8ef4a9df3bea4a24303e25c339">get_ssl_options</a> () const </td></tr> |
| <tr class="memdesc:a8279ac8ef4a9df3bea4a24303e25c339"><td class="mdescLeft"> </td><td class="mdescRight">Get the SSL options to use for the connection. <a href="#a8279ac8ef4a9df3bea4a24303e25c339">More...</a><br/></td></tr> |
| <tr class="separator:a8279ac8ef4a9df3bea4a24303e25c339"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac7d250c386ffc68aad082c83348588c4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ac7d250c386ffc68aad082c83348588c4">set_ssl</a> (const <a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> &ssl)</td></tr> |
| <tr class="memdesc:ac7d250c386ffc68aad082c83348588c4"><td class="mdescLeft"> </td><td class="mdescRight">Sets the SSL for the connection. <a href="#ac7d250c386ffc68aad082c83348588c4">More...</a><br/></td></tr> |
| <tr class="separator:ac7d250c386ffc68aad082c83348588c4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a062dd43eb33c096559678777a9a7f2fe"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a062dd43eb33c096559678777a9a7f2fe">is_clean_session</a> () const </td></tr> |
| <tr class="memdesc:a062dd43eb33c096559678777a9a7f2fe"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the server should remember state for the client across reconnects. <a href="#a062dd43eb33c096559678777a9a7f2fe">More...</a><br/></td></tr> |
| <tr class="separator:a062dd43eb33c096559678777a9a7f2fe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad15863b53666f537d6d1bb9fb172566c"><td class="memItemLeft" align="right" valign="top">token_ptr </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ad15863b53666f537d6d1bb9fb172566c">get_token</a> () const </td></tr> |
| <tr class="memdesc:ad15863b53666f537d6d1bb9fb172566c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the token used as the callback context. <a href="#ad15863b53666f537d6d1bb9fb172566c">More...</a><br/></td></tr> |
| <tr class="separator:ad15863b53666f537d6d1bb9fb172566c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac505f06c3b16b0fe86aa83b5dd0093cb"><td class="memItemLeft" align="right" valign="top">const_string_collection_ptr </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ac505f06c3b16b0fe86aa83b5dd0093cb">get_servers</a> () const </td></tr> |
| <tr class="memdesc:ac505f06c3b16b0fe86aa83b5dd0093cb"><td class="mdescLeft"> </td><td class="mdescRight">Gets the list of servers to which the client will connect. <a href="#ac505f06c3b16b0fe86aa83b5dd0093cb">More...</a><br/></td></tr> |
| <tr class="separator:ac505f06c3b16b0fe86aa83b5dd0093cb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3c162937e8b8c49c2c3f7d2885203fb3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a3c162937e8b8c49c2c3f7d2885203fb3">get_mqtt_version</a> () const </td></tr> |
| <tr class="memdesc:a3c162937e8b8c49c2c3f7d2885203fb3"><td class="mdescLeft"> </td><td class="mdescRight">Gets the version of MQTT to be used on the connect. <a href="#a3c162937e8b8c49c2c3f7d2885203fb3">More...</a><br/></td></tr> |
| <tr class="separator:a3c162937e8b8c49c2c3f7d2885203fb3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afe2d085bb089c6fdab1426adb5137470"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#afe2d085bb089c6fdab1426adb5137470">get_automatic_reconnect</a> () const </td></tr> |
| <tr class="memdesc:afe2d085bb089c6fdab1426adb5137470"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the options have been configured for automatic reconnect. <a href="#afe2d085bb089c6fdab1426adb5137470">More...</a><br/></td></tr> |
| <tr class="separator:afe2d085bb089c6fdab1426adb5137470"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad419a13dad78d2c0d5cbbf71c0ca546f"><td class="memItemLeft" align="right" valign="top">std::chrono::seconds </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ad419a13dad78d2c0d5cbbf71c0ca546f">get_min_retry_interval</a> () const </td></tr> |
| <tr class="memdesc:ad419a13dad78d2c0d5cbbf71c0ca546f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the minimum retry interval for automatic reconnect. <a href="#ad419a13dad78d2c0d5cbbf71c0ca546f">More...</a><br/></td></tr> |
| <tr class="separator:ad419a13dad78d2c0d5cbbf71c0ca546f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2fd757ca85253174997982eebcd817c8"><td class="memItemLeft" align="right" valign="top">std::chrono::seconds </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a2fd757ca85253174997982eebcd817c8">get_max_retry_interval</a> () const </td></tr> |
| <tr class="memdesc:a2fd757ca85253174997982eebcd817c8"><td class="mdescLeft"> </td><td class="mdescRight">Gets the maximum retry interval for automatic reconnect. <a href="#a2fd757ca85253174997982eebcd817c8">More...</a><br/></td></tr> |
| <tr class="separator:a2fd757ca85253174997982eebcd817c8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a403bdb15d0383f160e590cdb19039c30"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a403bdb15d0383f160e590cdb19039c30">set_clean_session</a> (bool cleanSession)</td></tr> |
| <tr class="memdesc:a403bdb15d0383f160e590cdb19039c30"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the server should remember state for the client across reconnects. <a href="#a403bdb15d0383f160e590cdb19039c30">More...</a><br/></td></tr> |
| <tr class="separator:a403bdb15d0383f160e590cdb19039c30"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a21d0565ce539b40097bb911c50ecbc60"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a21d0565ce539b40097bb911c50ecbc60">set_connection_timeout</a> (int timeout)</td></tr> |
| <tr class="memdesc:a21d0565ce539b40097bb911c50ecbc60"><td class="mdescLeft"> </td><td class="mdescRight">Sets the connection timeout value. <a href="#a21d0565ce539b40097bb911c50ecbc60">More...</a><br/></td></tr> |
| <tr class="separator:a21d0565ce539b40097bb911c50ecbc60"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8f7c99d453da95192b15641a80286441"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a8f7c99d453da95192b15641a80286441">set_keep_alive_interval</a> (int keepAliveInterval)</td></tr> |
| <tr class="memdesc:a8f7c99d453da95192b15641a80286441"><td class="mdescLeft"> </td><td class="mdescRight">Sets the "keep alive" interval. <a href="#a8f7c99d453da95192b15641a80286441">More...</a><br/></td></tr> |
| <tr class="separator:a8f7c99d453da95192b15641a80286441"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1fe7db605c853cbf3d96a7f92b1938eb"><td class="memTemplParams" colspan="2">template<class Rep , class Period > </td></tr> |
| <tr class="memitem:a1fe7db605c853cbf3d96a7f92b1938eb"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a1fe7db605c853cbf3d96a7f92b1938eb">set_keep_alive_interval</a> (const std::chrono::duration< Rep, Period > &interval)</td></tr> |
| <tr class="memdesc:a1fe7db605c853cbf3d96a7f92b1938eb"><td class="mdescLeft"> </td><td class="mdescRight">Sets the "keep alive" interval with a chrono duration. <a href="#a1fe7db605c853cbf3d96a7f92b1938eb">More...</a><br/></td></tr> |
| <tr class="separator:a1fe7db605c853cbf3d96a7f92b1938eb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3ab5997d6b7faff140a62ad3059ff5f6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a3ab5997d6b7faff140a62ad3059ff5f6">set_connect_timeout</a> (int to)</td></tr> |
| <tr class="memdesc:a3ab5997d6b7faff140a62ad3059ff5f6"><td class="mdescLeft"> </td><td class="mdescRight">Sets the connect timeout in seconds. <a href="#a3ab5997d6b7faff140a62ad3059ff5f6">More...</a><br/></td></tr> |
| <tr class="separator:a3ab5997d6b7faff140a62ad3059ff5f6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a597539d16cf450959e99f8c1a2c25c29"><td class="memTemplParams" colspan="2">template<class Rep , class Period > </td></tr> |
| <tr class="memitem:a597539d16cf450959e99f8c1a2c25c29"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a597539d16cf450959e99f8c1a2c25c29">set_connect_timeout</a> (const std::chrono::duration< Rep, Period > &to)</td></tr> |
| <tr class="memdesc:a597539d16cf450959e99f8c1a2c25c29"><td class="mdescLeft"> </td><td class="mdescRight">Sets the connect timeout with a chrono duration. <a href="#a597539d16cf450959e99f8c1a2c25c29">More...</a><br/></td></tr> |
| <tr class="separator:a597539d16cf450959e99f8c1a2c25c29"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0d4c0ab71eccf7785b477df5619943b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a0d4c0ab71eccf7785b477df5619943b6">set_user_name</a> (<a class="el" href="classmqtt_1_1buffer__ref.html">string_ref</a> userName)</td></tr> |
| <tr class="memdesc:a0d4c0ab71eccf7785b477df5619943b6"><td class="mdescLeft"> </td><td class="mdescRight">Sets the user name to use for the connection. <a href="#a0d4c0ab71eccf7785b477df5619943b6">More...</a><br/></td></tr> |
| <tr class="separator:a0d4c0ab71eccf7785b477df5619943b6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af27a81a33acfbb152c70a7331163afce"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af27a81a33acfbb152c70a7331163afce"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#af27a81a33acfbb152c70a7331163afce">set_password</a> (<a class="el" href="classmqtt_1_1buffer__ref.html">binary_ref</a> password)</td></tr> |
| <tr class="memdesc:af27a81a33acfbb152c70a7331163afce"><td class="mdescLeft"> </td><td class="mdescRight">Sets the password to use for the connection. <br/></td></tr> |
| <tr class="separator:af27a81a33acfbb152c70a7331163afce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9782ad70a6927ce80ab155928eea2f57"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a9782ad70a6927ce80ab155928eea2f57">set_max_inflight</a> (int n)</td></tr> |
| <tr class="memdesc:a9782ad70a6927ce80ab155928eea2f57"><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum number of messages that can be in-flight simultaneously. <a href="#a9782ad70a6927ce80ab155928eea2f57">More...</a><br/></td></tr> |
| <tr class="separator:a9782ad70a6927ce80ab155928eea2f57"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab5c95da2cdcff93f9737a42015002f27"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ab5c95da2cdcff93f9737a42015002f27">set_will</a> (const <a class="el" href="classmqtt_1_1will__options.html">will_options</a> &will)</td></tr> |
| <tr class="memdesc:ab5c95da2cdcff93f9737a42015002f27"><td class="mdescLeft"> </td><td class="mdescRight">Sets the "Last Will and Testament" (LWT) for the connection. <a href="#ab5c95da2cdcff93f9737a42015002f27">More...</a><br/></td></tr> |
| <tr class="separator:ab5c95da2cdcff93f9737a42015002f27"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2cf8245b406dba323c508b1af7308bba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a2cf8245b406dba323c508b1af7308bba">set_token</a> (const token_ptr &tok)</td></tr> |
| <tr class="memdesc:a2cf8245b406dba323c508b1af7308bba"><td class="mdescLeft"> </td><td class="mdescRight">Sets the callback context to a delivery token. <a href="#a2cf8245b406dba323c508b1af7308bba">More...</a><br/></td></tr> |
| <tr class="separator:a2cf8245b406dba323c508b1af7308bba"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab07b77a183819ef5831bedf158195217"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ab07b77a183819ef5831bedf158195217">set_servers</a> (const_string_collection_ptr serverURIs)</td></tr> |
| <tr class="memdesc:ab07b77a183819ef5831bedf158195217"><td class="mdescLeft"> </td><td class="mdescRight">Sets the list of servers to which the client will connect. <a href="#ab07b77a183819ef5831bedf158195217">More...</a><br/></td></tr> |
| <tr class="separator:ab07b77a183819ef5831bedf158195217"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ade9cf837014937ca3df32bb04c7dca28"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ade9cf837014937ca3df32bb04c7dca28">set_mqtt_version</a> (int mqttVersion)</td></tr> |
| <tr class="memdesc:ade9cf837014937ca3df32bb04c7dca28"><td class="mdescLeft"> </td><td class="mdescRight">Sets the version of MQTT to be used on the connect. <a href="#ade9cf837014937ca3df32bb04c7dca28">More...</a><br/></td></tr> |
| <tr class="separator:ade9cf837014937ca3df32bb04c7dca28"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7a4a2086ca01c12eeda4e5d5821eaea4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a7a4a2086ca01c12eeda4e5d5821eaea4">set_automatic_reconnect</a> (bool on)</td></tr> |
| <tr class="memdesc:a7a4a2086ca01c12eeda4e5d5821eaea4"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable automatic reconnects. <a href="#a7a4a2086ca01c12eeda4e5d5821eaea4">More...</a><br/></td></tr> |
| <tr class="separator:a7a4a2086ca01c12eeda4e5d5821eaea4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae5dd4f9ad611b79bfd847035cecd7b0b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ae5dd4f9ad611b79bfd847035cecd7b0b">set_automatic_reconnect</a> (int minRetryInterval, int maxRetryInterval)</td></tr> |
| <tr class="memdesc:ae5dd4f9ad611b79bfd847035cecd7b0b"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable automatic reconnects. <a href="#ae5dd4f9ad611b79bfd847035cecd7b0b">More...</a><br/></td></tr> |
| <tr class="separator:ae5dd4f9ad611b79bfd847035cecd7b0b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2fa264464f0b705af67ba4327afc1425"><td class="memTemplParams" colspan="2">template<class Rep1 , class Period1 , class Rep2 , class Period2 > </td></tr> |
| <tr class="memitem:a2fa264464f0b705af67ba4327afc1425"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a2fa264464f0b705af67ba4327afc1425">set_automatic_reconnect</a> (const std::chrono::duration< Rep1, Period1 > &minRetryInterval, const std::chrono::duration< Rep2, Period2 > &maxRetryInterval)</td></tr> |
| <tr class="memdesc:a2fa264464f0b705af67ba4327afc1425"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable automatic reconnects. <a href="#a2fa264464f0b705af67ba4327afc1425">More...</a><br/></td></tr> |
| <tr class="separator:a2fa264464f0b705af67ba4327afc1425"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3a387bef8a6e27edce8ae7d3f69a613b"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a3a387bef8a6e27edce8ae7d3f69a613b">to_string</a> () const </td></tr> |
| <tr class="memdesc:a3a387bef8a6e27edce8ae7d3f69a613b"><td class="mdescLeft"> </td><td class="mdescRight">Gets a string representation of the object. <a href="#a3a387bef8a6e27edce8ae7d3f69a613b">More...</a><br/></td></tr> |
| <tr class="separator:a3a387bef8a6e27edce8ae7d3f69a613b"><td class="memSeparator" colspan="2"> </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:ac39954340d8b15edaa883af1bcfcf7ae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac39954340d8b15edaa883af1bcfcf7ae"></a> |
| class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ac39954340d8b15edaa883af1bcfcf7ae">async_client</a></td></tr> |
| <tr class="memdesc:ac39954340d8b15edaa883af1bcfcf7ae"><td class="mdescLeft"> </td><td class="mdescRight">The client has special access. <br/></td></tr> |
| <tr class="separator:ac39954340d8b15edaa883af1bcfcf7ae"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2a622f44bfef637607b9070710bf9911"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a622f44bfef637607b9070710bf9911"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>connect_options_test</b></td></tr> |
| <tr class="separator:a2a622f44bfef637607b9070710bf9911"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac3c9b5f286a77bfa3dd9f557441bfb17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac3c9b5f286a77bfa3dd9f557441bfb17"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>token_test</b></td></tr> |
| <tr class="separator:ac3c9b5f286a77bfa3dd9f557441bfb17"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Holds the set of options that control how the client connects to a server. </p> |
| </div><h2 class="groupheader">Member Typedef Documentation</h2> |
| <a class="anchor" id="a642c3f4a4fe7e45c48be198606ab5abd"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">using <a class="el" href="classmqtt_1_1connect__options.html#a642c3f4a4fe7e45c48be198606ab5abd">mqtt::connect_options::const_ptr_t</a> = std::shared_ptr<const <a class="el" href="classmqtt_1_1connect__options.html">connect_options</a>></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Smart/shared pointer to a const object of this class. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa235e73ac246fdabb1663125171dce41"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">using <a class="el" href="classmqtt_1_1connect__options.html#aa235e73ac246fdabb1663125171dce41">mqtt::connect_options::ptr_t</a> = std::shared_ptr<<a class="el" href="classmqtt_1_1connect__options.html">connect_options</a>></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Smart/shared pointer to an object of this class. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a2776f635241ecd1f0542b6523058677c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::connect_options::connect_options </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1buffer__ref.html">string_ref</a> </td> |
| <td class="paramname"><em>userName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1buffer__ref.html">binary_ref</a> </td> |
| <td class="paramname"><em>password</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs a new object using the specified user name and password. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">userName</td><td>The name of the user for connecting to the server </td></tr> |
| <tr><td class="paramname">password</td><td>The password for connecting to the server </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a92652c78aa9ffe1199228ffa3eaaac3b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::connect_options::connect_options </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> & </td> |
| <td class="paramname"><em>opt</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opt</td><td>Another object to copy. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2ee26dc86e1a303abaa8f5f8e5e7c21f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::connect_options::connect_options </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> && </td> |
| <td class="paramname"><em>opt</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Move constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opt</td><td>Another object to move into this new one. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="afe2d085bb089c6fdab1426adb5137470"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mqtt::connect_options::get_automatic_reconnect </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Determines if the options have been configured for automatic reconnect. </p> |
| <dl class="section return"><dt>Returns</dt><dd><em>true</em> if configured for automatic reconnect, <em>false</em> if not. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab0295bc9433f5c5d7190da29c6e1f0a9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::chrono::seconds mqtt::connect_options::get_connect_timeout </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the connection timeout. </p> |
| <p>This is the amount of time the underlying library will wait for a timeout before failing. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The connect timeout in seconds. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="adbb10d7dacb950790a78d72df99ce493"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::chrono::seconds mqtt::connect_options::get_keep_alive_interval </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the "keep alive" interval. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The keep alive interval in seconds. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a56ee18bbd4efba3b5bdfdbf95eec50a1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int mqtt::connect_options::get_max_inflight </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the maximum number of messages that can be in-flight simultaneously. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The maximum number of inflight messages. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2fd757ca85253174997982eebcd817c8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::chrono::seconds mqtt::connect_options::get_max_retry_interval </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the maximum retry interval for automatic reconnect. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The maximum retry interval for automatic reconnect, in seconds. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad419a13dad78d2c0d5cbbf71c0ca546f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::chrono::seconds mqtt::connect_options::get_min_retry_interval </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the minimum retry interval for automatic reconnect. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The minimum retry interval for automatic reconnect, in seconds. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3c162937e8b8c49c2c3f7d2885203fb3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int mqtt::connect_options::get_mqtt_version </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the version of MQTT to be used on the connect. </p> |
| <dl class="section return"><dt>Returns</dt><dd><ul> |
| <li>MQTTVERSION_DEFAULT (0) = default: start with 3.1.1, and if that fails, fall back to 3.1 </li> |
| <li>MQTTVERSION_3_1 (3) = only try version 3.1 </li> |
| <li>MQTTVERSION_3_1_1 (4) = only try version 3.1.1 </li> |
| </ul> |
| </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4065ae5e674b0c9d80b8691f56ff7449"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmqtt_1_1buffer__ref.html">binary_ref</a> mqtt::connect_options::get_password </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the password to use for the connection. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The password to use for the connection. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac45ec604a735add8f663e732fa73b509"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string mqtt::connect_options::get_password_str </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the password to use for the connection. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The password to use for the connection. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac505f06c3b16b0fe86aa83b5dd0093cb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const_string_collection_ptr mqtt::connect_options::get_servers </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the list of servers to which the client will connect. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A collection of server URI's. Each entry should be of the form <em>protocol://host</em>:port where <em>protocol</em> must be tcp or <em>ssl</em>. For <em>host</em>, you can specify either an IP address or a domain name. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8279ac8ef4a9df3bea4a24303e25c339"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a>& mqtt::connect_options::get_ssl_options </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the SSL options to use for the connection. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The SSL options to use for the connection. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad15863b53666f537d6d1bb9fb172566c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">token_ptr mqtt::connect_options::get_token </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the token used as the callback context. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The delivery token used as the callback context. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ade1380d6113d9309291bc0ac6784078c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string mqtt::connect_options::get_user_name </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the user name to use for the connection. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The user name to use for the connection. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2a5deebcf884743ddc30a6ebdda95c3f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const_message_ptr mqtt::connect_options::get_will_message </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the message to be sent as last will and testament (LWT). </p> |
| <dl class="section return"><dt>Returns</dt><dd>The message to be sent as last will and testament (LWT). </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7bba282230d34a8796fc1b52d45df2cd"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classmqtt_1_1will__options.html">will_options</a>& mqtt::connect_options::get_will_options </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the LWT options to use for the connection. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The LWT options to use for the connection. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a017b54a34ef9b2ba16ef5a00b0c72e7c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string mqtt::connect_options::get_will_topic </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the topic to be used for last will and testament (LWT). </p> |
| <dl class="section return"><dt>Returns</dt><dd>The topic to be used for last will and testament (LWT). </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a062dd43eb33c096559678777a9a7f2fe"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mqtt::connect_options::is_clean_session </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns whether the server should remember state for the client across reconnects. </p> |
| <dl class="section return"><dt>Returns</dt><dd><em>true</em> if requesting a clean session, <em>false</em> if not. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a90a1c129374e0babbf668b61dd5c6c05"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmqtt_1_1connect__options.html">connect_options</a>& mqtt::connect_options::operator= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> & </td> |
| <td class="paramname"><em>opt</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy assignment. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opt</td><td>Another object to copy. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a91ac2a642e61b7b3b9f7a667aa272b8a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmqtt_1_1connect__options.html">connect_options</a>& mqtt::connect_options::operator= </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> && </td> |
| <td class="paramname"><em>opt</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Move assignment. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opt</td><td>Another object to move into this new one. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7a4a2086ca01c12eeda4e5d5821eaea4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_automatic_reconnect </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>on</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Enable or disable automatic reconnects. </p> |
| <p>The retry intervals are not affected. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">on</td><td>Whether to turn reconnects on or off </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae5dd4f9ad611b79bfd847035cecd7b0b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_automatic_reconnect </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>minRetryInterval</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>maxRetryInterval</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Enable or disable automatic reconnects. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">minRetryInterval</td><td>Minimum retry interval in seconds. Doubled on each failed retry. </td></tr> |
| <tr><td class="paramname">maxRetryInterval</td><td>Maximum retry interval in seconds. The doubling stops here on failed retries. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2fa264464f0b705af67ba4327afc1425"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Rep1 , class Period1 , class Rep2 , class Period2 > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_automatic_reconnect </td> |
| <td>(</td> |
| <td class="paramtype">const std::chrono::duration< Rep1, Period1 > & </td> |
| <td class="paramname"><em>minRetryInterval</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::chrono::duration< Rep2, Period2 > & </td> |
| <td class="paramname"><em>maxRetryInterval</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Enable or disable automatic reconnects. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">minRetryInterval</td><td>Minimum retry interval. Doubled on each failed retry. </td></tr> |
| <tr><td class="paramname">maxRetryInterval</td><td>Maximum retry interval. The doubling stops here on failed retries. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a403bdb15d0383f160e590cdb19039c30"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_clean_session </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>cleanSession</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets whether the server should remember state for the client across reconnects. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">cleanSession</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3ab5997d6b7faff140a62ad3059ff5f6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_connect_timeout </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>to</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the connect timeout in seconds. </p> |
| <p>This is the maximum time that the underlying library will wait for a connection before failing. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">to</td><td>The connect timeout in seconds. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a597539d16cf450959e99f8c1a2c25c29"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Rep , class Period > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_connect_timeout </td> |
| <td>(</td> |
| <td class="paramtype">const std::chrono::duration< Rep, Period > & </td> |
| <td class="paramname"><em>to</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the connect timeout with a chrono duration. </p> |
| <p>This is the maximum time that the underlying library will wait for a connection before failing. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">to</td><td>The connect timeout in seconds. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a21d0565ce539b40097bb911c50ecbc60"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_connection_timeout </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>timeout</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the connection timeout value. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">timeout</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8f7c99d453da95192b15641a80286441"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_keep_alive_interval </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>keepAliveInterval</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the "keep alive" interval. </p> |
| <p>This is the maximum time that should pass without communications between client and server. If no massages pass in this time, the client will ping the broker. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">keepAliveInterval</td><td>The keep alive interval in seconds. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1fe7db605c853cbf3d96a7f92b1938eb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Rep , class Period > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_keep_alive_interval </td> |
| <td>(</td> |
| <td class="paramtype">const std::chrono::duration< Rep, Period > & </td> |
| <td class="paramname"><em>interval</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the "keep alive" interval with a chrono duration. </p> |
| <p>This is the maximum time that should pass without communications between client and server. If no massages pass in this time, the client will ping the broker. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">interval</td><td>The keep alive interval. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9782ad70a6927ce80ab155928eea2f57"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_max_inflight </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>n</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the maximum number of messages that can be in-flight simultaneously. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">n</td><td>The maximum number of inflight messages. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ade9cf837014937ca3df32bb04c7dca28"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_mqtt_version </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>mqttVersion</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the version of MQTT to be used on the connect. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">mqttVersion</td><td>The MQTT version to use for the connection: <ul> |
| <li>MQTTVERSION_DEFAULT (0) = default: start with 3.1.1, and if that fails, fall back to 3.1 </li> |
| <li>MQTTVERSION_3_1 (3) = only try version 3.1 </li> |
| <li>MQTTVERSION_3_1_1 (4) = only try version 3.1.1 </li> |
| </ul> |
| </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab07b77a183819ef5831bedf158195217"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_servers </td> |
| <td>(</td> |
| <td class="paramtype">const_string_collection_ptr </td> |
| <td class="paramname"><em>serverURIs</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the list of servers to which the client will connect. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">serverURIs</td><td>A pointer to a collection of server URI's. Each entry should be of the form <em>protocol://host</em>:port where <em>protocol</em> must be <em>tcp</em> or <em>ssl</em>. For <em>host</em>, you can specify either an IP address or a domain name. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac7d250c386ffc68aad082c83348588c4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_ssl </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> & </td> |
| <td class="paramname"><em>ssl</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the SSL for the connection. </p> |
| <p>These will only have an effect if compiled against the SSL version of the Paho C library. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ssl</td><td>The SSL options. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2cf8245b406dba323c508b1af7308bba"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_token </td> |
| <td>(</td> |
| <td class="paramtype">const token_ptr & </td> |
| <td class="paramname"><em>tok</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the callback context to a delivery token. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">tok</td><td>The delivery token to be used as the callback context. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0d4c0ab71eccf7785b477df5619943b6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_user_name </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1buffer__ref.html">string_ref</a> </td> |
| <td class="paramname"><em>userName</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the user name to use for the connection. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">userName</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab5c95da2cdcff93f9737a42015002f27"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::connect_options::set_will </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmqtt_1_1will__options.html">will_options</a> & </td> |
| <td class="paramname"><em>will</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the "Last Will and Testament" (LWT) for the connection. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">will</td><td>The LWT options. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3a387bef8a6e27edce8ae7d3f69a613b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string mqtt::connect_options::to_string </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets a string representation of the object. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A string representation of the object. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/mqtt/<a class="el" href="connect__options_8h_source.html">connect_options.h</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"><b>mqtt</b></li><li class="navelem"><a class="el" href="classmqtt_1_1connect__options.html">connect_options</a></li> |
| <li class="footer">Generated on Sun Jul 23 2017 10:24:29 for Paho C++ by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
