common.h

Go to the documentation of this file.

//
// Copyright 2024 - 2026 (C). Alex Robenko. All rights reserved.
//
// SPDX-License-Identifier: MPL-2.0
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#else // #ifdef __cplusplus
#include <stdbool.h>
#endif // #ifdef __cplusplus
 
#define CC_MQTT311_CLIENT_MAJOR_VERSION 1U
 
#define CC_MQTT311_CLIENT_MINOR_VERSION 0U
 
#define CC_MQTT311_CLIENT_PATCH_VERSION 8U
 
#define CC_MQTT311_CLIENT_MAKE_VERSION(major_, minor_, patch_) \
    ((static_cast<unsigned>(major_) << 24) | \
     (static_cast<unsigned>(minor_) << 8) | \
     (static_cast<unsigned>(patch_)))
 
#define CC_MQTT311_CLIENT_VERSION CC_MQTT311_CLIENT_MAKE_VERSION(CC_MQTT311_CLIENT_MAJOR_VERSION, CC_MQTT311_CLIENT_MINOR_VERSION, CC_MQTT311_CLIENT_PATCH_VERSION)
 
typedef enum
{
    CC_Mqtt311QoS_AtMostOnceDelivery = 0, 
    CC_Mqtt311QoS_AtLeastOnceDelivery = 1, 
    CC_Mqtt311QoS_ExactlyOnceDelivery = 2, 
    CC_Mqtt311QoS_ValuesLimit 
} CC_Mqtt311QoS;
 
typedef enum
{
    CC_Mqtt311ErrorCode_Success = 0, 
    CC_Mqtt311ErrorCode_InternalError = 1, 
    CC_Mqtt311ErrorCode_NotIntitialized = 2, 
    CC_Mqtt311ErrorCode_Busy = 3, 
    CC_Mqtt311ErrorCode_NotConnected = 4, 
    CC_Mqtt311ErrorCode_AlreadyConnected = 5, 
    CC_Mqtt311ErrorCode_BadParam = 6, 
    CC_Mqtt311ErrorCode_InsufficientConfig = 7, 
    CC_Mqtt311ErrorCode_OutOfMemory = 8, 
    CC_Mqtt311ErrorCode_BufferOverflow = 9, 
    CC_Mqtt311ErrorCode_NotSupported = 10, 
    CC_Mqtt311ErrorCode_RetryLater = 11, 
    CC_Mqtt311ErrorCode_Disconnecting = 12, 
    CC_Mqtt311ErrorCode_NetworkDisconnected = 13, 
    CC_Mqtt311ErrorCode_PreparationLocked = 14, 
    CC_Mqtt311ErrorCode_ValuesLimit 
} CC_Mqtt311ErrorCode;
 
typedef enum
{
    CC_Mqtt311AsyncOpStatus_Complete = 0, 
    CC_Mqtt311AsyncOpStatus_InternalError = 1, 
    CC_Mqtt311AsyncOpStatus_Timeout = 2, 
    CC_Mqtt311AsyncOpStatus_ProtocolError = 3, 
    CC_Mqtt311AsyncOpStatus_Aborted = 4, 
    CC_Mqtt311AsyncOpStatus_BrokerDisconnected = 5, 
    CC_Mqtt311AsyncOpStatus_OutOfMemory = 6, 
    CC_Mqtt311AsyncOpStatus_BadParam = 7, 
    CC_Mqtt311AsyncOpStatus_ValuesLimit 
} CC_Mqtt311AsyncOpStatus;
 
typedef enum
{
    CC_Mqtt311PublishOrdering_SameQos, 
    CC_Mqtt311PublishOrdering_Full, 
    CC_Mqtt311PublishOrdering_ValuesLimit 
} CC_Mqtt311PublishOrdering;
 
typedef enum
{
    CC_Mqtt311BrokerDisconnectReason_NoBrokerResponse = 0, 
    CC_Mqtt311BrokerDisconnectReason_InternalError = 1, 
    CC_Mqtt311BrokerDisconnectReason_ProtocolError = 2, 
    CC_Mqtt311BrokerDisconnectReason_ValuesLimit 
} CC_Mqtt311BrokerDisconnectReason;
 
typedef enum
{
    CC_Mqtt311ConnectReturnCode_Accepted = 0, 
    CC_Mqtt311ConnectReturnCode_InvalidProtocolVersion = 1, 
    CC_Mqtt311ConnectReturnCode_IdRejected = 2, 
    CC_Mqtt311ConnectReturnCode_ServerUnavailable = 3, 
    CC_Mqtt311ConnectReturnCode_BadAuth = 4, 
    CC_Mqtt311ConnectReturnCode_NotAuthorized = 5, 
    CC_Mqtt311ConnectReturnCode_ValuesLimit 
} CC_Mqtt311ConnectReturnCode;
 
