Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
icraggs committed Sep 29, 2022
1 parent 50be7f8 commit 0995176
Show file tree
Hide file tree
Showing 351 changed files with 2,064 additions and 1,877 deletions.
33 changes: 24 additions & 9 deletions docs/MQTTAsync/html/_m_q_t_t_async_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -546,7 +546,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#a785250cd4a1938ffeeff67b3
</tr>
</table>
</div><div class="memdoc">
<p>Return code: protocol prefix in serverURI should be tcp://, ssl://, ws:// or wss:// The TLS enabled prefixes (ssl, wss) are only valid if the TLS version of the library is linked with. </p>
<p>Return code: protocol prefix in serverURI should be: </p><ul>
<li><em>tcp://</em> or <em>mqtt://</em> - Insecure TCP </li>
<li><em>ssl://</em> or <em>mqtts://</em> - Encrypted SSL/TLS </li>
<li><em>ws://</em> - Insecure websockets </li>
<li><em>wss://</em> - Secure web sockets</li>
</ul>
<p>The TLS enabled prefixes (ssl, mqtts, wss) are only valid if the TLS version of the library is linked with. </p>

</div>
</div>
Expand Down Expand Up @@ -921,7 +927,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae18b51f22784a43803eb809d
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">{ {<span class="charliteral">&#39;M&#39;</span>, <span class="charliteral">&#39;Q&#39;</span>, <span class="charliteral">&#39;T&#39;</span>, <span class="charliteral">&#39;C&#39;</span>}, 8, 60, 1, 65535, NULL, NULL, NULL, 30, 0,\</div>
<div class="line">NULL, NULL, NULL, NULL, 0, NULL, <a class="code" href="_m_q_t_t_async_8h.html#a75b80b01f98d5a1ffa2a4d42995a8397">MQTTVERSION_DEFAULT</a>, 0, 1, 60, {0, NULL}, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL}</div>
</div><!-- fragment -->
</div><!-- fragment --><p>Initializer for connect options for MQTT 3.1.1 non-WebSocket connections </p>

</div>
</div>
<a id="abd403ce21f7aa0348ae1d3eefd031a5d"></a>
Expand All @@ -937,7 +944,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#abd403ce21f7aa0348ae1d3ee
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">{ {<span class="charliteral">&#39;M&#39;</span>, <span class="charliteral">&#39;Q&#39;</span>, <span class="charliteral">&#39;T&#39;</span>, <span class="charliteral">&#39;C&#39;</span>}, 8, 60, 0, 65535, NULL, NULL, NULL, 30, 0,\</div>
<div class="line">NULL, NULL, NULL, NULL, 0, NULL, <a class="code" href="_m_q_t_t_async_8h.html#af8b176fa4d5b89789767ce972338e1e3">MQTTVERSION_5</a>, 0, 1, 60, {0, NULL}, 1, NULL, NULL, NULL, NULL, NULL, NULL, NULL}</div>
</div><!-- fragment -->
</div><!-- fragment --><p>Initializer for connect options for MQTT 5.0 non-WebSocket connections </p>

</div>
</div>
<a id="a080951d916d7a58c4ceff8c6bacfe313"></a>
Expand All @@ -953,7 +961,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a080951d916d7a58c4ceff8c6
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">{ {<span class="charliteral">&#39;M&#39;</span>, <span class="charliteral">&#39;Q&#39;</span>, <span class="charliteral">&#39;T&#39;</span>, <span class="charliteral">&#39;C&#39;</span>}, 8, 45, 1, 65535, NULL, NULL, NULL, 30, 0,\</div>
<div class="line">NULL, NULL, NULL, NULL, 0, NULL, <a class="code" href="_m_q_t_t_async_8h.html#a75b80b01f98d5a1ffa2a4d42995a8397">MQTTVERSION_DEFAULT</a>, 0, 1, 60, {0, NULL}, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL}</div>
</div><!-- fragment -->
</div><!-- fragment --><p>Initializer for connect options for MQTT 3.1.1 WebSockets connections. The keepalive interval is set to 45 seconds to avoid webserver 60 second inactivity timeouts. </p>

</div>
</div>
<a id="a513bfbec7b7d39c827240db75aa4044b"></a>
Expand All @@ -969,7 +978,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a513bfbec7b7d39c827240db7
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">{ {<span class="charliteral">&#39;M&#39;</span>, <span class="charliteral">&#39;Q&#39;</span>, <span class="charliteral">&#39;T&#39;</span>, <span class="charliteral">&#39;C&#39;</span>}, 8, 45, 0, 65535, NULL, NULL, NULL, 30, 0,\</div>
<div class="line">NULL, NULL, NULL, NULL, 0, NULL, <a class="code" href="_m_q_t_t_async_8h.html#af8b176fa4d5b89789767ce972338e1e3">MQTTVERSION_5</a>, 0, 1, 60, {0, NULL}, 1, NULL, NULL, NULL, NULL, NULL, NULL, NULL}</div>
</div><!-- fragment -->
</div><!-- fragment --><p>Initializer for connect options for MQTT 5.0 WebSockets connections. The keepalive interval is set to 45 seconds to avoid webserver 60 second inactivity timeouts. </p>

