Skip to content

Commit 317fb00

Browse files
committed
Update online docs
1 parent 12f7b0e commit 317fb00

File tree

797 files changed

+4077
-4206
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

797 files changed

+4077
-4206
lines changed

docs/MQTTAsync/html/_m_q_t_t_async_8h.html

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -288,8 +288,8 @@
288288
<tr class="separator:a46c332245c379629ae11f457fc179457"><td class="memSeparator" colspan="2">&#160;</td></tr>
289289
<tr class="memitem:ae10bd009934b3bb4a9f4abae7424a611"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_q_t_t_async_8h.html#ae10bd009934b3bb4a9f4abae7424a611">MQTTAsync_subscribe</a> (<a class="el" href="_m_q_t_t_async_8h.html#a0db1d736cdc0c864fe41abb3afd605bd">MQTTAsync</a> handle, const char *topic, int qos, <a class="el" href="struct_m_q_t_t_async__response_options.html">MQTTAsync_responseOptions</a> *response)</td></tr>
290290
<tr class="separator:ae10bd009934b3bb4a9f4abae7424a611"><td class="memSeparator" colspan="2">&#160;</td></tr>
291-
<tr class="memitem:a8a956fd9eed94eeb1bf87c88abf43f9d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_q_t_t_async_8h.html#a8a956fd9eed94eeb1bf87c88abf43f9d">MQTTAsync_subscribeMany</a> (<a class="el" href="_m_q_t_t_async_8h.html#a0db1d736cdc0c864fe41abb3afd605bd">MQTTAsync</a> handle, int count, char *const *topic, int *qos, <a class="el" href="struct_m_q_t_t_async__response_options.html">MQTTAsync_responseOptions</a> *response)</td></tr>
292-
<tr class="separator:a8a956fd9eed94eeb1bf87c88abf43f9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
291+
<tr class="memitem:ac78620b33434a187255bd1a3faec1578"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_q_t_t_async_8h.html#ac78620b33434a187255bd1a3faec1578">MQTTAsync_subscribeMany</a> (<a class="el" href="_m_q_t_t_async_8h.html#a0db1d736cdc0c864fe41abb3afd605bd">MQTTAsync</a> handle, int count, char *const *topic, const int *qos, <a class="el" href="struct_m_q_t_t_async__response_options.html">MQTTAsync_responseOptions</a> *response)</td></tr>
292+
<tr class="separator:ac78620b33434a187255bd1a3faec1578"><td class="memSeparator" colspan="2">&#160;</td></tr>
293293
<tr class="memitem:a08d18ece91c1b011011354570d8ac1ab"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_q_t_t_async_8h.html#a08d18ece91c1b011011354570d8ac1ab">MQTTAsync_unsubscribe</a> (<a class="el" href="_m_q_t_t_async_8h.html#a0db1d736cdc0c864fe41abb3afd605bd">MQTTAsync</a> handle, const char *topic, <a class="el" href="struct_m_q_t_t_async__response_options.html">MQTTAsync_responseOptions</a> *response)</td></tr>
294294
<tr class="separator:a08d18ece91c1b011011354570d8ac1ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
295295
<tr class="memitem:a69fd433ce1b9b6a1b3b453c4793a9311"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_q_t_t_async_8h.html#a69fd433ce1b9b6a1b3b453c4793a9311">MQTTAsync_unsubscribeMany</a> (<a class="el" href="_m_q_t_t_async_8h.html#a0db1d736cdc0c864fe41abb3afd605bd">MQTTAsync</a> handle, int count, char *const *topic, <a class="el" href="struct_m_q_t_t_async__response_options.html">MQTTAsync_responseOptions</a> *response)</td></tr>
@@ -1153,6 +1153,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5e44304a2c011a7d61b72c77
11531153
</tr>
11541154
</table>
11551155
</div><div class="memdoc">
1156+
<p>This is a callback function which will allow the client application to update the connection data. </p><dl class="params"><dt>Parameters</dt><dd>
1157+
<table class="params">
1158+
<tr><td class="paramname">data</td><td>The connection data which can be modified by the application. </td></tr>
1159+
</table>
1160+
</dd>
1161+
</dl>
1162+
<dl class="section return"><dt>Returns</dt><dd>Return a non-zero value to update the connect data, zero to keep the same data. </dd></dl>
11561163

