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

Fix protocol list and setCallbacks doc #904

This commit is contained in:
Ian Craggs 2020-06-02 23:50:29 +01:00
parent 31d2da6b4a
commit 81a2c0a1a6
2 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/MQTTAsync.h
View File

@ -708,8 +708,9 @@ typedef struct MQTTAsync_responseOptions MQTTAsync_callOptions;
* function. You can set this to NULL if your application doesn't handle
* disconnections.
* @param ma A pointer to an MQTTAsync_messageArrived() callback
* function. You can set this to NULL if your application doesn't handle
* receipt of messages.
* function. If this callback is not set, an error will be returned.
* You must set this callback because otherwise there would be
* no way to deliver any incoming messages.
* @param dc A pointer to an MQTTAsync_deliveryComplete() callback
* function. You can set this to NULL if you do not want to check
* for successful delivery.
@ -823,7 +824,8 @@ LIBMQTT_API int MQTTAsync_reconnect(MQTTAsync handle);
* this function.
* @param serverURI A null-terminated string specifying the server to
* which the client will connect. It takes the form <i>protocol://host:port</i>.
* <i>protocol</i> must be <i>tcp</i> or <i>ssl</i>. For <i>host</i>, you can
* <i>protocol</i> must be <i>tcp</i>, <i>ssl</i>, <i>ws</i> or <i>wss</i>.
* For <i>host</i>, 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
* <i>tcp://localhost:1883</i>.
@ -1170,7 +1172,8 @@ typedef struct
/**
* An array of null-terminated strings specifying the servers to
* which the client will connect. Each string takes the form <i>protocol://host:port</i>.
* <i>protocol</i> must be <i>tcp</i> or <i>ssl</i>. For <i>host</i>, you can
* <i>protocol</i> must be <i>tcp</i>, <i>ssl</i>, <i>ws</i> or <i>wss</i>.
* For <i>host</i>, 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
* <i>tcp://localhost:1883</i>.

10
src/MQTTClient.h
View File

@ -416,8 +416,9 @@ typedef void MQTTClient_connectionLost(void* context, char* cause);
* function. You can set this to NULL if your application doesn't handle
* disconnections.
* @param ma A pointer to an MQTTClient_messageArrived() callback
* function. This callback function must be specified when you call
* MQTTClient_setCallbacks().
* function. This callback function must be set when you call
* MQTTClient_setCallbacks(), as otherwise there would be nowhere to deliver
* any incoming messages.
* @param dc A pointer to an MQTTClient_deliveryComplete() callback
* function. You can set this to NULL if your application publishes
* synchronously or if you do not want to check for successful delivery.
@ -492,7 +493,7 @@ LIBMQTT_API int MQTTClient_setPublished(MQTTClient handle, void* context, MQTTCl
* this function.
* @param serverURI A null-terminated string specifying the server to
* which the client will connect. It takes the form <i>protocol://host:port</i>.
* Currently, <i>protocol</i> must be <i>tcp</i> or <i>ssl</i>.
* Currently, <i>protocol</i> must be <i>tcp</i>, <i>ssl</i>, <i>ws</i> or <i>wss</i>,.
* For <i>host</i>, 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
@ -875,7 +876,8 @@ typedef struct
/**
* An optional array of null-terminated strings specifying the servers to
* which the client will connect. Each string takes the form <i>protocol://host:port</i>.
* <i>protocol</i> must be <i>tcp</i> or <i>ssl</i>. For <i>host</i>, you can
* <i>protocol</i> must be <i>tcp</i>, <i>ssl</i>, <i>ws</i> or <i>wss</i>.
* For <i>host</i>, 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
* <i>tcp://localhost:1883</i>.