common.h

Go to the documentation of this file.

//
// Copyright 2023 - 2024 (C). Alex Robenko. All rights reserved.
//
// 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_MQTT5_CLIENT_MAJOR_VERSION 1U
 
#define CC_MQTT5_CLIENT_MINOR_VERSION 0U
 
#define CC_MQTT5_CLIENT_PATCH_VERSION 1U
 
#define CC_MQTT5_CLIENT_MAKE_VERSION(major_, minor_, patch_) \
    ((static_cast<unsigned>(major_) << 24) | \
     (static_cast<unsigned>(minor_) << 8) | \
     (static_cast<unsigned>(patch_)))
 
#define CC_MQTT5_CLIENT_VERSION CC_MQTT5_CLIENT_MAKE_VERSION(CC_MQTT5_CLIENT_MAJOR_VERSION, CC_MQTT5_CLIENT_MINOR_VERSION, CC_MQTT5_CLIENT_PATCH_VERSION)
 
#define CC_MQTT5_SESSION_NEVER_EXPIRES 0xffffffff
 
#define CC_MQTT5_MAX_TOPIC_ALIASES_LIMIT 0xffff
 
typedef enum
{
    CC_Mqtt5QoS_AtMostOnceDelivery = 0, 
    CC_Mqtt5QoS_AtLeastOnceDelivery = 1, 
    CC_Mqtt5QoS_ExactlyOnceDelivery = 2, 
    CC_Mqtt5QoS_ValuesLimit 
} CC_Mqtt5QoS;
 
typedef enum
{
    CC_Mqtt5ErrorCode_Success = 0, 
    CC_Mqtt5ErrorCode_InternalError = 1, 
    CC_Mqtt5ErrorCode_NotIntitialized = 2, 
    CC_Mqtt5ErrorCode_Busy = 3, 
    CC_Mqtt5ErrorCode_NotConnected = 4, 
    CC_Mqtt5ErrorCode_AlreadyConnected = 5, 
    CC_Mqtt5ErrorCode_BadParam = 6, 
    CC_Mqtt5ErrorCode_InsufficientConfig = 7, 
    CC_Mqtt5ErrorCode_OutOfMemory = 8, 
    CC_Mqtt5ErrorCode_BufferOverflow = 9, 
    CC_Mqtt5ErrorCode_NotSupported = 10, 
    CC_Mqtt5ErrorCode_RetryLater = 11, 
    CC_Mqtt5ErrorCode_Disconnecting = 12, 
    CC_Mqtt5ErrorCode_NetworkDisconnected = 13, 
    CC_Mqtt5ErrorCode_NotAuthenticated = 14, 
    CC_Mqtt5ErrorCode_PreparationLocked = 15, 
    CC_Mqtt5ErrorCode_ValuesLimit 
} CC_Mqtt5ErrorCode;
 
typedef enum
{
    CC_Mqtt5PayloadFormat_Unspecified = 0, 
    CC_Mqtt5PayloadFormat_Utf8 = 1, 
    CC_Mqtt5PayloadFormat_ValuesLimit 
} CC_Mqtt5PayloadFormat;
 
typedef enum
{
    CC_Mqtt5AsyncOpStatus_Complete = 0, 
    CC_Mqtt5AsyncOpStatus_InternalError = 1, 
    CC_Mqtt5AsyncOpStatus_Timeout = 2, 
    CC_Mqtt5AsyncOpStatus_ProtocolError = 3, 
    CC_Mqtt5AsyncOpStatus_Aborted = 4, 
    CC_Mqtt5AsyncOpStatus_BrokerDisconnected = 5, 
    CC_Mqtt5AsyncOpStatus_OutOfMemory = 6, 
    CC_Mqtt5AsyncOpStatus_BadParam = 7, 
    CC_Mqtt5AsyncOpStatus_ValuesLimit 
} CC_Mqtt5AsyncOpStatus;
 
typedef enum
{
    CC_Mqtt5AuthErrorCode_Continue = 0, 
    CC_Mqtt5AuthErrorCode_Disconnect = 1, 
    CC_Mqtt5AuthErrorCode_ValuesLimit = 2 
} CC_Mqtt5AuthErrorCode;
 
