libemqtt.h

/*
 * This file is part of libemqtt.
 *
 * libemqtt is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * libemqtt is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with libemqtt.  If not, see <http://www.gnu.org/licenses/>.
 */
 
/*
 *
 * Created by Filipe Varela on 09/10/16.
 * Copyright 2009 Caixa Mágica Software. All rights reserved.
 *
 * Fork developed by Vicente Ruiz Rodríguez
 * Copyright 2012 Vicente Ruiz Rodríguez <vruiz2.0@gmail.com>. All rights reserved.
 *
 */
 
#ifndef __LIBEMQTT_H__
#define __LIBEMQTT_H__
 
#if 1
#include <stdint.h>
#else
#include "espressif/c_types.h"
#endif
 
#define MQTT_CONF_USERNAME_LENGTH 40+1
#ifndef MQTT_CONF_USERNAME_LENGTH
#define MQTT_CONF_USERNAME_LENGTH 13 // Recommended by MQTT Specification (12 + '\0')
#endif
 
#define MQTT_CONF_PASSWORD_LENGTH 16+1
#ifndef MQTT_CONF_PASSWORD_LENGTH
#define MQTT_CONF_PASSWORD_LENGTH 13 // Recommended by MQTT Specification (12 + '\0')
#endif
 
 
#define MQTT_MSG_CONNECT       1<<4
#define MQTT_MSG_CONNACK       2<<4
#define MQTT_MSG_PUBLISH       3<<4
#define MQTT_MSG_PUBACK        4<<4
#define MQTT_MSG_PUBREC        5<<4
#define MQTT_MSG_PUBREL        6<<4
#define MQTT_MSG_PUBCOMP       7<<4
#define MQTT_MSG_SUBSCRIBE     8<<4
#define MQTT_MSG_SUBACK        9<<4
#define MQTT_MSG_UNSUBSCRIBE  10<<4
#define MQTT_MSG_UNSUBACK     11<<4
#define MQTT_MSG_PINGREQ      12<<4
#define MQTT_MSG_PINGRESP     13<<4
#define MQTT_MSG_DISCONNECT   14<<4
 
 
#define MQTTParseMessageType(buffer) ( *buffer & 0xF0 )
 
#define MQTTParseMessageDuplicate(buffer) ( *buffer & 0x08 )
 
#define MQTTParseMessageQos(buffer) ( (*buffer & 0x06) >> 1 )
 
#define MQTTParseMessageRetain(buffer) ( *buffer & 0x01 )
 
 
uint8_t mqtt_num_rem_len_bytes(const uint8_t* buf);
 
uint32_t mqtt_parse_rem_len(const uint8_t* buf);
 
uint16_t mqtt_parse_msg_id(const uint8_t* buf);
 
uint16_t mqtt_parse_pub_topic(const uint8_t* buf, uint8_t* topic);
 
uint16_t mqtt_parse_pub_topic_ptr(const uint8_t* buf, const uint8_t** topic_ptr);
 
uint32_t mqtt_parse_publish_msg(const uint8_t* buf, uint8_t* msg);
 
uint32_t mqtt_parse_pub_msg_ptr(const uint8_t* buf, const uint8_t** msg_ptr);
 
 
typedef struct {
    void* socket_info;
    int (*sendBuf)(void* socket_info, const void* buf, unsigned int count);
    // Connection info
    char clientid[50];
    // Auth fields
    char username[MQTT_CONF_USERNAME_LENGTH];
    char password[MQTT_CONF_PASSWORD_LENGTH];
    // Will topic
    uint8_t will_retain;
    uint8_t will_qos;
    uint8_t clean_session;
    // Management fields
    uint16_t seq;
    uint16_t alive;
} mqtt_broker_handle_t;
 
 
void mqtt_init(mqtt_broker_handle_t* broker, const char* clientid);
 
void mqtt_init_auth(mqtt_broker_handle_t* broker, const char* username, const char* password);
 
void mqtt_set_alive(mqtt_broker_handle_t* broker, uint16_t alive);
 
int mqtt_connect(mqtt_broker_handle_t* broker);
 
int mqtt_disconnect(mqtt_broker_handle_t* broker);
 
#if 0
int mqtt_publish(mqtt_broker_handle_t* broker, const char* topic, const char* msg, uint8_t retain);
#endif
 
#if 0
int mqtt_publish_with_qos(mqtt_broker_handle_t* broker, const char* topic, const char* msg, uint8_t retain, uint8_t qos, uint16_t* message_id);
#endif
 
void mqtt_get_qos_msg_id(mqtt_broker_handle_t* broker, uint8_t qos, uint16_t* message_id);
 
int mqtt_pub_msg_with_qos(mqtt_broker_handle_t* broker, const char* topic, const unsigned char* msg, const uint32_t m_len, uint8_t retain, uint8_t qos, uint16_t message_id);
 
int mqtt_puback(mqtt_broker_handle_t* broker, uint16_t message_id);
 
int mqtt_pubrel(mqtt_broker_handle_t* broker, uint16_t message_id);
 
int mqtt_subscribe(mqtt_broker_handle_t* broker, const char* topic, uint16_t* message_id);
 
int mqtt_subscribe_ext(mqtt_broker_handle_t* broker, const char* topics[], uint8_t cnt, uint16_t* message_id);
 
int mqtt_unsubscribe(mqtt_broker_handle_t* broker, const char* topic, uint16_t* message_id);
 
int mqtt_unsubscribe_ext(mqtt_broker_handle_t* broker, const char* topics[], uint8_t cnt, uint16_t* message_id);
 
 
int mqtt_ping(mqtt_broker_handle_t* broker);
 
 
#endif // __LIBEMQTT_H__