mqttserver.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER OR
 * CONTRIBUTORS 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.
 */

#ifndef ti_net_mqtt_MQTTServer__include
#define ti_net_mqtt_MQTTServer__include


//*****************************************************************************
// includes
//*****************************************************************************
#include <string.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

//*****************************************************************************
// typedefs
//*****************************************************************************
typedef enum
{
    MQTTServer_USER_NAME = 0,
    MQTTServer_PASSWORD  = 1,
} MQTTServer_Option;

typedef void (*MQTTServer_CallBack)(int32_t event, void *metaData, uint32_t metaDateLen, void *data, uint32_t dataLen);
typedef void *MQTTServer_Handle;

typedef struct _MQTTServer_SubscribeParams_
{
    char *topic;
    MQTTServer_CallBack callback; 
    uint8_t persistent;
} MQTTServer_SubscribeParams;

typedef struct _MQTTServer_UnSubscribeParams_
{
    char *topic;
    uint8_t persistent;
} MQTTServer_UnSubscribeParams;


typedef enum
{
    MQTTServer_RECV_CB_EVENT       = 0,
    MQTTServer_CONNECT_CB_EVENT    = 1,
    MQTTServer_DISCONNECT_CB_EVENT = 2
} MQTTServer_EventCB;

/* Structure that holds parameters on the server for */
/* Authentication of Clients by the Server           */
typedef struct _MQTTServer_LocalAuthenticationData_
{
    char *userName;
    char *password;
} MQTTServer_LocalAuthenticationData;

typedef struct _MQTTServer_ConnectMetaDataCB_
{
    char *clientId;
    int32_t clientIdLen;
    char *userName;
    int32_t usernameLen;
    char *password;
    int32_t passwordLen;
    void **usr;
} MQTTServer_ConnectMetaDataCB;

typedef struct _MQTTServer_RecvMetaDataCB_
{
    const char *topic;
    int32_t topLen;
    bool dup;
    uint8_t qos;
    bool retain;
} MQTTServer_RecvMetaDataCB;

typedef struct _MQTTServer_DisconnectMetaDataCB_
{
    char *user;
    bool dueToErr;
} MQTTServer_DisconnectMetaDataCB;

typedef struct _MQTTServer_ConnParams_
{
    uint16_t port;             
    uint8_t method;            
    uint32_t cipher;           
    uint32_t nFiles;           
    char * const *secureFiles; 
} MQTTServer_ConnParams;

typedef struct
{
    MQTTServer_ConnParams *connParams; // pointer to connection param
} MQTTServer_Params;


//*****************************************************************************
// function prototypes
//*****************************************************************************

int16_t MQTTServer_delete(MQTTServer_Handle handle);

MQTTServer_Handle MQTTServer_create(MQTTServer_CallBack defaultCallback,
        MQTTServer_Params *attrib);

int16_t MQTTServer_run(MQTTServer_Handle handle);

int16_t MQTTServer_subscribe(MQTTServer_Handle handle, MQTTServer_SubscribeParams *value, uint8_t numberOfTopics);

int16_t MQTTServer_unsubscribe(MQTTServer_Handle handle, MQTTServer_UnSubscribeParams *value, uint8_t numberOfTopics);

int16_t MQTTServer_publish(MQTTServer_Handle handle, char *topic, uint16_t topicLen, char *msg, uint16_t msgLen, uint32_t flags);

int16_t MQTTServer_set(MQTTServer_Handle handle, uint16_t option, void *value, uint16_t valueLength);

#ifdef __cplusplus
}
#endif

#endif