typedef enum
{
    CC_Mqtt5ReasonCode_Success = 0, 
    CC_Mqtt5ReasonCode_NormalDisconnection = 0, 
    CC_Mqtt5ReasonCode_GrantedQos0 = 0, 
    CC_Mqtt5ReasonCode_GrantedQos1 = 1, 
    CC_Mqtt5ReasonCode_GrantedQos2 = 2, 
    CC_Mqtt5ReasonCode_DisconnectWithWill = 4, 
    CC_Mqtt5ReasonCode_NoMatchingSubscribers = 16, 
    CC_Mqtt5ReasonCode_NoSubscriptionExisted = 17, 
    CC_Mqtt5ReasonCode_ContinueAuth = 24, 
    CC_Mqtt5ReasonCode_ReAuth = 25, 
    CC_Mqtt5ReasonCode_UnspecifiedError = 128, 
    CC_Mqtt5ReasonCode_MalformedPacket = 129, 
    CC_Mqtt5ReasonCode_ProtocolError = 130, 
    CC_Mqtt5ReasonCode_ImplSpecificError = 131, 
    CC_Mqtt5ReasonCode_UnsupportedVersion = 132, 
    CC_Mqtt5ReasonCode_ClientIdInvalid = 133, 
    CC_Mqtt5ReasonCode_BadUserPassword = 134, 
    CC_Mqtt5ReasonCode_NotAuthorized = 135, 
    CC_Mqtt5ReasonCode_ServerUnavailable = 136, 
    CC_Mqtt5ReasonCode_ServerBusy = 137, 
    CC_Mqtt5ReasonCode_Banned = 138, 
    CC_Mqtt5ReasonCode_ServerShuttingDown = 139, 
    CC_Mqtt5ReasonCode_BadAuthMethod = 140, 
    CC_Mqtt5ReasonCode_KeepAliveTimeout = 141, 
    CC_Mqtt5ReasonCode_SessionTakenOver = 142, 
    CC_Mqtt5ReasonCode_TopicFilterInvalid = 143, 
    CC_Mqtt5ReasonCode_TopicNameInvalid = 144, 
    CC_Mqtt5ReasonCode_PacketIdInUse = 145, 
    CC_Mqtt5ReasonCode_PacketIdNotFound = 146, 
    CC_Mqtt5ReasonCode_ReceiveMaxExceeded = 147, 
    CC_Mqtt5ReasonCode_TopicAliasInvalid = 148, 
    CC_Mqtt5ReasonCode_PacketTooLarge = 149, 
    CC_Mqtt5ReasonCode_MsgRateTooHigh = 150, 
    CC_Mqtt5ReasonCode_QuotaExceeded = 151, 
    CC_Mqtt5ReasonCode_AdministrativeAction = 152, 
    CC_Mqtt5ReasonCode_PayloadFormatInvalid = 153, 
    CC_Mqtt5ReasonCode_RetainNotSupported = 154, 
    CC_Mqtt5ReasonCode_QosNotSupported = 155, 
    CC_Mqtt5ReasonCode_UseAnotherServer = 156, 
    CC_Mqtt5ReasonCode_ServerMoved = 157, 
    CC_Mqtt5ReasonCode_SharedSubNotSuppored = 158, 
    CC_Mqtt5ReasonCode_ConnectionRateExceeded = 159, 
    CC_Mqtt5ReasonCode_MaxConnectTime = 160, 
    CC_Mqtt5ReasonCode_SubIdsNotSupported = 161, 
    CC_Mqtt5ReasonCode_WildcardSubsNotSupported = 162, 
} CC_Mqtt5ReasonCode;
 
typedef enum
{
    CC_Mqtt5RetainHandling_Send = 0, 
    CC_Mqtt5RetainHandling_SendIfDoesNotExist = 1, 
    CC_Mqtt5RetainHandling_DoNotSend = 2, 
    CC_Mqtt5RetainHandling_ValuesLimit 
} CC_Mqtt5RetainHandling;
 
typedef enum
{
    CC_Mqtt5TopicAliasPreference_UseAliasIfAvailable = 0, 
    CC_Mqtt5TopicAliasPreference_ForceAliasOnly = 1, 
    CC_Mqtt5TopicAliasPreference_ForceTopicOnly = 2, 
    CC_Mqtt5TopicAliasPreference_ForceTopicWithAlias = 3, 
    CC_Mqtt5TopicAliasPreference_ValuesLimit 
} CC_Mqtt5TopicAliasPreference;
 
typedef enum
{
    CC_Mqtt5PublishOrdering_SameQos, 
    CC_Mqtt5PublishOrdering_Full, 
    CC_Mqtt5PublishOrdering_ValuesLimit 
} CC_Mqtt5PublishOrdering;
 
typedef enum
{
    CC_Mqtt5BrokerDisconnectReason_DisconnectMsg = 0, 
    CC_Mqtt5BrokerDisconnectReason_InternalError = 1, 
    CC_Mqtt5BrokerDisconnectReason_NoBrokerResponse = 2, 
    CC_Mqtt5BrokerDisconnectReason_ProtocolError = 3, 
    CC_Mqtt5BrokerDisconnectReason_ValuesLimit 
} CC_Mqtt5BrokerDisconnectReason;
 
