net_mqtt.h

Go to the documentation of this file.

/*
 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of oveRTOS.
 */
 
#ifndef OVE_NET_MQTT_H
#define OVE_NET_MQTT_H
 
#include "ove/types.h"
#include "ove/net.h"
#include "ove_config.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef __ZIG_CIMPORT__
typedef uint8_t ove_mqtt_qos_t;
#define OVE_MQTT_QOS0 ((ove_mqtt_qos_t)0) 
#define OVE_MQTT_QOS1 ((ove_mqtt_qos_t)1) 
#else
typedef enum {
    OVE_MQTT_QOS0 = 0, 
    OVE_MQTT_QOS1 = 1, 
} ove_mqtt_qos_t;
#endif
 
typedef void (*ove_mqtt_msg_cb)(const char *topic, size_t topic_len, const void *payload,
                size_t payload_len, void *user_data);
 
typedef struct {
    const char *host;      
    uint16_t port;         
    const char *client_id; 
    const char *username;  
    const char *password;  
    uint16_t keep_alive_s; 
    int use_tls;           
    const unsigned char
        *tls_ca_cert;   
    size_t tls_ca_cert_len; 
    int tls_allow_insecure; 
    ove_mqtt_msg_cb on_message; 
    void *user_data;        
} ove_mqtt_config_t;
 
#include "ove/storage.h"
 
#ifdef CONFIG_OVE_NET_MQTT
 
int ove_mqtt_client_init(ove_mqtt_client_t *client, ove_mqtt_client_storage_t *storage);
 
void ove_mqtt_client_deinit(ove_mqtt_client_t client);
 
int ove_mqtt_connect(ove_mqtt_client_t client, const ove_mqtt_config_t *cfg);
 
void ove_mqtt_disconnect(ove_mqtt_client_t client);
 
int ove_mqtt_publish(ove_mqtt_client_t client, const char *topic, const void *payload,
             size_t payload_len, ove_mqtt_qos_t qos);
 
int ove_mqtt_subscribe(ove_mqtt_client_t client, const char *topic, ove_mqtt_qos_t qos);
 
int ove_mqtt_unsubscribe(ove_mqtt_client_t client, const char *topic);
 
int ove_mqtt_loop(ove_mqtt_client_t client, uint64_t timeout_ns);
 
#ifdef OVE_HEAP_NET_MQTT
int ove_mqtt_client_create(ove_mqtt_client_t *client);
 
void ove_mqtt_client_destroy(ove_mqtt_client_t client);
#endif /* OVE_HEAP_NET_MQTT */
 
#else /* !CONFIG_OVE_NET_MQTT */
 
#ifndef CONFIG_OVE_NET_MQTT
typedef struct {
    uint8_t _unused;
} ove_mqtt_client_storage_t;
#endif
 
static inline int ove_mqtt_client_init(ove_mqtt_client_t *client,
                       ove_mqtt_client_storage_t *storage)
{
    (void)client;
    (void)storage;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_mqtt_client_deinit(ove_mqtt_client_t client)
{
    (void)client;
}
static inline int ove_mqtt_connect(ove_mqtt_client_t client, const ove_mqtt_config_t *cfg)
{
    (void)client;
    (void)cfg;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_mqtt_disconnect(ove_mqtt_client_t client)
{
    (void)client;
}
static inline int ove_mqtt_publish(ove_mqtt_client_t client, const char *topic, const void *payload,
                   size_t payload_len, ove_mqtt_qos_t qos)
{
    (void)client;
    (void)topic;
    (void)payload;
    (void)payload_len;
    (void)qos;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_mqtt_subscribe(ove_mqtt_client_t client, const char *topic,
                     ove_mqtt_qos_t qos)
{
    (void)client;
    (void)topic;
    (void)qos;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_mqtt_unsubscribe(ove_mqtt_client_t client, const char *topic)
{
    (void)client;
    (void)topic;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_mqtt_loop(ove_mqtt_client_t client, uint64_t timeout_ns)
{
    (void)client;
    (void)timeout_ns;
    return OVE_ERR_NOT_SUPPORTED;
}
#endif /* CONFIG_OVE_NET_MQTT */
 
#ifdef __cplusplus
}
#endif
 
#endif /* OVE_NET_MQTT_H */