11571164
</div>
11581165
</div>
@@ -2025,7 +2032,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae10bd009934b3bb4a9f4abae
20252032
</tr>
20262033
</table>
20272034
</div><div class="memdoc">
2028-
<p>This function attempts to subscribe a client to a single topic, which may contain wildcards (see <a class="el" href="wildcard.html">Subscription wildcards</a>). This call also specifies the <a class="el" href="qos.html">Quality of service</a> requested for the subscription (see also <a class="el" href="_m_q_t_t_async_8h.html#a8a956fd9eed94eeb1bf87c88abf43f9d">MQTTAsync_subscribeMany()</a>). </p><dl class="params"><dt>Parameters</dt><dd>
2035+
<p>This function attempts to subscribe a client to a single topic, which may contain wildcards (see <a class="el" href="wildcard.html">Subscription wildcards</a>). This call also specifies the <a class="el" href="qos.html">Quality of service</a> requested for the subscription (see also <a class="el" href="_m_q_t_t_async_8h.html#ac78620b33434a187255bd1a3faec1578">MQTTAsync_subscribeMany()</a>). </p><dl class="params"><dt>Parameters</dt><dd>
20292036
<table class="params">
20302037
<tr><td class="paramname">handle</td><td>A valid client handle from a successful call to <a class="el" href="_m_q_t_t_async_8h.html#a5462c4618d0a229116db5fbadacf95d2">MQTTAsync_create()</a>. </td></tr>
20312038
<tr><td class="paramname">topic</td><td>The subscription topic, which may include wildcards. </td></tr>
@@ -2038,8 +2045,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae10bd009934b3bb4a9f4abae
20382045

20392046
</div>
20402047
</div>
2041-
<a id="a8a956fd9eed94eeb1bf87c88abf43f9d"></a>
2042-
<h2 class="memtitle"><span class="permalink"><a href="#a8a956fd9eed94eeb1bf87c88abf43f9d">&#9670;&nbsp;</a></span>MQTTAsync_subscribeMany()</h2>
2048+
<a id="ac78620b33434a187255bd1a3faec1578"></a>
2049+
<h2 class="memtitle"><span class="permalink"><a href="#ac78620b33434a187255bd1a3faec1578">&#9670;&nbsp;</a></span>MQTTAsync_subscribeMany()</h2>
20432050

