| <!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.14"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Paho MQTT C Client Library: MQTTClient_connectOptions Struct 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="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> |
| <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 id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Paho MQTT C Client Library |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.14 --> |
| <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> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- 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><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-attribs">Data Fields</a> </div> |
| <div class="headertitle"> |
| <div class="title">MQTTClient_connectOptions Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="_m_q_t_t_client_8h_source.html">MQTTClient.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Data Fields</h2></td></tr> |
| <tr class="memitem:aa5326df180cb23c59afbcab711a06479"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#aa5326df180cb23c59afbcab711a06479">struct_id</a> [4]</td></tr> |
| <tr class="separator:aa5326df180cb23c59afbcab711a06479"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0761a5e5be0383882e42924de8e51f82"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#a0761a5e5be0383882e42924de8e51f82">struct_version</a></td></tr> |
| <tr class="separator:a0761a5e5be0383882e42924de8e51f82"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac8dd0930672a9c7d71fc645aa1f0521d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#ac8dd0930672a9c7d71fc645aa1f0521d">keepAliveInterval</a></td></tr> |
| <tr class="separator:ac8dd0930672a9c7d71fc645aa1f0521d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a036c36a2a4d3a3ffae9ab4dd8b3e7f7b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#a036c36a2a4d3a3ffae9ab4dd8b3e7f7b">cleansession</a></td></tr> |
| <tr class="separator:a036c36a2a4d3a3ffae9ab4dd8b3e7f7b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9f1cdffc99659fd4e2d20e6de3c64df0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#a9f1cdffc99659fd4e2d20e6de3c64df0">reliable</a></td></tr> |
| <tr class="separator:a9f1cdffc99659fd4e2d20e6de3c64df0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0a880e99d47eb2efe552abe5079bdc9d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_m_q_t_t_client__will_options.html">MQTTClient_willOptions</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#a0a880e99d47eb2efe552abe5079bdc9d">will</a></td></tr> |
| <tr class="separator:a0a880e99d47eb2efe552abe5079bdc9d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aba2dfcdfda80edcb531a5a7115d3e043"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#aba2dfcdfda80edcb531a5a7115d3e043">username</a></td></tr> |
| <tr class="separator:aba2dfcdfda80edcb531a5a7115d3e043"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa4a2ebcb494493f648ae1e6975672575"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#aa4a2ebcb494493f648ae1e6975672575">password</a></td></tr> |
| <tr class="separator:aa4a2ebcb494493f648ae1e6975672575"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a38c6aa24b36d981c49405db425c24db0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#a38c6aa24b36d981c49405db425c24db0">connectTimeout</a></td></tr> |
| <tr class="separator:a38c6aa24b36d981c49405db425c24db0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac73f57846c42bcaa9a47e6721a957748"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#ac73f57846c42bcaa9a47e6721a957748">retryInterval</a></td></tr> |
| <tr class="separator:ac73f57846c42bcaa9a47e6721a957748"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8a0b0f0fc7c675312dc232e2458078c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_m_q_t_t_client___s_s_l_options.html">MQTTClient_SSLOptions</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#a8a0b0f0fc7c675312dc232e2458078c7">ssl</a></td></tr> |
| <tr class="separator:a8a0b0f0fc7c675312dc232e2458078c7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa82629005937abd92e97084a428cd61f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#aa82629005937abd92e97084a428cd61f">serverURIcount</a></td></tr> |
| <tr class="separator:aa82629005937abd92e97084a428cd61f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aba22d81c407fb2ba590dba476240d3e9"><td class="memItemLeft" align="right" valign="top">char *const * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#aba22d81c407fb2ba590dba476240d3e9">serverURIs</a></td></tr> |
| <tr class="separator:aba22d81c407fb2ba590dba476240d3e9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a12d546fd0ccf4e1091b18e1b735c7240"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#a12d546fd0ccf4e1091b18e1b735c7240">MQTTVersion</a></td></tr> |
| <tr class="separator:a12d546fd0ccf4e1091b18e1b735c7240"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afe18aeffdebc9758344bb2dfe5ed0c62"><td class="memItemLeft" >struct {</td></tr> |
| <tr class="memitem:a313446ca7679b36652722ffe53d05228"><td class="memItemLeft" >   const char *   <a class="el" href="struct_m_q_t_t_client__connect_options.html#a313446ca7679b36652722ffe53d05228">serverURI</a></td></tr> |
| <tr class="separator:a313446ca7679b36652722ffe53d05228"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a12d546fd0ccf4e1091b18e1b735c7240"><td class="memItemLeft" >   int   <a class="el" href="struct_m_q_t_t_client__connect_options.html#a12d546fd0ccf4e1091b18e1b735c7240">MQTTVersion</a></td></tr> |
| <tr class="separator:a12d546fd0ccf4e1091b18e1b735c7240"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a44baf2cb9a0bbcec3ed2eace43f832d1"><td class="memItemLeft" >   int   <a class="el" href="struct_m_q_t_t_client__connect_options.html#a44baf2cb9a0bbcec3ed2eace43f832d1">sessionPresent</a></td></tr> |
| <tr class="separator:a44baf2cb9a0bbcec3ed2eace43f832d1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afe18aeffdebc9758344bb2dfe5ed0c62"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#afe18aeffdebc9758344bb2dfe5ed0c62">returned</a></td></tr> |
| <tr class="separator:afe18aeffdebc9758344bb2dfe5ed0c62"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6193b7bd6e95bae322b059575b6c61d3"><td class="memItemLeft" >struct {</td></tr> |
| <tr class="memitem:afed088663f8704004425cdae2120b9b3"><td class="memItemLeft" >   int   <a class="el" href="struct_m_q_t_t_client__connect_options.html#afed088663f8704004425cdae2120b9b3">len</a></td></tr> |
| <tr class="separator:afed088663f8704004425cdae2120b9b3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0d49d74db4c035719c3867723cf7e779"><td class="memItemLeft" >   const void *   <a class="el" href="struct_m_q_t_t_client__connect_options.html#a0d49d74db4c035719c3867723cf7e779">data</a></td></tr> |
| <tr class="separator:a0d49d74db4c035719c3867723cf7e779"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6193b7bd6e95bae322b059575b6c61d3"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#a6193b7bd6e95bae322b059575b6c61d3">binarypwd</a></td></tr> |
| <tr class="separator:a6193b7bd6e95bae322b059575b6c61d3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae3f99bf4663ab7b9e9259feeba41fab2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#ae3f99bf4663ab7b9e9259feeba41fab2">maxInflightMessages</a></td></tr> |
| <tr class="separator:ae3f99bf4663ab7b9e9259feeba41fab2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acdcb75a5d5981da027bce83849140f7b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_client__connect_options.html#acdcb75a5d5981da027bce83849140f7b">cleanstart</a></td></tr> |
| <tr class="separator:acdcb75a5d5981da027bce83849140f7b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="struct_m_q_t_t_client__connect_options.html">MQTTClient_connectOptions</a> defines several settings that control the way the client connects to an MQTT server.</p> |
| <p><b>Note:</b> Default values are not defined for members of <a class="el" href="struct_m_q_t_t_client__connect_options.html">MQTTClient_connectOptions</a> so it is good practice to specify all settings. If the <a class="el" href="struct_m_q_t_t_client__connect_options.html">MQTTClient_connectOptions</a> structure is defined as an automatic variable, all members are set to random values and thus must be set by the client application. If the <a class="el" href="struct_m_q_t_t_client__connect_options.html">MQTTClient_connectOptions</a> structure is defined as a static variable, initialization (in compliant compilers) sets all values to 0 (NULL for pointers). A <a class="el" href="struct_m_q_t_t_client__connect_options.html#ac8dd0930672a9c7d71fc645aa1f0521d">keepAliveInterval</a> setting of 0 prevents correct operation of the client and so you <b>must</b> at least set a value for <a class="el" href="struct_m_q_t_t_client__connect_options.html#ac8dd0930672a9c7d71fc645aa1f0521d">keepAliveInterval</a>. </p> |
| </div><h2 class="groupheader">Field Documentation</h2> |
| <a id="aa5326df180cb23c59afbcab711a06479"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa5326df180cb23c59afbcab711a06479">◆ </a></span>struct_id</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">char struct_id[4]</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The eyecatcher for this structure. must be MQTC. </p> |
| |
| </div> |
| </div> |
| <a id="a0761a5e5be0383882e42924de8e51f82"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0761a5e5be0383882e42924de8e51f82">◆ </a></span>struct_version</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int struct_version</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The version number of this structure. Must be 0, 1, 2, 3, 4, 5 or 6. 0 signifies no SSL options and no serverURIs 1 signifies no serverURIs 2 signifies no MQTTVersion 3 signifies no returned values 4 signifies no binary password option 5 signifies no maxInflightMessages and cleanstart </p> |
| |
| </div> |
| </div> |
| <a id="ac8dd0930672a9c7d71fc645aa1f0521d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac8dd0930672a9c7d71fc645aa1f0521d">◆ </a></span>keepAliveInterval</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int keepAliveInterval</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The "keep alive" interval, measured in seconds, defines the maximum time that should pass without communication between the client and the server The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small MQTT "ping" message, which the server will acknowledge. The keep alive interval enables the client to detect when the server is no longer available without having to wait for the long TCP/IP timeout. </p> |
| |
| </div> |
| </div> |
| <a id="a036c36a2a4d3a3ffae9ab4dd8b3e7f7b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a036c36a2a4d3a3ffae9ab4dd8b3e7f7b">◆ </a></span>cleansession</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int cleansession</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>This is a boolean value. The cleansession setting controls the behaviour of both the client and the server at connection and disconnection time. The client and server both maintain session state information. This information is used to ensure "at least once" and "exactly once" delivery, and "exactly once" receipt of messages. Session state also includes subscriptions created by an MQTT client. You can choose to maintain or discard state information between sessions.</p> |
| <p>When cleansession is true, the state information is discarded at connect and disconnect. Setting cleansession to false keeps the state information. When you connect an MQTT client application with <a class="el" href="_m_q_t_t_client_8h.html#aaa8ae61cd65c9dc0846df10122d7bd4e">MQTTClient_connect()</a>, the client identifies the connection using the client identifier and the address of the server. The server checks whether session information for this client has been saved from a previous connection to the server. If a previous session still exists, and cleansession=true, then the previous session information at the client and server is cleared. If cleansession=false, the previous session is resumed. If no previous session exists, a new session is started. </p> |
| |
| </div> |
| </div> |
| <a id="a9f1cdffc99659fd4e2d20e6de3c64df0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9f1cdffc99659fd4e2d20e6de3c64df0">◆ </a></span>reliable</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int reliable</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>This is a boolean value that controls how many messages can be in-flight simultaneously. Setting <em>reliable</em> to true means that a published message must be completed (acknowledgements received) before another can be sent. Attempts to publish additional messages receive an <a class="el" href="_m_q_t_t_client_8h.html#a8fc442fc2e9dfb422a163ab1fa02e0cb">MQTTCLIENT_MAX_MESSAGES_INFLIGHT</a> return code. Setting this flag to false allows up to 10 messages to be in-flight. This can increase overall throughput in some circumstances. </p> |
| |
| </div> |
| </div> |
| <a id="a0a880e99d47eb2efe552abe5079bdc9d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0a880e99d47eb2efe552abe5079bdc9d">◆ </a></span>will</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="struct_m_q_t_t_client__will_options.html">MQTTClient_willOptions</a>* will</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>This is a pointer to an <a class="el" href="struct_m_q_t_t_client__will_options.html">MQTTClient_willOptions</a> structure. If your application does not make use of the Last Will and Testament feature, set this pointer to NULL. </p> |
| |
| </div> |
| </div> |
| <a id="aba2dfcdfda80edcb531a5a7115d3e043"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aba2dfcdfda80edcb531a5a7115d3e043">◆ </a></span>username</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* username</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>MQTT servers that support the MQTT v3.1.1 protocol provide authentication and authorisation by user name and password. This is the user name parameter. </p> |
| |
| </div> |
| </div> |
| <a id="aa4a2ebcb494493f648ae1e6975672575"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa4a2ebcb494493f648ae1e6975672575">◆ </a></span>password</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* password</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>MQTT servers that support the MQTT v3.1.1 protocol provide authentication and authorisation by user name and password. This is the password parameter. </p> |
| |
| </div> |
| </div> |
| <a id="a38c6aa24b36d981c49405db425c24db0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a38c6aa24b36d981c49405db425c24db0">◆ </a></span>connectTimeout</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int connectTimeout</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The time interval in seconds to allow a connect to complete. </p> |
| |
| </div> |
| </div> |
| <a id="ac73f57846c42bcaa9a47e6721a957748"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac73f57846c42bcaa9a47e6721a957748">◆ </a></span>retryInterval</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int retryInterval</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The time interval in seconds after which unacknowledged publish requests are retried during a TCP session. With MQTT 3.1.1 and later, retries are not required except on reconnect. 0 turns off in-session retries, and is the recommended setting. Adding retries to an already overloaded network only exacerbates the problem. </p> |
| |
| </div> |
| </div> |
| <a id="a8a0b0f0fc7c675312dc232e2458078c7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8a0b0f0fc7c675312dc232e2458078c7">◆ </a></span>ssl</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="struct_m_q_t_t_client___s_s_l_options.html">MQTTClient_SSLOptions</a>* ssl</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>This is a pointer to an <a class="el" href="struct_m_q_t_t_client___s_s_l_options.html">MQTTClient_SSLOptions</a> structure. If your application does not make use of SSL, set this pointer to NULL. </p> |
| |
| </div> |
| </div> |
| <a id="aa82629005937abd92e97084a428cd61f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa82629005937abd92e97084a428cd61f">◆ </a></span>serverURIcount</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int serverURIcount</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The number of entries in the optional serverURIs array. Defaults to 0. </p> |
| |
| </div> |
| </div> |
| <a id="aba22d81c407fb2ba590dba476240d3e9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aba22d81c407fb2ba590dba476240d3e9">◆ </a></span>serverURIs</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">char* const* serverURIs</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>An optional array of null-terminated strings specifying the servers to which the client will connect. Each string takes the form <em>protocol://host:port</em>. <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 host name. For instance, to connect to a server running on the local machines with the default MQTT port, specify <em>tcp://localhost:1883</em>. If this list is empty (the default), the server URI specified on <a class="el" href="_m_q_t_t_client_8h.html#a9a0518d9ca924d12c1329dbe3de5f2b6">MQTTClient_create()</a> is used. </p> |
| |
| </div> |
| </div> |
| <a id="a12d546fd0ccf4e1091b18e1b735c7240"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a12d546fd0ccf4e1091b18e1b735c7240">◆ </a></span>MQTTVersion</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int MQTTVersion</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Sets the version of MQTT to be used on the connect. MQTTVERSION_DEFAULT (0) = default: start with 3.1.1, and if that fails, fall back to 3.1 MQTTVERSION_3_1 (3) = only try version 3.1 MQTTVERSION_3_1_1 (4) = only try version 3.1.1 MQTTVERSION_5 (5) = only try version 5.0</p> |
| <p>the MQTT version used to connect with </p> |
| |
| </div> |
| </div> |
| <a id="a313446ca7679b36652722ffe53d05228"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a313446ca7679b36652722ffe53d05228">◆ </a></span>serverURI</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* serverURI</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>the serverURI connected to </p> |
| |
| </div> |
| </div> |
| <a id="a44baf2cb9a0bbcec3ed2eace43f832d1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a44baf2cb9a0bbcec3ed2eace43f832d1">◆ </a></span>sessionPresent</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int sessionPresent</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>if the MQTT version is 3.1.1, the value of sessionPresent returned in the connack </p> |
| |
| </div> |
| </div> |
| <a id="afe18aeffdebc9758344bb2dfe5ed0c62"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afe18aeffdebc9758344bb2dfe5ed0c62">◆ </a></span>returned</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">struct { ... } returned</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returned from the connect when the MQTT version used to connect is 3.1.1 </p> |
| |
| </div> |
| </div> |
| <a id="afed088663f8704004425cdae2120b9b3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afed088663f8704004425cdae2120b9b3">◆ </a></span>len</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int len</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>binary password length </p> |
| |
| </div> |
| </div> |
| <a id="a0d49d74db4c035719c3867723cf7e779"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0d49d74db4c035719c3867723cf7e779">◆ </a></span>data</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const void* data</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>binary password data </p> |
| |
| </div> |
| </div> |
| <a id="a6193b7bd6e95bae322b059575b6c61d3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6193b7bd6e95bae322b059575b6c61d3">◆ </a></span>binarypwd</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">struct { ... } binarypwd</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Optional binary password. Only checked and used if the password option is NULL </p> |
| |
| </div> |
| </div> |
| <a id="ae3f99bf4663ab7b9e9259feeba41fab2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae3f99bf4663ab7b9e9259feeba41fab2">◆ </a></span>maxInflightMessages</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int maxInflightMessages</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The maximum number of messages in flight </p> |
| |
| </div> |
| </div> |
| <a id="acdcb75a5d5981da027bce83849140f7b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acdcb75a5d5981da027bce83849140f7b">◆ </a></span>cleanstart</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int cleanstart</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li><a class="el" href="_m_q_t_t_client_8h_source.html">MQTTClient.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Sep 13 2018 13:40:20 for Paho MQTT C Client Library by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.14 |
| </small></address> |
| </body> |
| </html> |
