natas_hw
/
paho
mirror of https://github.com/eclipse/paho.mqtt.c
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs for 1.3.16

This commit is contained in:
Ian Craggs 2026-02-20 15:17:35 +00:00
parent a3dd61ffbb
commit 4a939ddb01
No known key found for this signature in database
GPG Key ID: A7AE1A8F2CCAB186
71 changed files with 81 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/MQTTAsync/html/_m_q_t_t_async_8h.html
View File

@ -1781,10 +1781,10 @@ Functions</h2></td></tr>
<tr><td class="paramname">handle</td><td>A pointer to an <a class="el" href="#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> 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>ssl://</em> or <em>tls://</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>
The TLS enabled prefixes (ssl, tls, 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 />

2
docs/MQTTAsync/html/_m_q_t_t_async_8h_source.html
View File

@ -76,7 +76,7 @@ $(function() {
</div><!--header-->
<div class="contents">
<a href="_m_q_t_t_async_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*******************************************************************************</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright (c) 2009, 2025 IBM Corp., Ian Craggs and others</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright (c) 2009, 2026 IBM Corp., Ian Craggs and others</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * All rights reserved. This program and the accompanying materials</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * are made available under the terms of the Eclipse Public License v2.0</span></div>

2
docs/MQTTAsync/html/doxygen.css
View File

@ -2442,7 +2442,7 @@ details[open]>summary::before {
html {
--timestamp: 'Sat Aug 16 2025 14:15:23'
--timestamp: 'Fri Feb 20 2026 15:12:33'
}
span.timestamp { content: ' '; }
span.timestamp:before { content: var(--timestamp); }

4
docs/MQTTAsync/html/index.html
View File

@ -76,8 +76,8 @@ $(function() {
</div><!--header-->
<div class="contents">
<div class="textblock"><p>An Asynchronous MQTT client library for C. </p>
<p>&copy; Copyright 2009, 2025 IBM Corp., Ian Craggs and others.</p>
<p>Version 1.3.15</p>
<p>&copy; Copyright 2009, 2026 IBM Corp., Ian Craggs and others.</p>
<p>Version 1.3.16</p>
<p>An MQTT client application connects to MQTT-capable servers. A typical client is responsible for collecting information from a telemetry device and publishing the information to the server. It can also subscribe to topics, receive messages, and use this information to control the telemetry device.</p>
<p>MQTT clients implement the published MQTT v3 protocol. You can write your own API to the MQTT protocol using the programming language and platform of your choice. This can be time-consuming and error-prone.</p>
<p>To simplify writing MQTT client applications, this library encapsulates the MQTT v3 protocol for you. Using this library enables a fully functional MQTT client application to be written in a few lines of code. The information presented here documents the API provided by the Asynchronous MQTT Client library for C.</p>

2
docs/MQTTAsync/html/struct_m_q_t_t_async__connect_options.html
View File

@ -363,7 +363,7 @@ Data Fields</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">An array of null-terminated strings specifying the servers to
</pre><p> which the client will connect. Each string 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 domain name. For instance, to connect to a server running on the local machines with the default MQTT port, specify <em>tcp://localhost:1883</em>. </p>
</pre><p> which the client will connect. Each string takes the form <em>protocol://host:port</em>. <em>protocol</em> must be <em>tcp</em>, <em>ssl</em>, <em>tls</em>, <em>ws</em> or <em>wss</em>. The TLS enabled prefixes (ssl, tls, 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 domain name. For instance, to connect to a server running on the local machines with the default MQTT port, specify <em>tcp://localhost:1883</em>. </p>
</div>
</div>

6
docs/MQTTAsync/man/man3/MQTTAsync.h.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync.h" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync.h" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -919,13 +919,13 @@ This function creates an MQTT client ready for connection to the specified serve
.br
\fItcp://\fP or \fImqtt://\fP - Insecure TCP
.br
\fIssl://\fP or \fImqtts://\fP - Encrypted SSL/TLS
\fIssl://\fP or \fItls://\fP or \fImqtts://\fP - Encrypted SSL/TLS
.br
\fIws://\fP - Insecure websockets
.br
\fIwss://\fP - 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 \fIhost\fP, 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 \fItcp://localhost:1883\fP\&.
The TLS enabled prefixes (ssl, tls, mqtts, wss) are only valid if a TLS version of the library is linked with\&. For \fIhost\fP, 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 \fItcp://localhost:1883\fP\&.
.br
\fIclientId\fP The client identifier passed to the server when the client connects to it\&. It is a null-terminated UTF-8 encoded string\&.
.br

2
docs/MQTTAsync/man/man3/MQTTAsync_SSLOptions.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_SSLOptions" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_SSLOptions" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTAsync_connectData.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_connectData" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_connectData" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

4
docs/MQTTAsync/man/man3/MQTTAsync_connectOptions.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_connectOptions" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_connectOptions" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -174,7 +174,7 @@ An array of null-terminated strings specifying the servers to
.fi
.PP
which the client will connect\&. Each string takes the form \fIprotocol://host:port\fP\&. \fIprotocol\fP must be \fItcp\fP, \fIssl\fP, \fIws\fP or \fIwss\fP\&. The TLS enabled prefixes (ssl, wss) are only valid if a TLS version of the library is linked with\&. For \fIhost\fP, you can specify either an IP address or a domain name\&. For instance, to connect to a server running on the local machines with the default MQTT port, specify \fItcp://localhost:1883\fP\&.
which the client will connect\&. Each string takes the form \fIprotocol://host:port\fP\&. \fIprotocol\fP must be \fItcp\fP, \fIssl\fP, \fItls\fP, \fIws\fP or \fIwss\fP\&. The TLS enabled prefixes (ssl, tls, wss) are only valid if a TLS version of the library is linked with\&. For \fIhost\fP, you can specify either an IP address or a domain name\&. For instance, to connect to a server running on the local machines with the default MQTT port, specify \fItcp://localhost:1883\fP\&.
.SS "int MQTTVersion"
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
.SS "int automaticReconnect"

2
docs/MQTTAsync/man/man3/MQTTAsync_createOptions.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_createOptions" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_createOptions" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTAsync_disconnectOptions.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_disconnectOptions" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_disconnectOptions" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTAsync_failureData.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_failureData" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_failureData" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTAsync_failureData5.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_failureData5" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_failureData5" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTAsync_init_options.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_init_options" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_init_options" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTAsync_message.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_message" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_message" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTAsync_nameValue.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_nameValue" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_nameValue" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTAsync_responseOptions.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_responseOptions" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_responseOptions" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTAsync_successData.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_successData" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_successData" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTAsync_successData5.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_successData5" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_successData5" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTAsync_willOptions.3
View File

@ -1,4 +1,4 @@
.TH "MQTTAsync_willOptions" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTAsync_willOptions" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTClientPersistence.h.3
View File

@ -1,4 +1,4 @@
.TH "MQTTClientPersistence.h" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTClientPersistence.h" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTClient_persistence.3
View File

@ -1,4 +1,4 @@
.TH "MQTTClient_persistence" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTClient_persistence" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTLenString.3
View File

@ -1,4 +1,4 @@
.TH "MQTTLenString" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTLenString" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTProperties.3
View File

@ -1,4 +1,4 @@
.TH "MQTTProperties" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTProperties" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTProperties.h.3
View File

@ -1,4 +1,4 @@
.TH "MQTTProperties.h" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTProperties.h" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTProperty.3
View File

@ -1,4 +1,4 @@
.TH "MQTTProperty" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTProperty" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTReasonCodes.h.3
View File

@ -1,4 +1,4 @@
.TH "MQTTReasonCodes.h" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTReasonCodes.h" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTSubscribeOpts.h.3
View File

@ -1,4 +1,4 @@
.TH "MQTTSubscribeOpts.h" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTSubscribeOpts.h" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/MQTTSubscribe_options.3
View File

@ -1,4 +1,4 @@
.TH "MQTTSubscribe_options" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTSubscribe_options" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/_h_t_t_p_proxies.3
View File

@ -1,4 +1,4 @@
.TH "_h_t_t_p_proxies" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "_h_t_t_p_proxies" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/async.3
View File

@ -1,4 +1,4 @@
.TH "async" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "async" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/auto_reconnect.3
View File

@ -1,4 +1,4 @@
.TH "auto_reconnect" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "auto_reconnect" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/callbacks.3
View File

@ -1,4 +1,4 @@
.TH "callbacks" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "callbacks" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/offline_publish.3
View File

@ -1,4 +1,4 @@
.TH "offline_publish" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "offline_publish" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/publish.3
View File

@ -1,4 +1,4 @@
.TH "publish" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "publish" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/qos.3
View File

@ -1,4 +1,4 @@
.TH "qos" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "qos" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/subscribe.3
View File

@ -1,4 +1,4 @@
.TH "subscribe" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "subscribe" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/tracing.3
View File

@ -1,4 +1,4 @@
.TH "tracing" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "tracing" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTAsync/man/man3/wildcard.3
View File

@ -1,4 +1,4 @@
.TH "wildcard" 3 "Sat Aug 16 2025 14:15:23" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.TH "wildcard" 3 "Fri Feb 20 2026 15:12:33" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

4
docs/MQTTClient/html/_m_q_t_t_client_8h.html
View File

@ -1145,10 +1145,10 @@ Functions</h2></td></tr>
<tr><td class="paramname">handle</td><td>A pointer to an <a class="el" href="#a7649e3913f9a216424d296f88a969c59">MQTTClient</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>. Currently, <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>ssl://</em> or <em>tls://</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>
The TLS enabled prefixes (ssl, tls, 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 />

2
docs/MQTTClient/html/_m_q_t_t_client_8h_source.html
View File

@ -76,7 +76,7 @@ $(function() {
</div><!--header-->
<div class="contents">
<a href="_m_q_t_t_client_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*******************************************************************************</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright (c) 2009, 2025 IBM Corp., Ian Craggs and others</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright (c) 2009, 2026 IBM Corp., Ian Craggs and others</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * All rights reserved. This program and the accompanying materials</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * are made available under the terms of the Eclipse Public License v2.0</span></div>

2
docs/MQTTClient/html/doxygen.css
View File

@ -2442,7 +2442,7 @@ details[open]>summary::before {
html {
--timestamp: 'Sat Aug 16 2025 14:15:23'
--timestamp: 'Fri Feb 20 2026 15:12:33'
}
span.timestamp { content: ' '; }
span.timestamp:before { content: var(--timestamp); }

4
docs/MQTTClient/html/index.html
View File

@ -76,8 +76,8 @@ $(function() {
</div><!--header-->
<div class="contents">
<div class="textblock"><p>An MQTT client library in C. </p>
<p>&copy; Copyright 2009, 2025 IBM Corp., Ian Craggs and others</p>
<p>Version 1.3.15</p>
<p>&copy; Copyright 2009, 2026 IBM Corp., Ian Craggs and others</p>
<p>Version 1.3.16</p>
<p>These pages describe the original more synchronous API which might be considered easier to use. Some of the calls will block. For the new totally asynchronous API where no calls block, which is especially suitable for use in windowed environments, see the <a href="../../MQTTAsync/html/index.html">MQTT C Client Asynchronous API Documentation</a>. The MQTTClient API is not thread safe, whereas the MQTTAsync API is.</p>
<p>An MQTT client application connects to MQTT-capable servers. A typical client is responsible for collecting information from a telemetry device and publishing the information to the server. It can also subscribe to topics, receive messages, and use this information to control the telemetry device.</p>
<p>MQTT clients implement the published MQTT v3 protocol. You can write your own API to the MQTT protocol using the programming language and platform of your choice. This can be time-consuming and error-prone.</p>

2
docs/MQTTClient/html/struct_m_q_t_t_client__connect_options.html
View File

@ -313,7 +313,7 @@ Data Fields</h2></td></tr>
</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>, <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>. 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>
<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>, <em>ssl</em>, <em>ws</em> or <em>wss</em>. The TLS enabled prefixes (ssl, tls, 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>. 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>

6
docs/MQTTClient/man/man3/MQTTClient.h.3
View File

@ -1,4 +1,4 @@
.TH "MQTTClient.h" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTClient.h" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -590,13 +590,13 @@ This function creates an MQTT client ready for connection to the specified serve
.br
\fItcp://\fP or \fImqtt://\fP - Insecure TCP
.br
\fIssl://\fP or \fImqtts://\fP - Encrypted SSL/TLS
\fIssl://\fP or \fItls://\fP or \fImqtts://\fP - Encrypted SSL/TLS
.br
\fIws://\fP - Insecure websockets
.br
\fIwss://\fP - 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 \fIhost\fP, 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 \fItcp://localhost:1883\fP\&.
The TLS enabled prefixes (ssl, tls, mqtts, wss) are only valid if a TLS version of the library is linked with\&. For \fIhost\fP, 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 \fItcp://localhost:1883\fP\&.
.br
\fIclientId\fP The client identifier passed to the server when the client connects to it\&. It is a null-terminated UTF-8 encoded string\&.
.br

2
docs/MQTTClient/man/man3/MQTTClientPersistence.h.3
View File

@ -1,4 +1,4 @@
.TH "MQTTClientPersistence.h" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTClientPersistence.h" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTClient_SSLOptions.3
View File

@ -1,4 +1,4 @@
.TH "MQTTClient_SSLOptions" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTClient_SSLOptions" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

4
docs/MQTTClient/man/man3/MQTTClient_connectOptions.3
View File

@ -1,4 +1,4 @@
.TH "MQTTClient_connectOptions" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTClient_connectOptions" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -145,7 +145,7 @@ This is a pointer to an \fBMQTTClient_SSLOptions\fP structure\&. If your applica
.SS "int serverURIcount"
The number of entries in the optional serverURIs array\&. Defaults to 0\&.
.SS "char* const* serverURIs"
An optional array of null-terminated strings specifying the servers to which the client will connect\&. Each string takes the form \fIprotocol://host:port\fP\&. \fIprotocol\fP must be \fItcp\fP, \fIssl\fP, \fIws\fP or \fIwss\fP\&. The TLS enabled prefixes (ssl, wss) are only valid if a TLS version of the library is linked with\&. For \fIhost\fP, 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 \fItcp://localhost:1883\fP\&. If this list is empty (the default), the server URI specified on \fBMQTTClient_create()\fP is used\&.
An optional array of null-terminated strings specifying the servers to which the client will connect\&. Each string takes the form \fIprotocol://host:port\fP\&. \fIprotocol\fP must be \fItcp\fP, \fIssl\fP, \fIws\fP or \fIwss\fP\&. The TLS enabled prefixes (ssl, tls, wss) are only valid if a TLS version of the library is linked with\&. For \fIhost\fP, 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 \fItcp://localhost:1883\fP\&. If this list is empty (the default), the server URI specified on \fBMQTTClient_create()\fP is used\&.
.SS "int MQTTVersion"
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

2
docs/MQTTClient/man/man3/MQTTClient_createOptions.3
View File

@ -1,4 +1,4 @@
.TH "MQTTClient_createOptions" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTClient_createOptions" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTClient_init_options.3
View File

@ -1,4 +1,4 @@
.TH "MQTTClient_init_options" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTClient_init_options" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTClient_message.3
View File

@ -1,4 +1,4 @@
.TH "MQTTClient_message" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTClient_message" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTClient_nameValue.3
View File

@ -1,4 +1,4 @@
.TH "MQTTClient_nameValue" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTClient_nameValue" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTClient_persistence.3
View File

@ -1,4 +1,4 @@
.TH "MQTTClient_persistence" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTClient_persistence" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTClient_willOptions.3
View File

@ -1,4 +1,4 @@
.TH "MQTTClient_willOptions" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTClient_willOptions" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTLenString.3
View File

@ -1,4 +1,4 @@
.TH "MQTTLenString" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTLenString" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTProperties.3
View File

@ -1,4 +1,4 @@
.TH "MQTTProperties" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTProperties" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTProperties.h.3
View File

@ -1,4 +1,4 @@
.TH "MQTTProperties.h" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTProperties.h" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTProperty.3
View File

@ -1,4 +1,4 @@
.TH "MQTTProperty" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTProperty" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTReasonCodes.h.3
View File

@ -1,4 +1,4 @@
.TH "MQTTReasonCodes.h" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTReasonCodes.h" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTResponse.3
View File

@ -1,4 +1,4 @@
.TH "MQTTResponse" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTResponse" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTSubscribeOpts.h.3
View File

@ -1,4 +1,4 @@
.TH "MQTTSubscribeOpts.h" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTSubscribeOpts.h" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/MQTTSubscribe_options.3
View File

@ -1,4 +1,4 @@
.TH "MQTTSubscribe_options" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "MQTTSubscribe_options" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/_h_t_t_p_proxies.3
View File

@ -1,4 +1,4 @@
.TH "_h_t_t_p_proxies" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "_h_t_t_p_proxies" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/async.3
View File

@ -1,4 +1,4 @@
.TH "async" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "async" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/callbacks.3
View File

@ -1,4 +1,4 @@
.TH "callbacks" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "callbacks" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/pubasync.3
View File

@ -1,4 +1,4 @@
.TH "pubasync" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "pubasync" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/pubsync.3
View File

@ -1,4 +1,4 @@
.TH "pubsync" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "pubsync" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/qos.3
View File

@ -1,4 +1,4 @@
.TH "qos" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "qos" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/subasync.3
View File

@ -1,4 +1,4 @@
.TH "subasync" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "subasync" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/tracing.3
View File

@ -1,4 +1,4 @@
.TH "tracing" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "tracing" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/MQTTClient/man/man3/wildcard.3
View File

@ -1,4 +1,4 @@
.TH "wildcard" 3 "Sat Aug 16 2025 14:15:23" "Paho MQTT C Client Library" \" -*- nroff -*-
.TH "wildcard" 3 "Fri Feb 20 2026 15:12:33" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME