common.h

Go to the documentation of this file.

//
// Copyright 2016 - 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_MQTTSN_CLIENT_MAJOR_VERSION 2U
 
#define CC_MQTTSN_CLIENT_MINOR_VERSION 0U
 
#define CC_MQTTSN_CLIENT_PATCH_VERSION 12U
 
#define CC_MQTTSN_CLIENT_MAKE_VERSION(major_, minor_, patch_) \
    ((static_cast<unsigned>(major_) << 24) | \
     (static_cast<unsigned>(minor_) << 8) | \
     (static_cast<unsigned>(patch_)))
 
#define CC_MQTTSN_CLIENT_VERSION CC_MQTTSN_CLIENT_MAKE_VERSION(CC_MQTTSN_CLIENT_MAJOR_VERSION, CC_MQTTSN_CLIENT_MINOR_VERSION, CC_MQTTSN_CLIENT_PATCH_VERSION)
 
typedef enum
{
    CC_MqttsnQoS_AtMostOnceDelivery = 0, 
    CC_MqttsnQoS_AtLeastOnceDelivery = 1, 
    CC_MqttsnQoS_ExactlyOnceDelivery = 2, 
    CC_MqttsnQoS_ValuesLimit 
} CC_MqttsnQoS;
 
typedef enum
{
    CC_MqttsnErrorCode_Success = 0, 
    CC_MqttsnErrorCode_InternalError = 1, 
    CC_MqttsnErrorCode_NotIntitialized = 2, 
    CC_MqttsnErrorCode_Busy = 3, 
    CC_MqttsnErrorCode_NotConnected = 4, 
    CC_MqttsnErrorCode_BadParam = 5, 
    CC_MqttsnErrorCode_InsufficientConfig = 6, 
    CC_MqttsnErrorCode_OutOfMemory = 7, 
    CC_MqttsnErrorCode_BufferOverflow = 8, 
    CC_MqttsnErrorCode_NotSupported = 9, 
    CC_MqttsnErrorCode_RetryLater = 10, 
    CC_MqttsnErrorCode_Disconnecting = 11, 
    CC_MqttsnErrorCode_NotSleeping = 12, 
    CC_MqttsnErrorCode_PreparationLocked = 13, 
    CC_MqttsnErrorCode_ValuesLimit 
} CC_MqttsnErrorCode;
 
typedef enum
{
    CC_MqttsnGwStatus_AddedByGateway = 0, 
    CC_MqttsnGwStatus_AddedByClient = 1, 
    CC_MqttsnGwStatus_UpdatedByClient = 2, 
    CC_MqttsnGwStatus_Alive = 3, 
    CC_MqttsnGwStatus_Tentative = 4, 
    CC_MqttsnGwStatus_Removed = 5, 
    CC_MqttsnGwStatus_ValuesLimit 
} CC_MqttsnGwStatus;
 
typedef enum
{
    CC_MqttsnAsyncOpStatus_Complete = 0, 
    CC_MqttsnAsyncOpStatus_InternalError = 1, 
    CC_MqttsnAsyncOpStatus_Timeout = 2, 
    CC_MqttsnAsyncOpStatus_Aborted = 3, 
    CC_MqttsnAsyncOpStatus_OutOfMemory = 4, 
    CC_MqttsnAsyncOpStatus_BadParam = 5, 
    CC_MqttsnAsyncOpStatus_GatewayDisconnected = 6, 
    CC_MqttsnAsyncOpStatus_ValuesLimit 
} CC_MqttsnAsyncOpStatus;
 
typedef enum
{
    CC_MqttsnGatewayDisconnectReason_DisconnectMsg = 0, 
    CC_MqttsnGatewayDisconnectReason_NoGatewayResponse = 1, 
    CC_MqttsnGatewayDisconnectReason_ValuesLimit 
} CC_MqttsnGatewayDisconnectReason;
 
typedef enum
{
    CC_MqttsnReturnCode_Accepted = 0, 
    CC_MqttsnReturnCode_Conjestion = 1, 
    CC_MqttsnReturnCode_InvalidTopicId = 2, 
    CC_MqttsnReturnCode_NotSupported = 3, 
    CC_MqttsnReturnCode_ValuesLimit, 
    CC_MqttsnReturnCode_MaxTypeValue = 255 
} CC_MqttsnReturnCode;
 
typedef enum
{
    CC_MqttsnConnectionStatus_Disconnected = 0, 
    CC_MqttsnConnectionStatus_Connected = 1, 
    CC_MqttsnConnectionStatus_Asleep = 2, 
    CC_MqttsnConnectionStatus_ValuesLimit 
} CC_MqttsnConnectionStatus;
 
typedef enum
{
    CC_MqttsnDataOrigin_Any = 0, 
    CC_MqttsnDataOrigin_ConnectedGw = 1, 
    CC_MqttsnDataOrigin_ValuesLimit 
} CC_MqttsnDataOrigin;
 
struct CC_MqttsnClient;
 
typedef struct CC_MqttsnClient* CC_MqttsnClientHandle;
 
struct CC_MqttsnSearch;
 
typedef struct CC_MqttsnSearch* CC_MqttsnSearchHandle;
 
struct CC_MqttsnConnect;
 
typedef struct CC_MqttsnConnect* CC_MqttsnConnectHandle;
 
struct CC_MqttsnDisconnect;
 
typedef struct CC_MqttsnDisconnect* CC_MqttsnDisconnectHandle;
 
