client.h

Go to the documentation of this file.

//
// Copyright 2024 - 2025 (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_mqtt311_client/common.h"
 
#ifdef __cplusplus
extern "C" {
#endif // #ifdef __cplusplus
 
 
CC_Mqtt311ClientHandle cc_mqtt311_client_alloc();
 
void cc_mqtt311_client_free(CC_Mqtt311ClientHandle handle);
 
void cc_mqtt311_client_tick(CC_Mqtt311ClientHandle handle, unsigned ms);
 
unsigned cc_mqtt311_client_process_data(CC_Mqtt311ClientHandle handle, const unsigned char* buf, unsigned bufLen);
 
void cc_mqtt311_client_notify_network_disconnected(CC_Mqtt311ClientHandle handle);
 
bool cc_mqtt311_client_is_network_disconnected(CC_Mqtt311ClientHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_set_default_response_timeout(CC_Mqtt311ClientHandle handle, unsigned ms);
 
unsigned cc_mqtt311_client_get_default_response_timeout(CC_Mqtt311ClientHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_set_verify_outgoing_topic_enabled(CC_Mqtt311ClientHandle handle, bool enabled);
 
bool cc_mqtt311_client_get_verify_outgoing_topic_enabled(CC_Mqtt311ClientHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_set_verify_incoming_topic_enabled(CC_Mqtt311ClientHandle handle, bool enabled);
 
bool cc_mqtt311_client_get_verify_incoming_topic_enabled(CC_Mqtt311ClientHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_set_verify_incoming_msg_subscribed(CC_Mqtt311ClientHandle handle, bool enabled);
 
bool cc_mqtt311_client_get_verify_incoming_msg_subscribed(CC_Mqtt311ClientHandle handle);
 
CC_Mqtt311ConnectHandle cc_mqtt311_client_connect_prepare(CC_Mqtt311ClientHandle handle, CC_Mqtt311ErrorCode* ec);
 
void cc_mqtt311_client_connect_init_config(CC_Mqtt311ConnectConfig* config);
 
void cc_mqtt311_client_connect_init_config_will(CC_Mqtt311ConnectWillConfig* config);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_connect_set_response_timeout(CC_Mqtt311ConnectHandle handle, unsigned ms);
 
unsigned cc_mqtt311_client_connect_get_response_timeout(CC_Mqtt311ConnectHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_connect_config(CC_Mqtt311ConnectHandle handle, const CC_Mqtt311ConnectConfig* config);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_connect_config_will(CC_Mqtt311ConnectHandle handle, const CC_Mqtt311ConnectWillConfig* config);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_connect_send(CC_Mqtt311ConnectHandle handle, CC_Mqtt311ConnectCompleteCb cb, void* cbData);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_connect_cancel(CC_Mqtt311ConnectHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_connect(
    CC_Mqtt311ClientHandle handle,
    const CC_Mqtt311ConnectConfig* config,
    const CC_Mqtt311ConnectWillConfig* willConfig,
    CC_Mqtt311ConnectCompleteCb cb, 
    void* cbData);    
 
bool cc_mqtt311_client_is_connected(CC_Mqtt311ClientHandle handle);
 
CC_Mqtt311DisconnectHandle cc_mqtt311_client_disconnect_prepare(CC_Mqtt311ClientHandle handle, CC_Mqtt311ErrorCode* ec);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_disconnect_send(CC_Mqtt311DisconnectHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_disconnect_cancel(CC_Mqtt311DisconnectHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_disconnect(CC_Mqtt311ClientHandle handle);
 
CC_Mqtt311SubscribeHandle cc_mqtt311_client_subscribe_prepare(CC_Mqtt311ClientHandle handle, CC_Mqtt311ErrorCode* ec);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_subscribe_set_response_timeout(CC_Mqtt311SubscribeHandle handle, unsigned ms);
 
unsigned cc_mqtt311_client_subscribe_get_response_timeout(CC_Mqtt311SubscribeHandle handle);
 
void cc_mqtt311_client_subscribe_init_config_topic(CC_Mqtt311SubscribeTopicConfig* config);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_subscribe_config_topic(CC_Mqtt311SubscribeHandle handle, const CC_Mqtt311SubscribeTopicConfig* config);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_subscribe_send(CC_Mqtt311SubscribeHandle handle, CC_Mqtt311SubscribeCompleteCb cb, void* cbData);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_subscribe_cancel(CC_Mqtt311SubscribeHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_subscribe(
    CC_Mqtt311ClientHandle handle,
    const CC_Mqtt311SubscribeTopicConfig* topicConfigs,
    unsigned topicConfigsCount,
    CC_Mqtt311SubscribeCompleteCb cb, 
    void* cbData);  
 
CC_Mqtt311UnsubscribeHandle cc_mqtt311_client_unsubscribe_prepare(CC_Mqtt311ClientHandle handle, CC_Mqtt311ErrorCode* ec);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_unsubscribe_set_response_timeout(CC_Mqtt311UnsubscribeHandle handle, unsigned ms);
 
unsigned cc_mqtt311_client_unsubscribe_get_response_timeout(CC_Mqtt311UnsubscribeHandle handle);
 
void cc_mqtt311_client_unsubscribe_init_config_topic(CC_Mqtt311UnsubscribeTopicConfig* config);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_unsubscribe_config_topic(CC_Mqtt311UnsubscribeHandle handle, const CC_Mqtt311UnsubscribeTopicConfig* config);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_unsubscribe_send(CC_Mqtt311UnsubscribeHandle handle, CC_Mqtt311UnsubscribeCompleteCb cb, void* cbData);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_unsubscribe_cancel(CC_Mqtt311UnsubscribeHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_unsubscribe(
    CC_Mqtt311ClientHandle handle,
    const CC_Mqtt311UnsubscribeTopicConfig* topicConfigs,
    unsigned topicConfigsCount,
    CC_Mqtt311UnsubscribeCompleteCb cb, 
    void* cbData);  
 
CC_Mqtt311PublishHandle cc_mqtt311_client_publish_prepare(CC_Mqtt311ClientHandle handle, CC_Mqtt311ErrorCode* ec);
 
unsigned cc_mqtt311_client_publish_count(CC_Mqtt311ClientHandle handle);
 
void cc_mqtt311_client_publish_init_config(CC_Mqtt311PublishConfig* config);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_publish_set_response_timeout(CC_Mqtt311PublishHandle handle, unsigned ms);
 
unsigned cc_mqtt311_client_publish_get_response_timeout(CC_Mqtt311PublishHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_publish_set_resend_attempts(CC_Mqtt311PublishHandle handle, unsigned attempts);
 
unsigned cc_mqtt311_client_publish_get_resend_attempts(CC_Mqtt311PublishHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_publish_config(CC_Mqtt311PublishHandle handle, const CC_Mqtt311PublishConfig* config);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_publish_send(CC_Mqtt311PublishHandle handle, CC_Mqtt311PublishCompleteCb cb, void* cbData);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_publish_cancel(CC_Mqtt311PublishHandle handle);
 
bool cc_mqtt311_client_publish_was_initiated(CC_Mqtt311PublishHandle handle);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_publish(
    CC_Mqtt311ClientHandle handle,
    const CC_Mqtt311PublishConfig* config,
    CC_Mqtt311PublishCompleteCb cb, 
    void* cbData);
 
CC_Mqtt311ErrorCode cc_mqtt311_client_publish_set_ordering(CC_Mqtt311ClientHandle handle, CC_Mqtt311PublishOrdering ordering);    
 
CC_Mqtt311PublishOrdering cc_mqtt311_client_publish_get_ordering(CC_Mqtt311ClientHandle handle);      
 
 
// --------------------- Callbacks ---------------------
 
void cc_mqtt311_client_set_next_tick_program_callback(
    CC_Mqtt311ClientHandle handle,
    CC_Mqtt311NextTickProgramCb cb,
    void* data);
    
void cc_mqtt311_client_set_cancel_next_tick_wait_callback(
    CC_Mqtt311ClientHandle handle,
    CC_Mqtt311CancelNextTickWaitCb cb,
    void* data);
    
void cc_mqtt311_client_set_send_output_data_callback(
    CC_Mqtt311ClientHandle handle,
    CC_Mqtt311SendOutputDataCb cb,
    void* data);
 
void cc_mqtt311_client_set_broker_disconnect_report_callback(
    CC_Mqtt311ClientHandle handle,
    CC_Mqtt311BrokerDisconnectReportCb cb,
    void* data);
 
void cc_mqtt311_client_set_message_received_report_callback(
    CC_Mqtt311ClientHandle handle,
    CC_Mqtt311MessageReceivedReportCb cb,
    void* data);
 
void cc_mqtt311_client_set_error_log_callback(
    CC_Mqtt311ClientHandle handle,
    CC_Mqtt311ErrorLogCb cb,
    void* data);
 
#ifdef __cplusplus
}
#endif