</div>
</div>
<a id="a2fd5d6df31928ae468f3f2e522b9c707"></a>
Expand Down Expand Up @@ -1856,7 +1866,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5462c4618d0a229116db5fba
<p>This function creates an MQTT client ready for connection to the specified server and using the specified persistent storage (see MQTTAsync_persistence). See also <a class="el" href="_m_q_t_t_async_8h.html#ad5562f9dc71fbd93d25ad20b328cb887">MQTTAsync_destroy()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>A pointer to an <a class="el" href="_m_q_t_t_async_8h.html#a0db1d736cdc0c864fe41abb3afd605bd">MQTTAsync</a> handle. The handle is populated with a valid client reference following a successful return from this function. </td></tr>
<tr><td class="paramname">serverURI</td><td>A null-terminated string specifying the server to which the client will connect. It takes the form <em>protocol://host:port</em>. <em>protocol</em> must be <em>tcp</em>, <em>ssl</em>, <em>ws</em> or <em>wss</em>. The TLS enabled prefixes (ssl, wss) are only valid if a TLS version of the library is linked with. 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>. </td></tr>
<tr><td class="paramname">serverURI</td><td>A null-terminated string specifying the server to which the client will connect. It takes the form <em>protocol://host:port</em> where <em>protocol</em> must be: <br />
<em>tcp://</em> or <em>mqtt://</em> - Insecure TCP <br />
<em>ssl://</em> or <em>mqtts://</em> - Encrypted SSL/TLS <br />
<em>ws://</em> - Insecure websockets <br />
<em>wss://</em> - Secure web sockets <br />
The TLS enabled prefixes (ssl, mqtts, wss) are only valid if a TLS version of the library is linked with. 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>. </td></tr>
<tr><td class="paramname">clientId</td><td>The client identifier passed to the server when the client connects to it. It is a null-terminated UTF-8 encoded string. </td></tr>
<tr><td class="paramname">persistence_type</td><td>The type of persistence to be used by the client: <br />
<a class="el" href="_m_q_t_t_client_persistence_8h.html#ae01e089313a65ac4661ed216b6ac00fa">MQTTCLIENT_PERSISTENCE_NONE</a>: Use in-memory persistence. If the device or system on which the client is running fails or is switched off, the current state of any in-flight messages is lost and some messages may not be delivered even at QoS1 and QoS2. <br />
Expand Down Expand Up @@ -2647,11 +2662,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#a875cd089a8b23eb3fd50c040
</div>
</div><!-- contents -->
<div class="ttc" id="a_m_q_t_t_reason_codes_8h_html_aba6db0fccfa3f8972ea48117b8b2a279a63b379af5fba8c0512b381a4dbe26969"><div class="ttname"><a href="_m_q_t_t_reason_codes_8h.html#aba6db0fccfa3f8972ea48117b8b2a279a63b379af5fba8c0512b381a4dbe26969">MQTTREASONCODE_SUCCESS</a></div><div class="ttdeci">@ MQTTREASONCODE_SUCCESS</div><div class="ttdef"><b>Definition:</b> MQTTReasonCodes.h:38</div></div>
<div class="ttc" id="a_m_q_t_t_async_8h_html_af8b176fa4d5b89789767ce972338e1e3"><div class="ttname"><a href="_m_q_t_t_async_8h.html#af8b176fa4d5b89789767ce972338e1e3">MQTTVERSION_5</a></div><div class="ttdeci">#define MQTTVERSION_5</div><div class="ttdef"><b>Definition:</b> MQTTAsync.h:216</div></div>
<div class="ttc" id="a_m_q_t_t_async_8h_html_a75b80b01f98d5a1ffa2a4d42995a8397"><div class="ttname"><a href="_m_q_t_t_async_8h.html#a75b80b01f98d5a1ffa2a4d42995a8397">MQTTVERSION_DEFAULT</a></div><div class="ttdeci">#define MQTTVERSION_DEFAULT</div><div class="ttdef"><b>Definition:</b> MQTTAsync.h:204</div></div>
<div class="ttc" id="a_m_q_t_t_async_8h_html_af8b176fa4d5b89789767ce972338e1e3"><div class="ttname"><a href="_m_q_t_t_async_8h.html#af8b176fa4d5b89789767ce972338e1e3">MQTTVERSION_5</a></div><div class="ttdeci">#define MQTTVERSION_5</div><div class="ttdef"><b>Definition:</b> MQTTAsync.h:221</div></div>
<div class="ttc" id="a_m_q_t_t_async_8h_html_a75b80b01f98d5a1ffa2a4d42995a8397"><div class="ttname"><a href="_m_q_t_t_async_8h.html#a75b80b01f98d5a1ffa2a4d42995a8397">MQTTVERSION_DEFAULT</a></div><div class="ttdeci">#define MQTTVERSION_DEFAULT</div><div class="ttdef"><b>Definition:</b> MQTTAsync.h:209</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 28 2022 12:36:40 for Paho Asynchronous MQTT C Client Library by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Sep 29 2022 11:34:45 for Paho Asynchronous MQTT C Client Library by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
Expand Down
Loading

0 comments on commit 0995176

Please sign in to comment.