wakwak koba / MQTTClient

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of MQTTClient by wakwak koba

Files at this revision

API Documentation at this revision

Revision 11:2a8c86bfdeca, committed 2016-01-04

Comitter:
wakwak_koba
Date:
Mon Jan 04 07:50:26 2016 +0000
Parent:
10:6fa55ad359f0
Commit message:
fixed comment

Changed in this revision

MQTTClient.cpp Show annotated file Show diff for this revision Revisions of this file 
--- a/MQTTClient.cpp	Mon Jan 04 07:24:12 2016 +0000
+++ b/MQTTClient.cpp	Mon Jan 04 07:50:26 2016 +0000
@@ -60,6 +60,17 @@
     timer.start();
 }
 
+/** Alternative Constructor with parameters
+ *
+ * Allow object to be constructed with minimum parameters.
+ *
+ * @param server The IP address of the server to connect to
+ * @param port   The TCP/IP port on the server to connect to
+ * @param id The client name shown on MQTT server.
+ * @param userName Pointer to username string, zero terminated. Null for not used 
+ * @param password Pointer to password string, zero terminated. Null for not used 
+ * @param callback Callback function to handle subscription to topics
+ */
 MQTTClient::MQTTClient(IpAddr server, int port, char *id, char *userName, char *password, void (*callback)(char*, char*)) {
     this->port = port;
     callback_server = callback;
@@ -228,6 +239,7 @@
  *
  * @param pub_topic  The topic name the massage will be publish on.
  * @param msg        The massage to be published.
+ * @param retain     Retain flag.
  * @returns  -1: Failed to publish message. 0: Publish sucessed.
  */
 int MQTTClient::publish(char* pub_topic, char* msg, bool retain) {