D:/my_data/GIT/network_apps/netapps/mqtt/server/server_pkts.h

Go to the documentation of this file.

/******************************************************************************
*
*   Copyright (C) 2014 Texas Instruments Incorporated
*
*   All rights reserved. Property of Texas Instruments Incorporated.
*   Restricted rights to use, duplicate or disclose this code are
*   granted through contract.
*
*   The program may not be used without the written permission of
*   Texas Instruments Incorporated or against the terms and conditions
*   stipulated in the agreement under which this program has been supplied,
*   and under no circumstances can it be used with non-TI connectivity device.
*
******************************************************************************/

#ifndef __SERVER_PKTS_H__
#define __SERVER_PKTS_H__

#include "mqtt_common.h"

/*-----------------------------------------------------------------------------
 * Note: Do not create additional dependency of this file on any header other
 * than mqtt_common.h. Specifically, server_pkts.[hc] in conjunction with the
 * mqtt_common.[hc] files must be facilitated to create a stand-alone library.
 *-----------------------------------------------------------------------------
 */

#define MQ_CONN_UTF8_BUF(utf8)      ((utf8)? (utf8)->buffer : NULL)

#define MQ_CONN_UTF8_LEN(utf8)      ((utf8)? (utf8)->length : 0)

#define MQC_UTF8_CLIENTID(utf8_vec) (utf8_vec[0]) 
#define MQC_UTF8_WILL_TOP(utf8_vec) (utf8_vec[1]) 
#define MQC_UTF8_WILL_MSG(utf8_vec) (utf8_vec[2]) 
#define MQC_UTF8_USERNAME(utf8_vec) (utf8_vec[3]) 
#define MQC_UTF8_PASSWORD(utf8_vec) (utf8_vec[4]) 
#define MQC_CLIENTID_BUF(utf8_vec)  MQ_CONN_UTF8_BUF(MQC_UTF8_CLIENTID(utf8_vec))
#define MQC_CLIENTID_LEN(utf8_vec)  MQ_CONN_UTF8_LEN(MQC_UTF8_CLIENTID(utf8_vec))

#define MQC_WILL_TOP_BUF(utf8_vec)  MQ_CONN_UTF8_BUF(MQC_UTF8_WILL_TOP(utf8_vec))
#define MQC_WILL_TOP_LEN(utf8_vec)  MQ_CONN_UTF8_LEN(MQC_UTF8_WILL_TOP(utf8_vec))

#define MQC_WILL_MSG_BUF(utf8_vec)  MQ_CONN_UTF8_BUF(MQC_UTF8_WILL_MSG(utf8_vec))
#define MQC_WILL_MSG_LEN(utf8_vec)  MQ_CONN_UTF8_LEN(MQC_UTF8_WILL_MSG(utf8_vec))

#define MQC_USERNAME_BUF(utf8_vec)  MQ_CONN_UTF8_BUF(MQC_UTF8_USERNAME(utf8_vec))
#define MQC_USERNAME_LEN(utf8_vec)  MQ_CONN_UTF8_LEN(MQC_UTF8_USERNAME(utf8_vec))

#define MQC_PASSWORD_BUF(utf8_vec)  MQ_CONN_UTF8_BUF(MQC_UTF8_PASSWORD(utf8_vec))
#define MQC_PASSWORD_LEN(utf8_vec)  MQ_CONN_UTF8_LEN(MQC_UTF8_PASSWORD(utf8_vec))

#ifndef CFG_SR_MAX_MQP_RX_LEN
#define MQP_SERVER_RX_LEN  1024  
#else
#define MQP_SERVER_RX_LEN  CFG_SR_MAX_MQP_RX_LEN
#endif

i32 mqtt_vh_msg_send(void *ctx_cl, u8 msg_type, enum mqtt_qos qos,
                     bool has_vh, u16 vh_data);

i32 mqtt_vh_msg_send_locked(void *ctx_cl, u8 msg_type, enum mqtt_qos qos,
                            bool has_vh, u16 vh_data);

i32 mqtt_server_pub_dispatch(void *ctx_cl, struct mqtt_packet *mqp, bool dup);

i32 mqtt_server_pub_dispatch_locked(void *ctx_cl, struct mqtt_packet *mqp,
                                    bool dup);

i32 mqtt_server_run(u32 wait_secs);

i32 mqtt_server_register_net_svc(const struct device_net_services *net);


struct mqtt_server_msg_cbs {

        u16  (*connect_rx)(void *ctx_cl, u8 conn_flags,
                           struct utf8_string * const *utf8_vec, void **usr);

        bool (*sub_msg_rx)(void *usr_cl, const struct utf8_strqos *qos_topics,
                          u32 n_topics, u16 msg_id, u8 *acks);

        bool (*un_sub_msg)(void *usr_cl, const struct utf8_string *topics,
                           u32 n_topics, u16 msg_id);

        bool (*pub_msg_rx)(void *usr_cl, const struct utf8_string *topic,
                           const u8 *data_buf, u32 data_len, u16 msg_id,
                           bool dup, enum mqtt_qos qos, bool retain);

        bool (*ack_notify)(void *usr_cl, u8 msg_type, u16 msg_id);

        void (*on_cl_net_close)(void *usr_cl, bool due2err);

        void (*on_connack_send)(void *usr_cl, bool clean_session);
};

struct mqtt_server_lib_cfg {

        u16   listener_port;

        u16   loopback_port;

        void  *mutex;
        void (*mutex_lockin)(void *mutex);
        void (*mutex_unlock)(void *mutex);

        i32  (*debug_printf)(const i8 *format, ...);  
        bool   aux_debug_en;  
};

i32 mqtt_server_lib_init(const struct mqtt_server_lib_cfg *cfg,
                         const struct mqtt_server_msg_cbs *cbs);
 /* End of server_pktlib */

#endif