client.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
 
#include "cc_mqtt5_client/common.h"
 
#ifdef __cplusplus
extern "C" {
#endif // #ifdef __cplusplus
 
 
CC_Mqtt5ClientHandle cc_mqtt5_client_alloc();
 
void cc_mqtt5_client_free(CC_Mqtt5ClientHandle handle);
 
void cc_mqtt5_client_tick(CC_Mqtt5ClientHandle handle, unsigned ms);
 
unsigned cc_mqtt5_client_process_data(CC_Mqtt5ClientHandle handle, const unsigned char* buf, unsigned bufLen);
 
void cc_mqtt5_client_notify_network_disconnected(CC_Mqtt5ClientHandle handle);
 
bool cc_mqtt5_client_is_network_disconnected(CC_Mqtt5ClientHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_set_default_response_timeout(CC_Mqtt5ClientHandle handle, unsigned ms);
 
unsigned cc_mqtt5_client_get_default_response_timeout(CC_Mqtt5ClientHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_pub_topic_alias_alloc(CC_Mqtt5ClientHandle handle, const char* topic, unsigned qos0RegsCount);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_pub_topic_alias_free(CC_Mqtt5ClientHandle handle, const char* topic);
 
unsigned cc_mqtt5_client_pub_topic_alias_count(CC_Mqtt5ClientHandle handle);
 
bool cc_mqtt5_client_pub_topic_alias_is_allocated(CC_Mqtt5ClientHandle handle, const char* topic);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_set_verify_outgoing_topic_enabled(CC_Mqtt5ClientHandle handle, bool enabled);
 
bool cc_mqtt5_client_get_verify_outgoing_topic_enabled(CC_Mqtt5ClientHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_set_verify_incoming_topic_enabled(CC_Mqtt5ClientHandle handle, bool enabled);
 
bool cc_mqtt5_client_get_verify_incoming_topic_enabled(CC_Mqtt5ClientHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_set_verify_incoming_msg_subscribed(CC_Mqtt5ClientHandle handle, bool enabled);
 
bool cc_mqtt5_client_get_verify_incoming_msg_subscribed(CC_Mqtt5ClientHandle handle);
 
void cc_mqtt5_client_init_user_prop(CC_Mqtt5UserProp* prop);
 
CC_Mqtt5ConnectHandle cc_mqtt5_client_connect_prepare(CC_Mqtt5ClientHandle handle, CC_Mqtt5ErrorCode* ec);
 
void cc_mqtt5_client_connect_init_config_basic(CC_Mqtt5ConnectBasicConfig* config);
 
void cc_mqtt5_client_connect_init_config_will(CC_Mqtt5ConnectWillConfig* config);
 
void cc_mqtt5_client_connect_init_config_extra(CC_Mqtt5ConnectExtraConfig* config);
 
void cc_mqtt5_client_connect_init_config_auth(CC_Mqtt5AuthConfig* config);
 
void cc_mqtt5_client_connect_init_auth_info(CC_Mqtt5AuthInfo* info);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_connect_set_response_timeout(CC_Mqtt5ConnectHandle handle, unsigned ms);
 
unsigned cc_mqtt5_client_connect_get_response_timeout(CC_Mqtt5ConnectHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_connect_config_basic(CC_Mqtt5ConnectHandle handle, const CC_Mqtt5ConnectBasicConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_connect_config_will(CC_Mqtt5ConnectHandle handle, const CC_Mqtt5ConnectWillConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_connect_config_extra(CC_Mqtt5ConnectHandle handle, const CC_Mqtt5ConnectExtraConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_connect_config_auth(CC_Mqtt5ConnectHandle handle, const CC_Mqtt5AuthConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_connect_add_user_prop(CC_Mqtt5ConnectHandle handle, const CC_Mqtt5UserProp* prop);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_connect_add_will_user_prop(CC_Mqtt5ConnectHandle handle, const CC_Mqtt5UserProp* prop);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_connect_send(CC_Mqtt5ConnectHandle handle, CC_Mqtt5ConnectCompleteCb cb, void* cbData);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_connect_cancel(CC_Mqtt5ConnectHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_connect_simple(
    CC_Mqtt5ClientHandle handle,
    const CC_Mqtt5ConnectBasicConfig* basicConfig,
    CC_Mqtt5ConnectCompleteCb cb, 
    void* cbData);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_connect_full(
    CC_Mqtt5ClientHandle handle,
    const CC_Mqtt5ConnectBasicConfig* basicConfig,
    const CC_Mqtt5ConnectWillConfig* willConfig,
    const CC_Mqtt5ConnectExtraConfig* extraConfig,
    const CC_Mqtt5AuthConfig* authConfig,
    CC_Mqtt5ConnectCompleteCb cb, 
    void* cbData);    
 
bool cc_mqtt5_client_is_connected(CC_Mqtt5ClientHandle handle);
 
CC_Mqtt5DisconnectHandle cc_mqtt5_client_disconnect_prepare(CC_Mqtt5ClientHandle handle, CC_Mqtt5ErrorCode* ec);
 
void cc_mqtt5_client_disconnect_init_config(CC_Mqtt5DisconnectConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_disconnect_config(CC_Mqtt5DisconnectHandle handle, const CC_Mqtt5DisconnectConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_disconnect_add_user_prop(CC_Mqtt5DisconnectHandle handle, const CC_Mqtt5UserProp* prop);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_disconnect_send(CC_Mqtt5DisconnectHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_disconnect_cancel(CC_Mqtt5DisconnectHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_disconnect(
    CC_Mqtt5ClientHandle handle,
    const CC_Mqtt5DisconnectConfig* config);
 
CC_Mqtt5SubscribeHandle cc_mqtt5_client_subscribe_prepare(CC_Mqtt5ClientHandle handle, CC_Mqtt5ErrorCode* ec);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_subscribe_set_response_timeout(CC_Mqtt5SubscribeHandle handle, unsigned ms);
 
unsigned cc_mqtt5_client_subscribe_get_response_timeout(CC_Mqtt5SubscribeHandle handle);
 
void cc_mqtt5_client_subscribe_init_config_topic(CC_Mqtt5SubscribeTopicConfig* config);
 
void cc_mqtt5_client_subscribe_init_config_extra(CC_Mqtt5SubscribeExtraConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_subscribe_config_topic(CC_Mqtt5SubscribeHandle handle, const CC_Mqtt5SubscribeTopicConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_subscribe_config_extra(CC_Mqtt5SubscribeHandle handle, const CC_Mqtt5SubscribeExtraConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_subscribe_add_user_prop(CC_Mqtt5SubscribeHandle handle, const CC_Mqtt5UserProp* prop);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_subscribe_send(CC_Mqtt5SubscribeHandle handle, CC_Mqtt5SubscribeCompleteCb cb, void* cbData);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_subscribe_cancel(CC_Mqtt5SubscribeHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_subscribe_simple(
    CC_Mqtt5ClientHandle handle,
    const CC_Mqtt5SubscribeTopicConfig* topicConfig,
    CC_Mqtt5SubscribeCompleteCb cb, 
    void* cbData);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_subscribe_full(
    CC_Mqtt5ClientHandle handle,
    const CC_Mqtt5SubscribeTopicConfig* topicConfigs,
    unsigned topicConfigsCount,
    const CC_Mqtt5SubscribeExtraConfig* extraConfig,
    CC_Mqtt5SubscribeCompleteCb cb, 
    void* cbData);  
 
CC_Mqtt5UnsubscribeHandle cc_mqtt5_client_unsubscribe_prepare(CC_Mqtt5ClientHandle handle, CC_Mqtt5ErrorCode* ec);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_unsubscribe_set_response_timeout(CC_Mqtt5UnsubscribeHandle handle, unsigned ms);
 
unsigned cc_mqtt5_client_unsubscribe_get_response_timeout(CC_Mqtt5UnsubscribeHandle handle);
 
void cc_mqtt5_client_unsubscribe_init_config_topic(CC_Mqtt5UnsubscribeTopicConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_unsubscribe_config_topic(CC_Mqtt5UnsubscribeHandle handle, const CC_Mqtt5UnsubscribeTopicConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_unsubscribe_add_user_prop(CC_Mqtt5UnsubscribeHandle handle, const CC_Mqtt5UserProp* prop);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_unsubscribe_send(CC_Mqtt5UnsubscribeHandle handle, CC_Mqtt5UnsubscribeCompleteCb cb, void* cbData);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_unsubscribe_cancel(CC_Mqtt5UnsubscribeHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_unsubscribe_simple(
    CC_Mqtt5ClientHandle handle,
    const CC_Mqtt5UnsubscribeTopicConfig* topicConfig,
    CC_Mqtt5UnsubscribeCompleteCb cb, 
    void* cbData);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_unsubscribe_full(
    CC_Mqtt5ClientHandle handle,
    const CC_Mqtt5UnsubscribeTopicConfig* topicConfigs,
    unsigned topicConfigsCount,
    CC_Mqtt5UnsubscribeCompleteCb cb, 
    void* cbData);  
 
CC_Mqtt5PublishHandle cc_mqtt5_client_publish_prepare(CC_Mqtt5ClientHandle handle, CC_Mqtt5ErrorCode* ec);
 
unsigned cc_mqtt5_client_publish_count(CC_Mqtt5ClientHandle handle);
 
void cc_mqtt5_client_publish_init_config_basic(CC_Mqtt5PublishBasicConfig* config);
 
void cc_mqtt5_client_publish_init_config_extra(CC_Mqtt5PublishExtraConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_publish_set_response_timeout(CC_Mqtt5PublishHandle handle, unsigned ms);
 
unsigned cc_mqtt5_client_publish_get_response_timeout(CC_Mqtt5PublishHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_publish_set_resend_attempts(CC_Mqtt5PublishHandle handle, unsigned attempts);
 
unsigned cc_mqtt5_client_publish_get_resend_attempts(CC_Mqtt5PublishHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_publish_config_basic(CC_Mqtt5PublishHandle handle, const CC_Mqtt5PublishBasicConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_publish_config_extra(CC_Mqtt5PublishHandle handle, const CC_Mqtt5PublishExtraConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_publish_add_user_prop(CC_Mqtt5PublishHandle handle, const CC_Mqtt5UserProp* prop);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_publish_send(CC_Mqtt5PublishHandle handle, CC_Mqtt5PublishCompleteCb cb, void* cbData);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_publish_cancel(CC_Mqtt5PublishHandle handle);
 
bool cc_mqtt5_client_publish_was_initiated(CC_Mqtt5PublishHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_publish_simple(
    CC_Mqtt5ClientHandle handle,
    const CC_Mqtt5PublishBasicConfig* basicConfig,
    CC_Mqtt5PublishCompleteCb cb, 
    void* cbData);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_publish_full(
    CC_Mqtt5ClientHandle handle,
    const CC_Mqtt5PublishBasicConfig* basicConfig,
    const CC_Mqtt5PublishExtraConfig* extraConfig,
    CC_Mqtt5PublishCompleteCb cb, 
    void* cbData);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_publish_set_ordering(CC_Mqtt5ClientHandle handle, CC_Mqtt5PublishOrdering ordering);    
 
CC_Mqtt5PublishOrdering cc_mqtt5_client_publish_get_ordering(CC_Mqtt5ClientHandle handle);    
 
CC_Mqtt5ReauthHandle cc_mqtt5_client_reauth_prepare(CC_Mqtt5ClientHandle handle, CC_Mqtt5ErrorCode* ec);
 
void cc_mqtt5_client_reauth_init_config_auth(CC_Mqtt5AuthConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_reauth_set_response_timeout(CC_Mqtt5ReauthHandle handle, unsigned ms);
 
unsigned cc_mqtt5_client_reauth_get_response_timeout(CC_Mqtt5ReauthHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_reauth_config_auth(CC_Mqtt5ReauthHandle handle, const CC_Mqtt5AuthConfig* config);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_reauth_add_user_prop(CC_Mqtt5ReauthHandle handle, const CC_Mqtt5UserProp* prop);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_reauth_send(CC_Mqtt5ReauthHandle handle, CC_Mqtt5ReauthCompleteCb cb, void* cbData);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_reauth_cancel(CC_Mqtt5ReauthHandle handle);
 
CC_Mqtt5ErrorCode cc_mqtt5_client_reauth(
    CC_Mqtt5ClientHandle handle,
    const CC_Mqtt5AuthConfig* config,
    CC_Mqtt5ReauthCompleteCb cb, 
    void* cbData);
 
// --------------------- Callbacks ---------------------
 
void cc_mqtt5_client_set_next_tick_program_callback(
    CC_Mqtt5ClientHandle handle,
    CC_Mqtt5NextTickProgramCb cb,
    void* data);
    
void cc_mqtt5_client_set_cancel_next_tick_wait_callback(
    CC_Mqtt5ClientHandle handle,
    CC_Mqtt5CancelNextTickWaitCb cb,
    void* data);
    
void cc_mqtt5_client_set_send_output_data_callback(
    CC_Mqtt5ClientHandle handle,
    CC_Mqtt5SendOutputDataCb cb,
    void* data);
 
void cc_mqtt5_client_set_broker_disconnect_report_callback(
    CC_Mqtt5ClientHandle handle,
    CC_Mqtt5BrokerDisconnectReportCb cb,
    void* data);
 
void cc_mqtt5_client_set_message_received_report_callback(
    CC_Mqtt5ClientHandle handle,
    CC_Mqtt5MessageReceivedReportCb cb,
    void* data);
 
void cc_mqtt5_client_set_error_log_callback(
    CC_Mqtt5ClientHandle handle,
    CC_Mqtt5ErrorLogCb cb,
    void* data);
 
#ifdef __cplusplus
}
#endif