sopc_mqtt_transport_layer.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
/* This module implements MQTT Transport Protocol */
 
#ifndef SOPC_MQTT
#define SOPC_MQTT
 
#include <stdio.h>
#include <string.h>
 
#include "sopc_atomic.h"
#include "sopc_mem_alloc.h"
#include "sopc_mutexes.h"
#include "sopc_pubsub_conf.h"
#include "sopc_pubsub_constants.h"
#include "sopc_threads.h"
#include "sopc_time_reference.h"
#include "sopc_types.h"
 
/* MQTT connection hard coded configuration */
 
#define MQTT_LIB_QOS (2)                   /* QOS of publish, subscribe set to 2*/
#define MQTT_LIB_MAX_SIZE_TOPIC_NAME (256) /* Maximum length of a topic */
#define MQTT_LIB_MAX_NB_TOPIC_NAME (256)   /* Maximum subscriber topics that can be handle by client */
#define MQTT_LIB_CONNECTION_TIMEOUT (4)    /* Connection lib timeout = 4 s*/
#define MQTT_LIB_KEEPALIVE (4)             /* Connection lost detection set to 4 s*/
 
typedef struct MQTT_CONTEXT_CLIENT MqttContextClient; /* MQTT context client */
 
typedef enum MQTT_CLIENT_STATE
{
    SOPC_MQTT_CLIENT_UNITIALIZED =
        0, 
    SOPC_MQTT_CLIENT_INITIALIZED = 1,     
    SOPC_MQTT_CLIENT_DISCONNECTED = 2,    
    SOPC_MQTT_CLIENT_CONNECTED = 3,       
    SOPC_MQTT_CLIENT_FAILED_CONNECT = 4,  
    SOPC_MQTT_CLIENT_LOST_CONNECTION = 5, 
} MqttClientState;
 
/* Callback called to notify a message reception. */
 
typedef void FctMessageReceived(uint8_t* data, 
                                uint16_t size, 
                                void* pUser);  
SOPC_ReturnStatus SOPC_MQTT_Send_Message(MqttContextClient* contextClient, const char* topic, SOPC_Buffer message);
 
SOPC_ReturnStatus SOPC_MQTT_InitializeAndConnect_Client(MqttContextClient* contextClient,
                                                        const char* uri,
                                                        const char* username,
                                                        const char* password,
                                                        const char** subTopic,
                                                        uint16_t nbSubTopic,
                                                        FctMessageReceived* cbMessageReceived,
                                                        SOPC_PubSub_OnFatalError* cbFatalError,
                                                        void* userContext);
 
SOPC_ReturnStatus SOPC_MQTT_Create_Client(MqttContextClient** contextClient);
 
void SOPC_MQTT_Release_Client(MqttContextClient* contextClient);
 
bool SOPC_MQTT_Client_Is_Connected(MqttContextClient* contextClient);
 
MqttClientState SOPC_MQTT_Client_Get_State(MqttContextClient* contextClient);
 
#endif