struct CC_MqttsnSubscribe;
 
typedef struct CC_MqttsnSubscribe* CC_MqttsnSubscribeHandle;
 
struct CC_MqttsnUnsubscribe;
 
typedef struct CC_MqttsnUnsubscribe* CC_MqttsnUnsubscribeHandle;
 
struct CC_MqttsnPublish;
 
typedef struct CC_MqttsnPublish* CC_MqttsnPublishHandle;
 
struct CC_MqttsnWill;
 
typedef struct CC_MqttsnWill* CC_MqttsnWillHandle;
 
struct CC_MqttsnSleep;
 
typedef struct CC_MqttsnSleep* CC_MqttsnSleepHandle;
 
typedef unsigned short CC_MqttsnTopicId;
 
typedef struct
{
    const char* m_topic; 
    const unsigned char* m_data; 
    unsigned m_dataLen; 
    CC_MqttsnTopicId m_topicId; 
    CC_MqttsnQoS m_qos; 
    bool m_retained; 
} CC_MqttsnMessageInfo;
 
typedef struct
{
    unsigned char m_gwId; 
    const unsigned char* m_addr; 
    unsigned m_addrLen; 
} CC_MqttsnGatewayInfo;
 
typedef struct
{
    const char* m_clientId; 
    unsigned m_duration; 
    bool m_cleanSession; 
} CC_MqttsnConnectConfig;
 
typedef struct
{
    CC_MqttsnReturnCode m_returnCode; 
} CC_MqttsnConnectInfo;
 
typedef struct
{
    const char* m_topic; 
    const unsigned char* m_data; 
    unsigned m_dataLen; 
    CC_MqttsnQoS m_qos; 
    bool m_retain; 
} CC_MqttsnWillConfig;
 
typedef struct
{
    const char* m_topic; 
    CC_MqttsnTopicId m_topicId; 
    CC_MqttsnQoS m_qos; 
} CC_MqttsnSubscribeConfig;
 
typedef struct
{
    CC_MqttsnReturnCode m_returnCode; 
    CC_MqttsnQoS m_qos; 
} CC_MqttsnSubscribeInfo;
 
typedef struct
{
    const char* m_topic; 
    CC_MqttsnTopicId m_topicId; 
} CC_MqttsnUnsubscribeConfig;
 
typedef struct
{
    const char* m_topic; 
    const unsigned char* m_data; 
    unsigned m_dataLen; 
    CC_MqttsnTopicId m_topicId; 
    CC_MqttsnQoS m_qos; 
    bool m_retain; 
} CC_MqttsnPublishConfig;
 
typedef struct
{
    CC_MqttsnReturnCode m_returnCode; 
} CC_MqttsnPublishInfo;
 
typedef struct
{
    CC_MqttsnReturnCode m_topicUpdReturnCode; 
    CC_MqttsnReturnCode m_msgUpdReturnCode; 
} CC_MqttsnWillInfo;
 
typedef struct
{
    unsigned m_duration; 
} CC_MqttsnSleepConfig;
 
typedef void (*CC_MqttsnNextTickProgramCb)(void* data, unsigned duration);
 
typedef unsigned (*CC_MqttsnCancelNextTickWaitCb)(void* data);
 
typedef void (*CC_MqttsnSendOutputDataCb)(void* data, const unsigned char* buf, unsigned bufLen, unsigned broadcastRadius);
 
typedef void (*CC_MqttsnGwStatusReportCb)(void* data, CC_MqttsnGwStatus status, const CC_MqttsnGatewayInfo* info);
 
typedef void (*CC_MqttsnGwDisconnectedReportCb)(void* data, CC_MqttsnGatewayDisconnectReason reason);
 
typedef void (*CC_MqttsnMessageReportCb)(void* data, const CC_MqttsnMessageInfo* msgInfo);
 
typedef void (*CC_MqttsnErrorLogCb)(void* data, const char* msg);
 
typedef unsigned (*CC_MqttsnGwinfoDelayRequestCb)(void* data);
 
typedef void (*CC_MqttsnSearchCompleteCb)(void* data, CC_MqttsnAsyncOpStatus status, const CC_MqttsnGatewayInfo* info);
 
typedef void (*CC_MqttsnConnectCompleteCb)(void* data, CC_MqttsnAsyncOpStatus status, const CC_MqttsnConnectInfo* info);
 
typedef void (*CC_MqttsnDisconnectCompleteCb)(void* data, CC_MqttsnAsyncOpStatus status);
 
typedef void (*CC_MqttsnSubscribeCompleteCb)(void* data, CC_MqttsnSubscribeHandle handle, CC_MqttsnAsyncOpStatus status, const CC_MqttsnSubscribeInfo* info);
 
typedef void (*CC_MqttsnUnsubscribeCompleteCb)(void* data, CC_MqttsnUnsubscribeHandle handle, CC_MqttsnAsyncOpStatus status);
 
typedef void (*CC_MqttsnPublishCompleteCb)(void* data, CC_MqttsnPublishHandle handle, CC_MqttsnAsyncOpStatus status, const CC_MqttsnPublishInfo* info);
 
typedef void (*CC_MqttsnWillCompleteCb)(void* data, CC_MqttsnAsyncOpStatus status, const CC_MqttsnWillInfo* info);
 
typedef void (*CC_MqttsnSleepCompleteCb)(void* data, CC_MqttsnAsyncOpStatus status);
 
#ifdef __cplusplus
}
#endif