MQTT
An API for using MQTT over multiple transports
Dependencies: FP MQTTPacket
Dependents: Cellular_HelloMQTT IoTStarterKit GSwifiInterface_HelloMQTT IBMIoTClientEthernetExample ... more
This library is part of the EclipseTM Paho project; specifically the embedded client.
The goals of this API are:
- to be independent of any system library: hence templates parameters for networking, timer and threading classes
- not to rely on heap storage, only automatic (I think this is a good thing)
- to limit memory use, for instance by defining the size of the buffers and arrays used at object creation time
Revision 22:aadb79d29330, committed 2014-04-30
- Comitter:
- icraggs
- Date:
- Wed Apr 30 13:03:45 2014 +0000
- Parent:
- 21:e918525e529d
- Child:
- 23:05fc7de97d4a
- Commit message:
- Documentation updates
Changed in this revision
| MQTTAsync.h | Show annotated file Show diff for this revision Revisions of this file |
| MQTTClient.h | Show annotated file Show diff for this revision Revisions of this file |
--- a/MQTTAsync.h Tue Apr 29 16:04:55 2014 +0000
+++ b/MQTTAsync.h Wed Apr 30 13:03:45 2014 +0000
@@ -69,7 +69,13 @@
}
} Limits;
-
+
+/**
+ * @class Async
+ * @brief non-blocking, threaded MQTT client API
+ * @param Network a network class which supports send, receive
+ * @param Timer a timer class with the methods:
+ */
template<class Network, class Timer, class Thread, class Mutex> class Async
{
--- a/MQTTClient.h Tue Apr 29 16:04:55 2014 +0000
+++ b/MQTTClient.h Wed Apr 30 13:03:45 2014 +0000
@@ -86,14 +86,14 @@
/**
* @class Client
- * @brief blocking, non-threaded MQTT Client API
+ * @brief blocking, non-threaded MQTT client API
* @param Network a network class which supports send, receive
* @param Timer a timer class with the methods:
*/
template<class Network, class Timer> class Client
{
-public:
+public:
/** Construct the client
* @param network - pointer to an instance of the Network class - must be connected to the endpoint