D:/Project/SimpleLink/mqtt/doxygen/client/sl_mqtt_client.h

Go to the documentation of this file.

/*******************************************************************************
Copyright (c) (2014) Texas Instruments Incorporated
All rights reserved not granted herein.

Limited License.  

Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive 
license under copyrights and patents it now or hereafter owns or controls to make, 
have made, use, import, offer to sell and sell ("Utilize") this software subject 
to the terms herein.  With respect to the foregoing patent license, such license 
is granted  solely to the extent that any such patent is necessary to Utilize the 
software alone.  The patent license shall not apply to any combinations which 
include this software, other than combinations with devices manufactured by or 
for TI (�TI Devices�).  No hardware patent is licensed hereunder.

Redistributions must preserve existing copyright notices and reproduce this license 
(including the above copyright notice and the disclaimer and (if applicable) source 
code license limitations below) in the documentation and/or other materials provided 
with the distribution

Redistribution and use in binary form, without modification, are permitted provided 
that the following conditions are met:
* No reverse engineering, decompilation, or disassembly of this software is 
  permitted with respect to any software provided in binary form.
* any redistribution and use are licensed by TI for use only with TI Devices.
* Nothing shall obligate TI to provide you with source code for the software 
  licensed and provided to you in object code.

If software source code is provided to you, modification and redistribution of the 
source code are permitted provided that the following conditions are met;
* any redistribution and use of the source code, including any resulting derivative 
  works, are licensed by TI for use only with TI Devices.
* any redistribution and use of any object code compiled from the source code and 
  any resulting derivative works, are licensed by TI for use only with TI Devices.

Neither the name of Texas Instruments Incorporated nor the names of its suppliers 
may be used to endorse or promote products derived from this software without 
specific prior written permission.

DISCLAIMER.

THIS SOFTWARE IS PROVIDED BY TI AND TI�S LICENSORS "AS IS" AND ANY EXPRESS OR IMPLIED 
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL TI AND TI�S 
LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

******************************************************************************/

#include <stdio.h>
#include <string.h>
#include <stdbool.h>
#include "simplelink.h"

#ifndef __SL_MQTT_H__
#define __SL_MQTT_H__

#ifdef __cplusplus
extern "C"
{
#endif

#define SL_MQTT_CL_EVT_PUBACK   0x04  
#define SL_MQTT_CL_EVT_PUBCOMP  0x07  
#define SL_MQTT_CL_EVT_SUBACK   0x09  
#define SL_MQTT_CL_EVT_UNSUBACK 0x0B   /* End Client events */


      /* Define server structure which holds , server address and port number.
      These values are set by the sl_MqttSet API and retrieved by sl_MqttGet API*/

        typedef struct {
                
                void (*sl_ExtLib_MqttRecv)(void *app_hndl, const char *topstr, _i32 toplen,
                                            const void *payload, _i32 pay_len,
                                            bool dup, unsigned char qos,
                                            bool retain);
                
                void (*sl_ExtLib_MqttEvent)(void *app_hndl, _i32 evt, const void *buf, 
                                             _u32 len);

                void (*sl_ExtLib_MqttDisconn)(void *app_hndl);

                
        } SlMqttClientCbs_t;
        
        typedef struct {

                const char        *will_topic;   
                const char        *will_msg;     
                char      will_qos;     
                bool               retain;       
        } SlMqttWill_t;
        
         
        typedef struct {

#define SL_MQTT_NETCONN_IP6  0x04  
#define SL_MQTT_NETCONN_URL  0x08  
#define SL_MQTT_NETCONN_SEC  0x10  
                _u32         netconn_flags; 
                const char          *server_addr;   
                _u16       port_number;   
                char        method;        
                _u32         cipher;        
                _u32         n_files;       
                char * const        *secure_files;  /* SL needs 4 files*/

        } SlMqttServer_t;

    
        typedef struct
        {
                _u16  loopback_port;  
                _u32   rx_tsk_priority;  
                _u32    resp_time;        
                bool  aux_debug_en;               
                _i32 (*dbg_print)(const char *pcFormat, ...); 
        } SlMqttClientLibCfg_t;


        typedef struct
        {
                SlMqttServer_t  server_info;      
                bool            mqtt_mode31;      
                bool            blocking_send;    
        } SlMqttClientCtxCfg_t;

        _i32 sl_ExtLib_MqttClientInit(const SlMqttClientLibCfg_t  *cfg);

        _i32 sl_ExtLib_MqttClientExit();

        void *sl_ExtLib_MqttClientCtxCreate(const SlMqttClientCtxCfg_t *ctx_cfg,
                                              const SlMqttClientCbs_t *msg_cbs,
                                              void *app_hndl);

        _i32 sl_ExtLib_MqttClientCtxDelete(void *cli_ctx);

#define SL_MQTT_PARAM_CLIENT_ID  0x01   
#define SL_MQTT_PARAM_USER_NAME  0x02   
#define SL_MQTT_PARAM_PASS_WORD  0x03   
#define SL_MQTT_PARAM_TOPIC_QOS1 0x04   
#define SL_MQTT_PARAM_WILL_PARAM 0x05   
        _i32 sl_ExtLib_MqttClientSet(void *cli_ctx, _i32 param, const void *value, _u32 len);
        
        /*\brief None defined at the moment
        */
        _i32 sl_ExtLib_MqttClientGet(void *cli_ctx, _i32 param, void *value, _u32 len);
  
  
        _i32 sl_ExtLib_MqttClientConnect(void *cli_ctx, bool clean, _u16 keep_alive_time);
        
        _i32 sl_ExtLib_MqttClientDisconnect(void *cli_ctx);
        

        _i32 sl_ExtLib_MqttClientSub(void *cli_ctx, char* const *topics,
                                    _u8 *qos, _i32 count);

        
        _i32 sl_ExtLib_MqttClientUnsub(void *cli_ctx, char* const *topics, _i32 count);
        
        
        _i32 sl_ExtLib_MqttClientSend(void *cli_ctx, const char *topic,
                                      const void *data, _i32 len, 
                                      char qos, bool retain);
        
        static inline _i32 sl_ExtLib_MqttClientPub(void *cli_ctx, const char *topic,
                                      const void *data, _i32 len,
                                      char qos, bool retain)
        {
                return sl_ExtLib_MqttClientSend(cli_ctx, topic, data, len,
                                          qos, retain);
        }
 /* End Client API */

#ifdef __cplusplus  
}
#endif  



#endif // __SL_MQTT_H__