Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Contribute to GitLab
Sign in
Toggle navigation
P
paho.mqtt.c
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
eclipse
paho.mqtt.c
Commits
3aafa73a
Commit
3aafa73a
authored
Feb 27, 2013
by
Ian Craggs
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Documentation fixes - bug 373868
parent
a600a680
Expand all
Show whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
5480 additions
and
3326 deletions
+5480
-3326
DoxyfileV3AsyncAPI
doc/DoxyfileV3AsyncAPI
+1803
-1503
DoxyfileV3ClientAPI
doc/DoxyfileV3ClientAPI
+1803
-1503
DoxyfileV3ClientInternal
doc/DoxyfileV3ClientInternal
+1850
-304
MQTTAsync.h
src/MQTTAsync.h
+10
-9
MQTTClient.h
src/MQTTClient.h
+14
-7
No files found.
doc/DoxyfileV3AsyncAPI
View file @
3aafa73a
This diff is collapsed.
Click to expand it.
doc/DoxyfileV3ClientAPI
View file @
3aafa73a
This diff is collapsed.
Click to expand it.
doc/DoxyfileV3ClientInternal
View file @
3aafa73a
This diff is collapsed.
Click to expand it.
src/MQTTAsync.h
View file @
3aafa73a
// Version: %Z% %W% %I% %E% %U%
/*******************************************************************************
/*******************************************************************************
* Copyright (c) 2009, 2013 IBM Corp.
* Copyright (c) 2009, 2013 IBM Corp.
*
*
...
@@ -15,7 +16,7 @@
...
@@ -15,7 +16,7 @@
/**
/**
* @mainpage Asynchronous MQTT client library for C
* @mainpage Asynchronous MQTT client library for C
* © Copyright IBM Corp. 2009, 2013
and made available under the EPL v1.0
* © Copyright IBM Corp. 2009, 2013
*
*
* @brief An Asynchronous MQTT client library for C.
* @brief An Asynchronous MQTT client library for C.
*
*
...
@@ -400,7 +401,7 @@ DLLExport int MQTTAsync_setCallbacks(MQTTAsync handle, void* context, MQTTAsync_
...
@@ -400,7 +401,7 @@ DLLExport int MQTTAsync_setCallbacks(MQTTAsync handle, void* context, MQTTAsync_
* This function creates an MQTT client ready for connection to the
* This function creates an MQTT client ready for connection to the
* specified server and using the specified persistent storage (see
* specified server and using the specified persistent storage (see
* MQTTAsync_persistence). See also MQTTAsync_destroy().
* MQTTAsync_persistence). See also MQTTAsync_destroy().
* @param handle A pointer to an ::MQTT
Client
handle. The handle is
* @param handle A pointer to an ::MQTT
Async
handle. The handle is
* populated with a valid client reference following a successful return from
* populated with a valid client reference following a successful return from
* this function.
* this function.
* @param serverURI A null-terminated string specifying the server to
* @param serverURI A null-terminated string specifying the server to
...
@@ -428,14 +429,14 @@ DLLExport int MQTTAsync_setCallbacks(MQTTAsync handle, void* context, MQTTAsync_
...
@@ -428,14 +429,14 @@ DLLExport int MQTTAsync_setCallbacks(MQTTAsync handle, void* context, MQTTAsync_
* ::MQTTCLIENT_PERSISTENCE_USER: Use an application-specific persistence
* ::MQTTCLIENT_PERSISTENCE_USER: Use an application-specific persistence
* implementation. Using this type of persistence gives control of the
* implementation. Using this type of persistence gives control of the
* persistence mechanism to the application. The application has to implement
* persistence mechanism to the application. The application has to implement
* the MQTT
Async
_persistence interface.
* the MQTT
Client
_persistence interface.
* @param persistence_context If the application uses
* @param persistence_context If the application uses
* ::MQTT
ASYNC
_PERSISTENCE_NONE persistence, this argument is unused and should
* ::MQTT
CLIENT
_PERSISTENCE_NONE persistence, this argument is unused and should
* be set to NULL. For ::MQTT
ASYNC
_PERSISTENCE_DEFAULT persistence, it
* be set to NULL. For ::MQTT
CLIENT
_PERSISTENCE_DEFAULT persistence, it
* should be set to the location of the persistence directory (if set
* should be set to the location of the persistence directory (if set
* to NULL, the persistence directory used is the working directory).
* to NULL, the persistence directory used is the working directory).
* Applications that use ::MQTT
ASYNC
_PERSISTENCE_USER persistence set this
* Applications that use ::MQTT
CLIENT
_PERSISTENCE_USER persistence set this
* argument to point to a valid MQTT
Async
_persistence structure.
* argument to point to a valid MQTT
Client
_persistence structure.
* @return ::MQTTASYNC_SUCCESS if the client is successfully created, otherwise
* @return ::MQTTASYNC_SUCCESS if the client is successfully created, otherwise
* an error code is returned.
* an error code is returned.
*/
*/
...
@@ -1022,7 +1023,7 @@ DLLExport MQTTAsync_nameValue* MQTTAsync_getVersionInfo();
...
@@ -1022,7 +1023,7 @@ DLLExport MQTTAsync_nameValue* MQTTAsync_getVersionInfo();
* @page publish Publication example
* @page publish Publication example
*
@code
@code
#include "stdio.h"
#include "stdio.h"
#include "stdlib.h"
#include "stdlib.h"
#include "string.h"
#include "string.h"
...
@@ -1157,7 +1158,7 @@ int main(int argc, char* argv[])
...
@@ -1157,7 +1158,7 @@ int main(int argc, char* argv[])
* @endcode
* @endcode
* @page subscribe Subscription example
* @page subscribe Subscription example
*
@code
@code
#include "stdio.h"
#include "stdio.h"
#include "stdlib.h"
#include "stdlib.h"
#include "string.h"
#include "string.h"
...
...
src/MQTTClient.h
View file @
3aafa73a
// Version: %Z% %W% %I% %E% %U%
/*******************************************************************************
/*******************************************************************************
* Copyright (c) 2009, 2013 IBM Corp.
* Copyright (c) 2009, 2013 IBM Corp.
*
*
...
@@ -13,10 +14,16 @@
...
@@ -13,10 +14,16 @@
/**
/**
* @mainpage MQTT Client library for C
* @mainpage MQTT Client library for C
* © Copyright IBM Corp. 2009, 2013
and made available under the EPL v1.0
* © Copyright IBM Corp. 2009, 2013
*
*
* @brief An MQTT client library in C.
* @brief An MQTT client library in C.
*
*
* 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>.
*
* An MQTT client application connects to MQTT-capable servers.
* An MQTT client application connects to MQTT-capable servers.
* A typical client is responsible for collecting information from a telemetry
* A typical client is responsible for collecting information from a telemetry
* device and publishing the information to the server. It can also subscribe
* device and publishing the information to the server. It can also subscribe
...
@@ -209,7 +216,7 @@ typedef struct
...
@@ -209,7 +216,7 @@ typedef struct
int
msgid
;
int
msgid
;
}
MQTTClient_message
;
}
MQTTClient_message
;
#define MQTTClient_message_initializer {
"MQTM"
, 0, 0, NULL, 0, 0, 0, 0 }
#define MQTTClient_message_initializer {
{'M', 'Q', 'T', 'M'}
, 0, 0, NULL, 0, 0, 0, 0 }
/**
/**
* This is a callback function. The client application
* This is a callback function. The client application
...
@@ -536,7 +543,7 @@ typedef struct
...
@@ -536,7 +543,7 @@ typedef struct
MQTTClient_SSLOptions
*
ssl
;
MQTTClient_SSLOptions
*
ssl
;
}
MQTTClient_connectOptions
;
}
MQTTClient_connectOptions
;
#define MQTTClient_connectOptions_initializer {
"MQTC"
, 1, 60, 1, 1, NULL, NULL, NULL, 30, 20, NULL }
#define MQTTClient_connectOptions_initializer {
{'M', 'Q', 'T', 'C'}
, 1, 60, 1, 1, NULL, NULL, NULL, 30, 20, NULL }
/**
/**
* MQTTClient_libraryInfo is used to store details relating to the currently used
* MQTTClient_libraryInfo is used to store details relating to the currently used
...
@@ -556,7 +563,7 @@ typedef struct
...
@@ -556,7 +563,7 @@ typedef struct
* no trace information will be returned.
* no trace information will be returned.
* @return an array of strings describing the library. The last entry is a NULL pointer.
* @return an array of strings describing the library. The last entry is a NULL pointer.
*/
*/
DLLExport
MQTTClient_nameValue
*
MQTTClient_getVersionInfo
();
DLLExport
MQTTClient_nameValue
*
MQTTClient_getVersionInfo
(
void
);
/**
/**
* This function attempts to connect a previously-created client (see
* This function attempts to connect a previously-created client (see
...
@@ -936,7 +943,7 @@ DLLExport void MQTTClient_destroy(MQTTClient* handle);
...
@@ -936,7 +943,7 @@ DLLExport void MQTTClient_destroy(MQTTClient* handle);
* and acknowledgement sequence is used than for QoS1 to ensure no duplication
* and acknowledgement sequence is used than for QoS1 to ensure no duplication
* of messages occurs.
* of messages occurs.
* @page pubsync Synchronous publication example
* @page pubsync Synchronous publication example
*
@code
@code
#include "stdio.h"
#include "stdio.h"
#include "stdlib.h"
#include "stdlib.h"
#include "string.h"
#include "string.h"
...
@@ -985,7 +992,7 @@ int main(int argc, char* argv[])
...
@@ -985,7 +992,7 @@ int main(int argc, char* argv[])
* @endcode
* @endcode
*
*
* @page pubasync Asynchronous publication example
* @page pubasync Asynchronous publication example
* @code
@code{.c}
#include "stdio.h"
#include "stdio.h"
#include "stdlib.h"
#include "stdlib.h"
#include "string.h"
#include "string.h"
...
@@ -1069,7 +1076,7 @@ int main(int argc, char* argv[])
...
@@ -1069,7 +1076,7 @@ int main(int argc, char* argv[])
* @endcode
* @endcode
* @page subasync Asynchronous subscription example
* @page subasync Asynchronous subscription example
*
@code
@code
#include "stdio.h"
#include "stdio.h"
#include "stdlib.h"
#include "stdlib.h"
#include "string.h"
#include "string.h"
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment