uic_mqtt.h

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
 ******************************************************************************
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 *****************************************************************************/
 
#ifndef UIC_MQTT_H
#define UIC_MQTT_H
 
#define MQTT_TOPIC_MAX_LENGTH   512
#define MQTT_MESSAGE_MAX_LENGTH 512
 
#include <stdbool.h>
#include <stddef.h>
#include "sl_status.h"
 
// Helper defines for applications to "unretain_by_regex"
// clang-format off
#define REGEX_NOT_STATE_OR_MQTT_CLIENT_TOPICS   "^(?!((ucl\\/by-unid\\/.*\\/State$)|(ucl\\/by-mqtt-client\\/.*))).*"
#define REGEX_NOT_STATE_TOPIC                   "^(?!ucl\\/by-unid\\/.*\\/State$).*"
#define REGEX_ALL_TOPICS                        "^.+"
// clang-format on
 
typedef void (*mqtt_message_callback_t)(const char *topic,
                                        const char *message,
                                        const size_t message_length);
 
typedef void (*mqtt_message_callback_ex_t)(const char *topic,
                                           const char *message,
                                           const size_t message_length,
                                           void *user);
 
typedef void (*mqtt_connection_callbacks_t)();
 
#ifdef __cplusplus
extern "C" {
#endif
 
sl_status_t uic_mqtt_setup();
 
int uic_mqtt_teardown();
 
void uic_mqtt_publish(const char *topic,
                      const char *message,
                      const size_t message_length,
                      bool retain);
 
void uic_mqtt_unretain(const char *prefix_pattern);
 
int uic_mqtt_count_topics(const char *prefix_pattern);
 
void uic_mqtt_unretain_by_regex(const char *regex);
 
void uic_mqtt_subscribe(const char *topic, mqtt_message_callback_t callback);
 
void uic_mqtt_subscribe_ex(const char *topic,
                           mqtt_message_callback_ex_t callback,
                           void *user);
 
void uic_mqtt_unsubscribe(const char *topic, mqtt_message_callback_t callback);
 
void uic_mqtt_unsubscribe_ex(const char *topic,
                             mqtt_message_callback_ex_t callback,
                             void *user);
 
void uic_mqtt_set_before_disconnect_callback(
  mqtt_connection_callbacks_t callback);
 
void uic_mqtt_set_after_connect_callback(mqtt_connection_callbacks_t callback);
 
const char *uic_mqtt_get_client_id();
 
bool uic_mqtt_is_connected_to_broker();
 
#ifdef __cplusplus
}
#endif
 
#endif  // UIC_MQTT