struct CC_Mqtt5Client;
 
typedef struct CC_Mqtt5Client* CC_Mqtt5ClientHandle;
 
struct CC_Mqtt5Connect;
 
typedef struct CC_Mqtt5Connect* CC_Mqtt5ConnectHandle;
 
struct CC_Mqtt5Disconnect;
 
typedef struct CC_Mqtt5Disconnect* CC_Mqtt5DisconnectHandle;
 
struct CC_Mqtt5Subscribe;
 
typedef struct CC_Mqtt5Subscribe* CC_Mqtt5SubscribeHandle;
 
struct CC_Mqtt5Unsubscribe;
 
typedef struct CC_Mqtt5Unsubscribe* CC_Mqtt5UnsubscribeHandle;
 
struct CC_Mqtt5Publish;
 
typedef struct CC_Mqtt5Publish* CC_Mqtt5PublishHandle;
 
struct CC_Mqtt5Reauth;
 
typedef struct CC_Mqtt5Reauth* CC_Mqtt5ReauthHandle;
 
typedef struct
{
    const char* m_key; 
    const char* m_value; 
} CC_Mqtt5UserProp;
 
typedef struct
{
    const char* m_clientId; 
    const char* m_username; 
    const unsigned char* m_password; 
    unsigned m_passwordLen; 
    unsigned m_keepAlive; 
    bool m_cleanStart; 
} CC_Mqtt5ConnectBasicConfig;
 
typedef struct
{
    const char* m_topic; 
    const unsigned char* m_data; 
    unsigned m_dataLen; 
    const char* m_contentType; 
    const char* m_responseTopic; 
    const unsigned char* m_correlationData; 
    unsigned m_correlationDataLen; 
    unsigned m_delayInterval; 
    unsigned m_messageExpiryInterval; 
    CC_Mqtt5QoS m_qos; 
    CC_Mqtt5PayloadFormat m_format; 
    bool m_retain; 
} CC_Mqtt5ConnectWillConfig;
 
typedef struct
{
    unsigned m_sessionExpiryInterval; 
    unsigned m_receiveMaximum; 
    unsigned m_maxPacketSize; 
    unsigned m_topicAliasMaximum; 
    bool m_requestResponseInfo; 
    bool m_requestProblemInfo; 
} CC_Mqtt5ConnectExtraConfig;
 
typedef struct 
{
    CC_Mqtt5ReasonCode m_reasonCode; 
    const char* m_assignedClientId; 
    const char* m_responseInfo; 
    const char* m_reasonStr; 
    const char* m_serverRef; 
    const unsigned char* m_authData; 
    unsigned m_authDataLen; 
    const CC_Mqtt5UserProp* m_userProps; 
    unsigned m_userPropsCount; 
    unsigned m_sessionExpiryInterval; 
    unsigned m_highQosSendLimit; 
    unsigned m_maxPacketSize; 
    unsigned m_topicAliasMax; 
    CC_Mqtt5QoS m_maxQos; 
    bool m_sessionPresent; 
    bool m_retainAvailable; 
    bool m_wildcardSubAvailable; 
    bool m_subIdsAvailable; 
    bool m_sharedSubsAvailable; 
} CC_Mqtt5ConnectResponse;
 
typedef struct
{
    const unsigned char* m_authData; 
    unsigned m_authDataLen; 
    const char* m_reasonStr; 
    const CC_Mqtt5UserProp* m_userProps; 
    unsigned m_userPropsCount; 
} CC_Mqtt5AuthInfo;
 
typedef struct
{
    CC_Mqtt5ReasonCode m_reasonCode; 
    const char* m_reasonStr; 
    const char* m_serverRef; 
    const CC_Mqtt5UserProp* m_userProps; 
    unsigned m_userPropsCount; 
} CC_Mqtt5DisconnectInfo;
 
typedef struct
{
    CC_Mqtt5ReasonCode m_reasonCode; 
    const char* m_reasonStr; 
    unsigned* m_sessionExpiryInterval; 
} CC_Mqtt5DisconnectConfig;
 
typedef struct
{
    const char* m_topic; 
    CC_Mqtt5QoS m_maxQos; 
    CC_Mqtt5RetainHandling m_retainHandling; 
    bool m_noLocal; 
    bool m_retainAsPublished; 
} CC_Mqtt5SubscribeTopicConfig;
 
typedef struct
{
    unsigned m_subId; 
} CC_Mqtt5SubscribeExtraConfig;
 
