sol-mqtt.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * Licensed 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.
 */

#pragma once

#include <sol-buffer.h>
#include <sol-certificate.h>
#include <sol-common-buildopts.h>
#include <stdbool.h>
#include <stdlib.h>
#include <inttypes.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    SOL_MQTT_QOS_AT_MOST_ONCE = 0,

    SOL_MQTT_QOS_AT_LEAST_ONCE = 1,

    SOL_MQTT_QOS_EXACTLY_ONCE = 2,
} sol_mqtt_qos;

enum sol_mqtt_conn_status {
    SOL_MQTT_DISCONNECTED = -1,

    SOL_MQTT_CONNECTED = 0,

    SOL_MQTT_WRONG_PROTOCOL = 1,

    SOL_MQTT_ID_REJECTED = 2,

    SOL_MQTT_UNAVAILABLE = 3,
};

struct sol_mqtt;
typedef struct sol_mqtt sol_mqtt;

typedef struct sol_mqtt_message {
#ifndef SOL_NO_API_VERSION
#define SOL_MQTT_MESSAGE_API_VERSION (1)

    uint16_t api_version;
#endif

    char *topic;

    struct sol_buffer *payload;

    int id;

    sol_mqtt_qos qos;

    bool retain;
} sol_mqtt_message;

typedef struct sol_mqtt_handlers {
#ifndef SOL_NO_API_VERSION
#define SOL_MQTT_HANDLERS_API_VERSION (1)

    uint16_t api_version;
#endif

    void (*connect)(void *data, struct sol_mqtt *mqtt);

    void (*disconnect) (void *data, struct sol_mqtt *mqtt);

    void (*publish) (void *data, struct sol_mqtt *mqtt);

    void (*message) (void *data, struct sol_mqtt *mqtt, const struct sol_mqtt_message *message);

    void (*subscribe) (void *data, struct sol_mqtt *mqtt);

    void (*unsubscribe) (void *data, struct sol_mqtt *mqtt);
} sol_mqtt_handlers;

typedef struct sol_mqtt_config {
#ifndef SOL_NO_API_VERSION
#define SOL_MQTT_CONFIG_API_VERSION (1)

    uint16_t api_version;
#endif

    bool clean_session;

    uint16_t port;

    time_t keep_alive;

    const char *client_id;

    const char *username;

    const char *password;

    const struct sol_mqtt_message *will;

    const struct sol_cert *ca_cert;

    const struct sol_cert *client_cert;

    const struct sol_cert *private_key;

    const void *data;

    const char *host;

    const struct sol_mqtt_handlers handlers;
} sol_mqtt_config;

struct sol_mqtt *sol_mqtt_connect(const struct sol_mqtt_config *config);

int sol_mqtt_reconnect(struct sol_mqtt *mqtt);

void sol_mqtt_disconnect(struct sol_mqtt *mqtt);

int sol_mqtt_get_connection_status(const struct sol_mqtt *mqtt);

int sol_mqtt_publish(const struct sol_mqtt *mqtt, struct sol_mqtt_message *message);

int sol_mqtt_subscribe(const struct sol_mqtt *mqtt, const char *topic, sol_mqtt_qos qos);

#ifndef SOL_NO_API_VERSION

#define SOL_MQTT_MESSAGE_CHECK_API_VERSION(msg_, ...) \
    if (SOL_UNLIKELY((msg_)->api_version != \
        SOL_MQTT_MESSAGE_API_VERSION)) { \
        SOL_ERR("Unexpected API version (message is %" PRIu16 ", expected %" PRIu16 ")", \
            (msg_)->api_version, SOL_MQTT_MESSAGE_API_VERSION); \
        return __VA_ARGS__; \
    }
#else
#define SOL_MQTT_MESSAGE_CHECK_API_VERSION(msg_, ...)
#endif

#ifdef __cplusplus
}
#endif