20442051
<div class="memitem">
20452052
<div class="memproto">
@@ -2065,7 +2072,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8a956fd9eed94eeb1bf87c88
20652072
<tr>
20662073
<td class="paramkey"></td>
20672074
<td></td>
2068-
<td class="paramtype">int *&#160;</td>
2075+
<td class="paramtype">const int *&#160;</td>
20692076
<td class="paramname"><em>qos</em>, </td>
20702077
</tr>
20712078
<tr>
@@ -2243,7 +2250,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a63c66a311ab16239a4175ff6
22432250
</tr>
22442251
</table>
22452252
</div><div class="memdoc">
2246-
<p>This function attempts to publish a message to a given topic (see also <a class="el" href="_m_q_t_t_async_8h.html#a5687171e67e98f9ea590c9e3b64cde18">MQTTAsync_sendMessage()</a>). An <a class="el" href="_m_q_t_t_async_8h.html#a7ca6d2a1813f2bbd0bc3af2771e46ba4">MQTTAsync_token</a> is issued when this function returns successfully. If the client application needs to test for successful delivery of messages, a callback should be set (see <a class="el" href="_m_q_t_t_async_8h.html#a7b0c18a0e29e2ce73f3ea109bc32617b">MQTTAsync_onSuccess()</a> and <a class="el" href="_m_q_t_t_async_8h.html#ab10296618e266b3c02fd117d6616b15d">MQTTAsync_deliveryComplete()</a>). </p><dl class="params"><dt>Parameters</dt><dd>
2253+
<p>This function attempts to publish a message to a given topic (see also <a class="el" href="_m_q_t_t_async_8h.html#a5687171e67e98f9ea590c9e3b64cde18">MQTTAsync_sendMessage()</a>). An <a class="el" href="_m_q_t_t_async_8h.html#a7ca6d2a1813f2bbd0bc3af2771e46ba4">MQTTAsync_token</a> is issued when this function returns successfully if the QoS is greater than 0. If the client application needs to test for successful delivery of messages, a callback should be set (see <a class="el" href="_m_q_t_t_async_8h.html#a7b0c18a0e29e2ce73f3ea109bc32617b">MQTTAsync_onSuccess()</a> and <a class="el" href="_m_q_t_t_async_8h.html#ab10296618e266b3c02fd117d6616b15d">MQTTAsync_deliveryComplete()</a>). </p><dl class="params"><dt>Parameters</dt><dd>
22472254
<table class="params">
22482255
<tr><td class="paramname">handle</td><td>A valid client handle from a successful call to <a class="el" href="_m_q_t_t_async_8h.html#a5462c4618d0a229116db5fbadacf95d2">MQTTAsync_create()</a>. </td></tr>
22492256
<tr><td class="paramname">destinationName</td><td>The topic associated with this message. </td></tr>
@@ -2296,7 +2303,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5687171e67e98f9ea590c9e3
22962303
</tr>
22972304
</table>
22982305
</div><div class="memdoc">
2299-
<p>This function attempts to publish a message to a given topic (see also MQTTAsync_publish()). An <a class="el" href="_m_q_t_t_async_8h.html#a7ca6d2a1813f2bbd0bc3af2771e46ba4">MQTTAsync_token</a> is issued when this function returns successfully. If the client application needs to test for successful delivery of messages, a callback should be set (see <a class="el" href="_m_q_t_t_async_8h.html#a7b0c18a0e29e2ce73f3ea109bc32617b">MQTTAsync_onSuccess()</a> and <a class="el" href="_m_q_t_t_async_8h.html#ab10296618e266b3c02fd117d6616b15d">MQTTAsync_deliveryComplete()</a>). </p><dl class="params"><dt>Parameters</dt><dd>
2306+
<p>This function attempts to publish a message to a given topic (see also MQTTAsync_publish()). An <a class="el" href="_m_q_t_t_async_8h.html#a7ca6d2a1813f2bbd0bc3af2771e46ba4">MQTTAsync_token</a> is issued when this function returns successfully if the QoS is greater than 0. If the client application needs to test for successful delivery of messages, a callback should be set (see <a class="el" href="_m_q_t_t_async_8h.html#a7b0c18a0e29e2ce73f3ea109bc32617b">MQTTAsync_onSuccess()</a> and <a class="el" href="_m_q_t_t_async_8h.html#ab10296618e266b3c02fd117d6616b15d">MQTTAsync_deliveryComplete()</a>). </p><dl class="params"><dt>Parameters</dt><dd>
23002307
<table class="params">
23012308
<tr><td class="paramname">handle</td><td>A valid client handle from a successful call to <a class="el" href="_m_q_t_t_async_8h.html#a5462c4618d0a229116db5fbadacf95d2">MQTTAsync_create()</a>. </td></tr>
23022309
<tr><td class="paramname">destinationName</td><td>The topic associated with this message. </td></tr>
@@ -2405,7 +2412,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4fe09cc9c976b1cf424e1376
24052412
</tr>
24062413
</table>
24072414
</div><div class="memdoc">
2408-
<p>Waits for a request corresponding to a token to complete.</p>
2415+
<p>Waits for a request corresponding to a token to complete. This only works for messages with QoS greater than 0. A QoS 0 message has no MQTT token. This function will always return <a class="el" href="_m_q_t_t_async_8h.html#afe0cffcce8efe25186f79c51ac44e16f">MQTTASYNC_SUCCESS</a> for a QoS 0 message.</p>
24092416
<dl class="params"><dt>Parameters</dt><dd>
24102417
<table class="params">
24112418
<tr><td class="paramname">handle</td><td>A valid client handle from a successful call to <a class="el" href="_m_q_t_t_async_8h.html#a5462c4618d0a229116db5fbadacf95d2">MQTTAsync_create()</a>. </td></tr>
@@ -2612,7 +2619,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a875cd089a8b23eb3fd50c040
26122619
<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:195</div></div>
26132620
<!-- start footer part -->
26142621
<hr class="footer"/><address class="footer"><small>
2615-
Generated on Sat Nov 21 2020 00:15:30 for Paho Asynchronous MQTT C Client Library by &#160;<a href="http://www.doxygen.org/index.html">
2622+
Generated on Sat Dec 26 2020 12:43:47 for Paho Asynchronous MQTT C Client Library by &#160;<a href="http://www.doxygen.org/index.html">
26162623
<img class="footer" src="doxygen.png" alt="doxygen"/>
26172624
</a> 1.8.17
26182625
</small></address>

0 commit comments

Comments
 (0)