Crate paho_mqtt3as_sys [−] [src]
Structs
| MQTTAsync_SSLOptions |
MQTTAsync_sslProperties defines the settings to establish an SSL/TLS connection using the OpenSSL library. It covers the following scenarios: - Server authentication: The client needs the digital certificate of the server. It is included in a store containting trusted material (also known as "trust store"). - Mutual authentication: Both client and server are authenticated during the SSL handshake. In addition to the digital certificate of the server in a trust store, the client will need its own digital certificate and the private key used to sign its digital certificate stored in a "key store". - Anonymous connection: Both client and server do not get authenticated and no credentials are needed to establish an SSL connection. Note that this scenario is not fully secure since it is subject to man-in-the-middle attacks. |
| MQTTAsync_connectOptions |
MQTTAsync_connectOptions defines several settings that control the way the client connects to an MQTT server. Default values are set in MQTTAsync_connectOptions_initializer. |
| MQTTAsync_connectOptions__bindgen_ty_1 |
Optional binary password. Only checked and used if the password option is NULL |
| MQTTAsync_createOptions | |
| MQTTAsync_disconnectOptions | |
| MQTTAsync_failureData |
The data returned on completion of an unsuccessful API call in the response callback onFailure. |
| MQTTAsync_init_options |
Initialization options |
| MQTTAsync_message |
A structure representing the payload and attributes of an MQTT message. The message topic is not part of this structure (see MQTTAsync_publishMessage(), MQTTAsync_publish(), MQTTAsync_receive(), MQTTAsync_freeMessage() and MQTTAsync_messageArrived()). |
| MQTTAsync_nameValue | |
| MQTTAsync_responseOptions | |
| MQTTAsync_successData |
The data returned on completion of a successful API call in the response callback onSuccess. |
| MQTTAsync_successData__bindgen_ty_1__bindgen_ty_1 |
For publish, the message being sent to the server. |
| MQTTAsync_successData__bindgen_ty_1__bindgen_ty_2 | |
| MQTTAsync_willOptions |
MQTTAsync_willOptions defines the MQTT "Last Will and Testament" (LWT) settings for the client. In the event that a client unexpectedly loses its connection to the server, the server publishes the LWT message to the LWT topic on behalf of the client. This allows other clients (subscribed to the LWT topic) to be made aware that the client has disconnected. To enable the LWT function for a specific client, a valid pointer to an MQTTAsync_willOptions structure is passed in the MQTTAsync_connectOptions structure used in the MQTTAsync_connect() call that connects the client to the server. The pointer to MQTTAsync_willOptions can be set to NULL if the LWT function is not required. |
| MQTTAsync_willOptions__bindgen_ty_1 |
The LWT payload in binary form. This is only checked and used if the message option is NULL |
| MQTTClient_persistence |
@brief A structure containing the function pointers to a persistence implementation and the context or state that will be shared across all the persistence functions. |
| _G_fpos64_t | |
| _G_fpos_t | |
| _IO_FILE | |
| _IO_FILE_plus | |
| _IO_jump_t | |
| _IO_marker | |
| __fsid_t | |
| __mbstate_t | |
| __va_list_tag |
Enums
| MQTTASYNC_TRACE_LEVELS | |
| __codecvt_result |
Constants
Statics
| _IO_2_1_stderr_ | |
| _IO_2_1_stdin_ | |
| _IO_2_1_stdout_ | |
| stderr | |
| stdin | |
| stdout | |
| sys_errlist | |
| sys_nerr |
Functions
| MQTTAsync_connect⚠ |
This function attempts to connect a previously-created client (see
MQTTAsync_create()) to an MQTT server using the specified options. If you
want to enable asynchronous message and status notifications, you must call
MQTTAsync_setCallbacks() prior to MQTTAsync_connect().
@param handle A valid client handle from a successful call to
MQTTAsync_create().
@param options A pointer to a valid MQTTAsync_connectOptions
structure.
@return ::MQTTASYNC_SUCCESS if the client connect request was accepted.
If the client was unable to connect to the server, an error code is
returned via the onFailure callback, if set.
Error codes greater than 0 are returned by the MQTT protocol: |
| MQTTAsync_create⚠ |
This function creates an MQTT client ready for connection to the
specified server and using the specified persistent storage (see
MQTTAsync_persistence). See also MQTTAsync_destroy().
@param handle A pointer to an ::MQTTAsync handle. The handle is
populated with a valid client reference following a successful return from
this function.
@param serverURI A null-terminated string specifying the server to
which the client will connect. It takes the form protocol://host:port.
protocol must be tcp or ssl. For host, 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
tcp://localhost:1883.
@param clientId The client identifier passed to the server when the
client connects to it. It is a null-terminated UTF-8 encoded string.
@param persistence_type The type of persistence to be used by the client:
|
| MQTTAsync_createWithOptions⚠ | |
| MQTTAsync_destroy⚠ |
This function frees the memory allocated to an MQTT client (see MQTTAsync_create()). It should be called when the client is no longer required. @param handle A pointer to the handle referring to the ::MQTTAsync structure to be freed. |
| MQTTAsync_disconnect⚠ |
This function attempts to disconnect the client from the MQTT server. In order to allow the client time to complete handling of messages that are in-flight when this function is called, a timeout period is specified. When the timeout period has expired, the client disconnects even if there are still outstanding message acknowledgements. The next time the client connects to the same server, any QoS 1 or 2 messages which have not completed will be retried depending on the cleansession settings for both the previous and the new connection (see MQTTAsync_connectOptions.cleansession and MQTTAsync_connect()). @param handle A valid client handle from a successful call to MQTTAsync_create(). @param options The client delays disconnection for up to this time (in milliseconds) in order to allow in-flight message transfers to complete. @return ::MQTTASYNC_SUCCESS if the client successfully disconnects from the server. An error code is returned if the client was unable to disconnect from the server |
| MQTTAsync_free⚠ |
This function frees memory allocated by the MQTT C client library, especially the topic name. This is needed on Windows when the client libary and application program have been compiled with different versions of the C compiler. It is thus good policy to always use this function when freeing any MQTT C client- allocated memory. @param ptr The pointer to the client library storage to be freed. |
| MQTTAsync_freeMessage⚠ |
This function frees memory allocated to an MQTT message, including the additional memory allocated to the message payload. The client application calls this function when the message has been fully processed. Important note: This function does not free the memory allocated to a message topic string. It is the responsibility of the client application to free this memory using the MQTTAsync_free() library function. @param msg The address of a pointer to the ::MQTTAsync_message structure to be freed. |
| MQTTAsync_getPendingTokens⚠ |
This function sets a pointer to an array of tokens for messages that are currently in-flight (pending completion). |
| MQTTAsync_getVersionInfo⚠ |
This function returns version information about the library. no trace information will be returned. The default trace level is MQTTASYNC_TRACE_MINIMUM @return an array of strings describing the library. The last entry is a NULL pointer. |
| MQTTAsync_global_init⚠ |
Global init of mqtt library. Call once on program start to set global behaviour. handle_openssl_init - if mqtt library should handle openssl init (1) or rely on the caller to init it before using mqtt (0) |
| MQTTAsync_isComplete⚠ | |
| MQTTAsync_isConnected⚠ |
This function allows the client application to test whether or not a client is currently connected to the MQTT server. @param handle A valid client handle from a successful call to MQTTAsync_create(). @return Boolean true if the client is connected, otherwise false. |
| MQTTAsync_reconnect⚠ |
Reconnects a client with the previously used connect options. Connect must have previously been called for this to work. @param handle A valid client handle from a successful call to MQTTAsync_create(). @return ::MQTTASYNC_SUCCESS if the callbacks were correctly set, ::MQTTASYNC_FAILURE if an error occurred. |
| MQTTAsync_send⚠ |
This function attempts to publish a message to a given topic (see also ::MQTTAsync_sendMessage()). An ::MQTTAsync_token is issued when this function returns successfully. If the client application needs to test for successful delivery of messages, a callback should be set (see ::MQTTAsync_onSuccess() and ::MQTTAsync_deliveryComplete()). @param handle A valid client handle from a successful call to MQTTAsync_create(). @param destinationName The topic associated with this message. @param payloadlen The length of the payload in bytes. @param payload A pointer to the byte array payload of the message. @param qos The @ref qos of the message. @param retained The retained flag for the message. @param response A pointer to an ::MQTTAsync_responseOptions structure. Used to set callback functions. This is optional and can be set to NULL. @return ::MQTTASYNC_SUCCESS if the message is accepted for publication. An error code is returned if there was a problem accepting the message. |
| MQTTAsync_sendMessage⚠ |
This function attempts to publish a message to a given topic (see also MQTTAsync_publish()). An ::MQTTAsync_token is issued when this function returns successfully. If the client application needs to test for successful delivery of messages, a callback should be set (see ::MQTTAsync_onSuccess() and ::MQTTAsync_deliveryComplete()). @param handle A valid client handle from a successful call to MQTTAsync_create(). @param destinationName The topic associated with this message. @param msg A pointer to a valid MQTTAsync_message structure containing the payload and attributes of the message to be published. @param response A pointer to an ::MQTTAsync_responseOptions structure. Used to set callback functions. @return ::MQTTASYNC_SUCCESS if the message is accepted for publication. An error code is returned if there was a problem accepting the message. |
| MQTTAsync_setCallbacks⚠ |
This function sets the global callback functions for a specific client. If your client application doesn't use a particular callback, set the relevant parameter to NULL. Any necessary message acknowledgements and status communications are handled in the background without any intervention from the client application. If you do not set a messageArrived callback function, you will not be notified of the receipt of any messages as a result of a subscription. |
| MQTTAsync_setConnected⚠ |
Sets the MQTTAsync_connected() callback function for a client. @param handle A valid client handle from a successful call to MQTTAsync_create(). @param context A pointer to any application-specific context. The the context pointer is passed to each of the callback functions to provide access to the context information in the callback. @param co A pointer to an MQTTAsync_connected() callback function. NULL removes the callback setting. @return ::MQTTASYNC_SUCCESS if the callbacks were correctly set, ::MQTTASYNC_FAILURE if an error occurred. |
| MQTTAsync_setTraceCallback⚠ |
This function sets the trace callback if needed. If set to NULL, no trace information will be returned. The default trace level is MQTTASYNC_TRACE_MINIMUM. @param callback a pointer to the function which will handle the trace information |
| MQTTAsync_setTraceLevel⚠ |
This function sets the level of trace information which will be returned in the trace callback. @param level the trace level required |
| MQTTAsync_subscribe⚠ |
This function attempts to subscribe a client to a single topic, which may contain wildcards (see @ref wildcard). This call also specifies the @ref qos requested for the subscription (see also MQTTAsync_subscribeMany()). @param handle A valid client handle from a successful call to MQTTAsync_create(). @param topic The subscription topic, which may include wildcards. @param qos The requested quality of service for the subscription. @param response A pointer to a response options structure. Used to set callback functions. @return ::MQTTASYNC_SUCCESS if the subscription request is successful. An error code is returned if there was a problem registering the subscription. |
| MQTTAsync_subscribeMany⚠ |
This function attempts to subscribe a client to a list of topics, which may contain wildcards (see @ref wildcard). This call also specifies the @ref qos requested for each topic (see also MQTTAsync_subscribe()). @param handle A valid client handle from a successful call to MQTTAsync_create(). @param count The number of topics for which the client is requesting subscriptions. @param topic An array (of length count) of pointers to topics, each of which may include wildcards. @param qos An array (of length count) of @ref qos values. qos[n] is the requested QoS for topic[n]. @param response A pointer to a response options structure. Used to set callback functions. @return ::MQTTASYNC_SUCCESS if the subscription request is successful. An error code is returned if there was a problem registering the subscriptions. |
| MQTTAsync_unsubscribe⚠ |
This function attempts to remove an existing subscription made by the specified client. @param handle A valid client handle from a successful call to MQTTAsync_create(). @param topic The topic for the subscription to be removed, which may include wildcards (see @ref wildcard). @param response A pointer to a response options structure. Used to set callback functions. @return ::MQTTASYNC_SUCCESS if the subscription is removed. An error code is returned if there was a problem removing the subscription. |
| MQTTAsync_unsubscribeMany⚠ |
This function attempts to remove existing subscriptions to a list of topics made by the specified client. @param handle A valid client handle from a successful call to MQTTAsync_create(). @param count The number subscriptions to be removed. @param topic An array (of length count) of pointers to the topics of the subscriptions to be removed, each of which may include wildcards. @param response A pointer to a response options structure. Used to set callback functions. @return ::MQTTASYNC_SUCCESS if the subscriptions are removed. An error code is returned if there was a problem removing the subscriptions. |
| MQTTAsync_waitForCompletion⚠ |
Waits for a request corresponding to a token to complete. |
| _IO_feof⚠ | |
| _IO_ferror⚠ | |
| _IO_flockfile⚠ | |
| _IO_free_backup_area⚠ | |
| _IO_ftrylockfile⚠ | |
| _IO_funlockfile⚠ | |
| _IO_getc⚠ | |
| _IO_padn⚠ | |
| _IO_peekc_locked⚠ | |
| _IO_putc⚠ | |
| _IO_seekoff⚠ | |
| _IO_seekpos⚠ | |
| _IO_sgetn⚠ | |
| _IO_vfprintf⚠ | |
| _IO_vfscanf⚠ | |
| __getdelim⚠ | |
| __overflow⚠ | |
| __uflow⚠ | |
| __underflow⚠ | |
| clearerr⚠ | |
| clearerr_unlocked⚠ | |
| ctermid⚠ | |
| dprintf⚠ | |
| fclose⚠ | |
| fdopen⚠ | |
| feof⚠ | |
| feof_unlocked⚠ | |
| ferror⚠ | |
| ferror_unlocked⚠ | |
| fflush⚠ | |
| fflush_unlocked⚠ | |
| fgetc⚠ | |
| fgetc_unlocked⚠ | |
| fgetpos⚠ | |
| fgets⚠ | |
| fileno⚠ | |
| fileno_unlocked⚠ | |
| flockfile⚠ | |
| fmemopen⚠ | |
| fopen⚠ | |
| fprintf⚠ | |
| fputc⚠ | |
| fputc_unlocked⚠ | |
| fputs⚠ | |
| fread⚠ | |
| fread_unlocked⚠ | |
| freopen⚠ | |
| fscanf⚠ | |
| fseek⚠ | |
| fseeko⚠ | |
| fsetpos⚠ | |
| ftell⚠ | |
| ftello⚠ | |
| ftrylockfile⚠ | |
| funlockfile⚠ | |
| fwrite⚠ | |
| fwrite_unlocked⚠ | |
| getc⚠ | |
| getc_unlocked⚠ | |
| getchar⚠ | |
| getchar_unlocked⚠ | |
| getdelim⚠ | |
| getline⚠ | |
| getw⚠ | |
| open_memstream⚠ | |
| pclose⚠ | |
| perror⚠ | |
| popen⚠ | |
| printf⚠ | |
| putc⚠ | |
| putc_unlocked⚠ | |
| putchar⚠ | |
| putchar_unlocked⚠ | |
| puts⚠ | |
| putw⚠ | |
| remove⚠ | |
| rename⚠ | |
| renameat⚠ | |
| rewind⚠ | |
| scanf⚠ | |
| setbuf⚠ | |
| setbuffer⚠ | |
| setlinebuf⚠ | |
| setvbuf⚠ | |
| snprintf⚠ | |
| sprintf⚠ | |
| sscanf⚠ | |
| tempnam⚠ | |
| tmpfile⚠ | |
| tmpnam⚠ | |
| tmpnam_r⚠ | |
| ungetc⚠ | |
| vdprintf⚠ | |
| vfprintf⚠ | |
| vfscanf⚠ | |
| vprintf⚠ | |
| vscanf⚠ | |
| vsnprintf⚠ | |
| vsprintf⚠ | |
| vsscanf⚠ |
Type Definitions
| FILE | |
| MQTTAsync |
A handle representing an MQTT client. A valid client handle is available following a successful call to MQTTAsync_create(). |
| MQTTAsync_connected |
This is a callback function, which will be called when the client library successfully connects. This is superfluous when the connection is made in response to a MQTTAsync_connect call, because the onSuccess callback can be used. It is intended for use when automatic reconnect is enabled, so that when a reconnection attempt succeeds in the background, the application is notified and can take any required actions. @param context A pointer to the context value originally passed to MQTTAsync_setCallbacks(), which contains any application-specific context. @param cause The reason for the disconnection. Currently, cause is always set to NULL. |
| MQTTAsync_connectionLost |
This is a callback function. The client application must provide an implementation of this function to enable asynchronous notification of the loss of connection to the server. The function is registered with the client library by passing it as an argument to MQTTAsync_setCallbacks(). It is called by the client library if the client loses its connection to the server. The client application must take appropriate action, such as trying to reconnect or reporting the problem. This function is executed on a separate thread to the one on which the client application is running. @param context A pointer to the context value originally passed to MQTTAsync_setCallbacks(), which contains any application-specific context. @param cause The reason for the disconnection. Currently, cause is always set to NULL. |
| MQTTAsync_deliveryComplete |
This is a callback function. The client application must provide an implementation of this function to enable asynchronous notification of delivery of messages to the server. The function is registered with the client library by passing it as an argument to MQTTAsync_setCallbacks(). It is called by the client library after the client application has published a message to the server. It indicates that the necessary handshaking and acknowledgements for the requested quality of service (see MQTTAsync_message.qos) have been completed. This function is executed on a separate thread to the one on which the client application is running. @param context A pointer to the context value originally passed to MQTTAsync_setCallbacks(), which contains any application-specific context. @param token The ::MQTTAsync_token associated with the published message. Applications can check that all messages have been correctly published by matching the tokens returned from calls to MQTTAsync_send() and MQTTAsync_sendMessage() with the tokens passed to this callback. |
| MQTTAsync_messageArrived |
This is a callback function. The client application must provide an implementation of this function to enable asynchronous receipt of messages. The function is registered with the client library by passing it as an argument to MQTTAsync_setCallbacks(). It is called by the client library when a new message that matches a client subscription has been received from the server. This function is executed on a separate thread to the one on which the client application is running. @param context A pointer to the context value originally passed to MQTTAsync_setCallbacks(), which contains any application-specific context. @param topicName The topic associated with the received message. @param topicLen The length of the topic if there are one more NULL characters embedded in topicName, otherwise topicLen is 0. If topicLen is 0, the value returned by strlen(topicName) can be trusted. If topicLen is greater than 0, the full topic name can be retrieved by accessing topicName as a byte array of length topicLen. @param message The MQTTAsync_message structure for the received message. This structure contains the message payload and attributes. @return This function must return a boolean value indicating whether or not the message has been safely received by the client application. Returning true indicates that the message has been successfully handled. Returning false indicates that there was a problem. In this case, the client library will reinvoke MQTTAsync_messageArrived() to attempt to deliver the message to the application again. |
| MQTTAsync_onFailure |
This is a callback function. The client application must provide an implementation of this function to enable asynchronous notification of the unsuccessful completion of an API call. The function is registered with the client library by passing it as an argument in ::MQTTAsync_responseOptions. @param context A pointer to the context value originally passed to ::MQTTAsync_responseOptions, which contains any application-specific context. @param response Any failure data associated with the API completion. |
| MQTTAsync_onSuccess |
This is a callback function. The client application must provide an implementation of this function to enable asynchronous notification of the successful completion of an API call. The function is registered with the client library by passing it as an argument in ::MQTTAsync_responseOptions. @param context A pointer to the context value originally passed to ::MQTTAsync_responseOptions, which contains any application-specific context. @param response Any success data associated with the API completion. |
| MQTTAsync_token |
A value representing an MQTT message. A token is returned to the client application when a message is published. The token can then be used to check that the message was successfully delivered to its destination (see MQTTAsync_publish(), MQTTAsync_publishMessage(), MQTTAsync_deliveryComplete(), and MQTTAsync_getPendingTokens()). |
| MQTTAsync_traceCallback |
This is a callback function prototype which must be implemented if you want to receive trace information. @param level the trace level of the message returned @param meesage the trace message. This is a pointer to a static buffer which will be overwritten on each call. You must copy the data if you want to keep it for later. |
| Persistence_clear |
@brief Clears the persistence store, so that it no longer contains any persisted data. |
| Persistence_close |
@brief Close the persistent store referred to by the handle. |
| Persistence_containskey |
@brief Returns whether any data has been persisted using the specified key. |
| Persistence_get |
@brief Retrieve the specified data from the persistent store. |
| Persistence_keys |
@brief Returns the keys in this persistent data store. |
| Persistence_open |
@brief Initialize the persistent store. |
| Persistence_put |
@brief Put the specified data into the persistent store. |
| Persistence_remove |
@brief Remove the data for the specified key from the store. |
| _IO_lock_t | |
| __FILE | |
| __blkcnt64_t | |
| __blkcnt_t | |
| __blksize_t | |
| __builtin_va_list | |
| __caddr_t | |
| __clock_t | |
| __clockid_t | |
| __daddr_t | |
| __dev_t | |
| __fsblkcnt64_t | |
| __fsblkcnt_t | |
| __fsfilcnt64_t | |
| __fsfilcnt_t | |
| __fsword_t | |
| __gid_t | |
| __gnuc_va_list | |
| __id_t | |
| __ino64_t | |
| __ino_t | |
| __int16_t | |
| __int32_t | |
| __int64_t | |
| __int8_t | |
| __intptr_t | |
| __io_close_fn | |
| __io_read_fn | |
| __io_seek_fn | |
| __io_write_fn | |
| __key_t | |
| __loff_t | |
| __mode_t | |
| __nlink_t | |
| __off64_t | |
| __off_t | |
| __pid_t | |
| __qaddr_t | |
| __quad_t | |
| __rlim64_t | |
| __rlim_t | |
| __socklen_t | |
| __ssize_t | |
| __suseconds_t | |
| __syscall_slong_t | |
| __syscall_ulong_t | |
| __time_t | |
| __timer_t | |
| __u_char | |
| __u_int | |
| __u_long | |
| __u_quad_t | |
| __u_short | |
| __uid_t | |
| __uint16_t | |
| __uint32_t | |
| __uint64_t | |
| __uint8_t | |
| __useconds_t | |
| fpos_t | |
| off_t | |
| va_list |
Unions
| MQTTAsync_successData__bindgen_ty_1 |
A union of the different values that can be returned for subscribe, unsubscribe and publish. |
| __mbstate_t__bindgen_ty_1 |