typedef struct 
{
    const CC_Mqtt5ReasonCode* m_reasonCodes; 
    unsigned m_reasonCodesCount; 
    const char* m_reasonStr; 
    const CC_Mqtt5UserProp* m_userProps; 
    unsigned m_userPropsCount; 
} CC_Mqtt5SubscribeResponse;
 
typedef struct
{
    const char* m_topic; 
} CC_Mqtt5UnsubscribeTopicConfig;
 
typedef struct 
{
    const CC_Mqtt5ReasonCode* m_reasonCodes; 
    unsigned m_reasonCodesCount; 
    const char* m_reasonStr; 
    const CC_Mqtt5UserProp* m_userProps; 
    unsigned m_userPropsCount; 
} CC_Mqtt5UnsubscribeResponse;
 
typedef struct
{
    const char* m_topic; 
    const unsigned char* m_data; 
    unsigned m_dataLen; 
    const char* m_responseTopic; 
    const unsigned char* m_correlationData; 
    unsigned m_correlationDataLen; 
    const CC_Mqtt5UserProp* m_userProps; 
    unsigned m_userPropsCount; 
    const char* m_contentType; 
    const unsigned* m_subIds; 
    unsigned m_subIdsCount; 
    unsigned m_messageExpiryInterval; 
    CC_Mqtt5QoS m_qos; 
    CC_Mqtt5PayloadFormat m_format; 
    bool m_retained; 
} CC_Mqtt5MessageInfo;
 
typedef struct
{
    const char* m_topic; 
    const unsigned char* m_data; 
    unsigned m_dataLen; 
    CC_Mqtt5QoS m_qos; 
    CC_Mqtt5TopicAliasPreference m_topicAliasPref; 
    bool m_retain; 
} CC_Mqtt5PublishBasicConfig;
 
typedef struct
{
    const char* m_contentType; 
    const char* m_responseTopic; 
    const unsigned char* m_correlationData; 
    unsigned m_correlationDataLen; 
    unsigned m_messageExpiryInterval; 
    CC_Mqtt5PayloadFormat m_format; 
} CC_Mqtt5PublishExtraConfig;
 
typedef struct 
{
    CC_Mqtt5ReasonCode m_reasonCode; 
    const char* m_reasonStr; 
    const CC_Mqtt5UserProp* m_userProps; 
    unsigned m_userPropsCount; 
} CC_Mqtt5PublishResponse;
 
typedef void (*CC_Mqtt5NextTickProgramCb)(void* data, unsigned duration);
 
typedef unsigned (*CC_Mqtt5CancelNextTickWaitCb)(void* data);
 
typedef void (*CC_Mqtt5SendOutputDataCb)(void* data, const unsigned char* buf, unsigned bufLen);
 
typedef void (*CC_Mqtt5BrokerDisconnectReportCb)(void* data, CC_Mqtt5BrokerDisconnectReason reason, const CC_Mqtt5DisconnectInfo* info);
 
typedef void (*CC_Mqtt5MessageReceivedReportCb)(void* data, const CC_Mqtt5MessageInfo* info);
 
typedef void (*CC_Mqtt5ErrorLogCb)(void* data, const char* msg);
 
typedef void (*CC_Mqtt5ConnectCompleteCb)(void* data, CC_Mqtt5AsyncOpStatus status, const CC_Mqtt5ConnectResponse* response);
 
typedef CC_Mqtt5AuthErrorCode (*CC_Mqtt5AuthCb)(void* data, const CC_Mqtt5AuthInfo* authInfoIn, CC_Mqtt5AuthInfo* authInfoOut);
 
typedef void (*CC_Mqtt5SubscribeCompleteCb)(void* data, CC_Mqtt5SubscribeHandle handle, CC_Mqtt5AsyncOpStatus status, const CC_Mqtt5SubscribeResponse* response);
 
typedef void (*CC_Mqtt5UnsubscribeCompleteCb)(void* data, CC_Mqtt5UnsubscribeHandle handle, CC_Mqtt5AsyncOpStatus status, const CC_Mqtt5UnsubscribeResponse* response);
 
typedef void (*CC_Mqtt5PublishCompleteCb)(void* data, CC_Mqtt5PublishHandle handle, CC_Mqtt5AsyncOpStatus status, const CC_Mqtt5PublishResponse* response);
 
typedef void (*CC_Mqtt5ReauthCompleteCb)(void* data, CC_Mqtt5AsyncOpStatus status, const CC_Mqtt5AuthInfo* response);
 
typedef struct
{
    const char* m_authMethod; 
    const unsigned char* m_authData; 
    unsigned m_authDataLen; 
    CC_Mqtt5AuthCb m_authCb; 
    void* m_authCbData; 
 
} CC_Mqtt5AuthConfig;
 
#ifdef __cplusplus
}
#endif