emcute.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2017 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once
 
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
 
#include "net/sock/udp.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef CONFIG_EMCUTE_DEFAULT_PORT
#define CONFIG_EMCUTE_DEFAULT_PORT          (1883U)
#endif
 
#ifndef CONFIG_EMCUTE_BUFSIZE
#define CONFIG_EMCUTE_BUFSIZE               (512U)
#endif
 
#ifndef CONFIG_EMCUTE_TOPIC_MAXLEN
#define CONFIG_EMCUTE_TOPIC_MAXLEN          (196U)
#endif
 
#ifndef CONFIG_EMCUTE_KEEPALIVE
#define CONFIG_EMCUTE_KEEPALIVE             (360)       /* -> 6 min*/
#endif
 
#ifndef CONFIG_EMCUTE_T_RETRY
#define CONFIG_EMCUTE_T_RETRY               (15U)       /* -> 15 sec */
#endif
 
#ifndef CONFIG_EMCUTE_N_RETRY
#define CONFIG_EMCUTE_N_RETRY               (3U)
#endif
enum {
    EMCUTE_DUP        = 0x80,   
    EMCUTE_QOS_MASK   = 0x60,   
    EMCUTE_QOS_2      = 0x40,   
    EMCUTE_QOS_1      = 0x20,   
    EMCUTE_QOS_0      = 0x00,   
    EMCUTE_RETAIN     = 0x10,   
    EMCUTE_WILL       = 0x08,   
    EMCUTE_CS         = 0x04,   
    EMCUTE_TIT_MASK   = 0x03,   
    EMCUTE_TIT_SHORT  = 0x02,   
    EMCUTE_TIT_PREDEF = 0x01,   
    EMCUTE_TIT_NORMAL = 0x00    
};
 
enum {
    EMCUTE_OK       =  0,       
    EMCUTE_NOGW     = -1,       
    EMCUTE_REJECT   = -2,       
    EMCUTE_OVERFLOW = -3,       
    EMCUTE_TIMEOUT  = -4,       
    EMCUTE_NOTSUP   = -5        
};
 
typedef struct {
    const char *name;           
    uint16_t id;                
} emcute_topic_t;
 
typedef void(*emcute_cb_t)(const emcute_topic_t *topic, void *data, size_t len);
 
typedef struct emcute_sub {
    struct emcute_sub *next;    
    emcute_topic_t topic;       
    emcute_cb_t cb;             
    void *arg;                  
} emcute_sub_t;
 
int emcute_con(sock_udp_ep_t *remote, bool clean, const char *will_topic,
               const void *will_msg, size_t will_msg_len, unsigned flags);
 
int emcute_discon(void);
 
int emcute_reg(emcute_topic_t *topic);
 
int emcute_pub(emcute_topic_t *topic, const void *buf, size_t len,
               unsigned flags);
 
int emcute_sub(emcute_sub_t *sub, unsigned flags);
 
int emcute_unsub(emcute_sub_t *sub);
 
int emcute_willupd_topic(const char *topic, unsigned flags);
 
int emcute_willupd_msg(const void *data, size_t len);
 
void emcute_run(uint16_t port, const char *id);
 
const char *emcute_type_str(uint8_t type);
 
#ifdef __cplusplus
}
#endif