typedef enum
{
    CC_Mqtt311SubscribeReturnCode_SuccessQos0 = 0x00, 
    CC_Mqtt311SubscribeReturnCode_SuccessQos1 = 0x01, 
    CC_Mqtt311SubscribeReturnCode_SuccessQos2 = 0x02, 
    CC_Mqtt311SubscribeReturnCode_Failure = 0x80, 
} CC_Mqtt311SubscribeReturnCode;
 
struct CC_Mqtt311Client;
 
typedef struct CC_Mqtt311Client* CC_Mqtt311ClientHandle;
 
struct CC_Mqtt311Connect;
 
typedef struct CC_Mqtt311Connect* CC_Mqtt311ConnectHandle;
 
struct CC_Mqtt311Disconnect;
 
typedef struct CC_Mqtt311Disconnect* CC_Mqtt311DisconnectHandle;
 
struct CC_Mqtt311Subscribe;
 
typedef struct CC_Mqtt311Subscribe* CC_Mqtt311SubscribeHandle;
 
struct CC_Mqtt311Unsubscribe;
 
typedef struct CC_Mqtt311Unsubscribe* CC_Mqtt311UnsubscribeHandle;
 
struct CC_Mqtt311Publish;
 
typedef struct CC_Mqtt311Publish* CC_Mqtt311PublishHandle;
 
typedef struct
{
    const char* m_clientId; 
    const char* m_username; 
    const unsigned char* m_password; 
    unsigned m_passwordLen; 
    unsigned m_keepAlive; 
    bool m_cleanSession; 
} CC_Mqtt311ConnectConfig;
 
typedef struct
{
    const char* m_topic; 
    const unsigned char* m_data; 
    unsigned m_dataLen; 
    CC_Mqtt311QoS m_qos; 
    bool m_retain; 
} CC_Mqtt311ConnectWillConfig;
 
typedef struct
{
    CC_Mqtt311ConnectReturnCode m_returnCode; 
    bool m_sessionPresent; 
} CC_Mqtt311ConnectResponse;
 
typedef struct
{
    const char* m_topic; 
    CC_Mqtt311QoS m_maxQos; 
} CC_Mqtt311SubscribeTopicConfig;
 
typedef struct
{
    const CC_Mqtt311SubscribeReturnCode* m_returnCodes; 
    unsigned m_returnCodesCount; 
} CC_Mqtt311SubscribeResponse;
 
typedef struct
{
    const char* m_topic; 
} CC_Mqtt311UnsubscribeTopicConfig;
 
typedef struct
{
    const char* m_topic; 
    const unsigned char* m_data; 
    unsigned m_dataLen; 
    CC_Mqtt311QoS m_qos; 
    bool m_retained; 
} CC_Mqtt311MessageInfo;
 
typedef struct
{
    const char* m_topic; 
    const unsigned char* m_data; 
    unsigned m_dataLen; 
    CC_Mqtt311QoS m_qos; 
    bool m_retain; 
} CC_Mqtt311PublishConfig;
 
typedef void (*CC_Mqtt311NextTickProgramCb)(void* data, unsigned duration);
 
typedef unsigned (*CC_Mqtt311CancelNextTickWaitCb)(void* data);
 
typedef void (*CC_Mqtt311SendOutputDataCb)(void* data, const unsigned char* buf, unsigned bufLen);
 
typedef void (*CC_Mqtt311BrokerDisconnectReportCb)(void* data, CC_Mqtt311BrokerDisconnectReason reason);
 
typedef void (*CC_Mqtt311MessageReceivedReportCb)(void* data, const CC_Mqtt311MessageInfo* info);
 
typedef void (*CC_Mqtt311ErrorLogCb)(void* data, const char* msg);
 
typedef void (*CC_Mqtt311ConnectCompleteCb)(void* data, CC_Mqtt311AsyncOpStatus status, const CC_Mqtt311ConnectResponse* response);
 
typedef void (*CC_Mqtt311SubscribeCompleteCb)(void* data, CC_Mqtt311SubscribeHandle handle, CC_Mqtt311AsyncOpStatus status, const CC_Mqtt311SubscribeResponse* response);
 
typedef void (*CC_Mqtt311UnsubscribeCompleteCb)(void* data, CC_Mqtt311UnsubscribeHandle handle, CC_Mqtt311AsyncOpStatus status);
 
typedef void (*CC_Mqtt311PublishCompleteCb)(void* data, CC_Mqtt311PublishHandle handle, CC_Mqtt311AsyncOpStatus status);
 
#ifdef __cplusplus
}
#endif