gateway_all.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
 
#include "version.h"
 
#ifdef __cplusplus
extern "C" {
#else // #ifdef __cplusplus
#include <stdbool.h>
#endif // #ifdef __cplusplus
 
/*===================== Gateway Object ======================*/
 
struct CC_MqttsnGateway;
 
typedef struct CC_MqttsnGateway* CC_MqttsnGatewayHandle;
 
typedef void (*CC_MqttsnGwTickReqCb)(void* userData, unsigned duration);
 
typedef void (*CC_MqttsnGwBroadcastReqCb)(void* userData, const unsigned char* buf, unsigned bufLen);
 
CC_MqttsnGatewayHandle cc_mqttsn_gw_alloc(void);
 
void cc_mqttsn_gw_free(CC_MqttsnGatewayHandle gw);
 
void cc_mqttsn_gw_set_advertise_period(CC_MqttsnGatewayHandle gw, unsigned short value);
 
unsigned short cc_mqttsn_gw_get_advertise_period(CC_MqttsnGatewayHandle gw);
 
void cc_mqttsn_gw_set_id(CC_MqttsnGatewayHandle gw, unsigned char id);
 
unsigned char cc_mqttsn_gw_get_id(CC_MqttsnGatewayHandle gw);
 
void cc_mqttsn_gw_set_tick_req_cb(CC_MqttsnGatewayHandle gw, CC_MqttsnGwTickReqCb cb, void* data);
 
void cc_mqttsn_gw_set_advertise_broadcast_req_cb(
    CC_MqttsnGatewayHandle gw,
    CC_MqttsnGwBroadcastReqCb cb,
    void* data);
 
bool cc_mqttsn_gw_start(CC_MqttsnGatewayHandle gw);
 
void cc_mqttsn_gw_stop(CC_MqttsnGatewayHandle gw);
 
void cc_mqttsn_gw_tick(CC_MqttsnGatewayHandle gw);
 
/*===================== Session Object ======================*/
 
struct CC_MqttsnSession;
 
typedef struct CC_MqttsnSession* CC_MqttsnSessionHandle;
 
typedef void (*CC_MqttsnSessionTickReqCb)(void* userData, CC_MqttsnSessionHandle session, unsigned duration);
 
typedef unsigned (*CC_MqttsnSessionCancelTickReqCb)(void* userData, CC_MqttsnSessionHandle session);
 
typedef void (*CC_MqttsnSessionClientSendDataReqCb)(void* userData, CC_MqttsnSessionHandle session, const unsigned char* buf, unsigned bufLen, unsigned broadcastRadius);
 
typedef void (*CC_MqttsnSessionBrokerSendDataReqCb)(void* userData, CC_MqttsnSessionHandle session, const unsigned char* buf, unsigned bufLen);
 
typedef void (*CC_MqttsnSessionTermReqCb)(void* userData, CC_MqttsnSessionHandle session);
 
typedef void (*CC_MqttsnSessionBrokerReconnectReqCb)(void* userData, CC_MqttsnSessionHandle session);
 
typedef void (*CC_MqttsnSessionClientConnectReportCb)(void* userData, CC_MqttsnSessionHandle session, const char* clientId);
 
typedef void (*CC_MqttsnSessionAuthInfoReqCb)(
    void* userData,
    CC_MqttsnSessionHandle session,
    const char* clientId,
    const char** username,
    const unsigned char** password,
    unsigned* passwordLen);
 
typedef void (*CC_MqttsnSessionErrorReportCb)(void* userData, CC_MqttsnSessionHandle session, const char* msg);
 
typedef bool (*CC_MqttsnSessionFwdEncSessionCreatedCb)(void* userData, CC_MqttsnSessionHandle session);
 
typedef void (*CC_MqttsnSessionFwdEncSessionDeletedCb)(void* userData, CC_MqttsnSessionHandle session);
 
CC_MqttsnSessionHandle cc_mqttsn_gw_session_alloc(void);
 
void cc_mqttsn_gw_session_free(CC_MqttsnSessionHandle session);
 
void cc_mqttsn_gw_session_set_tick_req_cb(
    CC_MqttsnSessionHandle session,
    CC_MqttsnSessionTickReqCb cb,
    void* data);
 
void cc_mqttsn_gw_session_set_cancel_tick_cb(
    CC_MqttsnSessionHandle session,
    CC_MqttsnSessionCancelTickReqCb cb,
    void* data);
 
void cc_mqttsn_gw_session_set_send_data_to_client_cb(
    CC_MqttsnSessionHandle session,
    CC_MqttsnSessionClientSendDataReqCb cb,
    void* data);
 
void cc_mqttsn_gw_session_set_send_data_to_broker_cb(
    CC_MqttsnSessionHandle session,
    CC_MqttsnSessionBrokerSendDataReqCb cb,
    void* data);
 
void cc_mqttsn_gw_session_set_term_req_cb(
    CC_MqttsnSessionHandle session,
    CC_MqttsnSessionTermReqCb cb,
    void* data);
 
void cc_mqttsn_gw_session_set_broker_reconnect_req_cb(
    CC_MqttsnSessionHandle session,
    CC_MqttsnSessionBrokerReconnectReqCb cb,
    void* data);
 
void cc_mqttsn_gw_session_set_client_connect_report_cb(
    CC_MqttsnSessionHandle session,
    CC_MqttsnSessionClientConnectReportCb cb,
    void* data);
 
void cc_mqttsn_gw_session_set_auth_info_req_cb(
    CC_MqttsnSessionHandle session,
    CC_MqttsnSessionAuthInfoReqCb cb,
    void* data);
 
void cc_mqttsn_gw_session_set_error_report_cb(
    CC_MqttsnSessionHandle session,
    CC_MqttsnSessionErrorReportCb cb,
    void* data);
 
void cc_mqttsn_gw_session_set_fwd_enc_session_created_cb(
    CC_MqttsnSessionHandle session,
    CC_MqttsnSessionFwdEncSessionCreatedCb cb,
    void* data);
 
void cc_mqttsn_gw_session_set_fwd_enc_session_deleted_cb(
    CC_MqttsnSessionHandle session,
    CC_MqttsnSessionFwdEncSessionDeletedCb cb,
    void* data);
 
void cc_mqttsn_gw_session_set_id(CC_MqttsnSessionHandle session, unsigned char id);
 
unsigned char cc_mqttsn_gw_session_get_id(CC_MqttsnSessionHandle session);
 
void cc_mqttsn_gw_session_set_retry_period(CC_MqttsnSessionHandle session, unsigned value);
 
unsigned cc_mqttsn_gw_session_get_retry_period(CC_MqttsnSessionHandle session);
 
void cc_mqttsn_gw_session_set_retry_count(CC_MqttsnSessionHandle session, unsigned value);
 
unsigned cc_mqttsn_gw_session_get_retry_count(CC_MqttsnSessionHandle session);
 
void cc_mqttsn_gw_session_set_sleeping_client_msg_limit(
    CC_MqttsnSessionHandle session,
    unsigned long long value);
 
unsigned long long cc_mqttsn_gw_session_get_sleeping_client_msg_limit(CC_MqttsnSessionHandle session);
 
void cc_mqttsn_gw_session_set_default_client_id(CC_MqttsnSessionHandle session, const char* clientId);
 
const char* cc_mqttsn_gw_session_get_default_client_id(CC_MqttsnSessionHandle session);
 
void cc_mqttsn_gw_session_set_pub_only_keep_alive(CC_MqttsnSessionHandle session, unsigned value);
 
unsigned cc_mqttsn_gw_session_get_pub_only_keep_alive(CC_MqttsnSessionHandle session);
 
bool cc_mqttsn_gw_session_start(CC_MqttsnSessionHandle session);
 
void cc_mqttsn_gw_session_stop(CC_MqttsnSessionHandle session);
 
void cc_mqttsn_gw_session_tick(CC_MqttsnSessionHandle session);
 
unsigned cc_mqttsn_gw_session_data_from_client(
    CC_MqttsnSessionHandle session,
    const unsigned char* buf,
    unsigned bufLen);
 
unsigned cc_mqttsn_gw_session_data_from_broker(
    CC_MqttsnSessionHandle session,
    const unsigned char* buf,
    unsigned bufLen);
 
void cc_mqttsn_gw_session_set_broker_connected(CC_MqttsnSessionHandle session, bool connected);
 
bool cc_mqttsn_gw_session_get_broker_connected(CC_MqttsnSessionHandle session);
 
bool cc_mqttsn_gw_session_add_predefined_topic(
    CC_MqttsnSessionHandle session,
    const char* topic,
    unsigned short topicId);
 
bool cc_mqttsn_gw_session_set_topic_id_alloc_range(
    CC_MqttsnSessionHandle session,
    unsigned short minTopicId,
    unsigned short maxTopicId);
 
/*===================== Config Object ======================*/
 
typedef struct
{
    const char* clientId; 
    const char* topic; 
    unsigned short topicId; 
} CC_MqttsnPredefinedTopicInfo;
 
typedef struct
{
    const char* clientId; 
    const char* username; 
    const char* password; 
} CC_MqttsnAuthInfo;
 
typedef enum
{
    CC_MqttsnClientConnectionType_Udp, 
    CC_MqttsnClientConnectionType_ValuesLimit 
} CC_MqttsnClientConnectionType;
 
typedef enum
{
    CC_MqttsnBrokerConnectionType_Tcp, 
    CC_MqttsnBrokerConnectionType_ValuesLimit 
} CC_MqttsnBrokerConnectionType;
 
struct CC_MqttsnConfig;
 
typedef struct CC_MqttsnConfig* CC_MqttsnConfigHandle;
 
CC_MqttsnConfigHandle cc_mqttsn_gw_config_alloc(void);
 
void cc_mqttsn_gw_config_free(CC_MqttsnConfigHandle config);
 
void cc_mqttsn_gw_config_parse(CC_MqttsnConfigHandle config, const char* str);
 
bool cc_mqttsn_gw_config_read(CC_MqttsnConfigHandle config, const char* filename);
 
unsigned char cc_mqttsn_gw_config_id(CC_MqttsnConfigHandle config);
 
unsigned short cc_mqttsn_gw_config_advertise_period(CC_MqttsnConfigHandle config);
 
unsigned cc_mqttsn_gw_config_retry_period(CC_MqttsnConfigHandle config);
 
unsigned cc_mqttsn_gw_config_retry_count(CC_MqttsnConfigHandle config);
 
const char* cc_mqttsn_gw_config_default_client_id(CC_MqttsnConfigHandle config);
 
unsigned cc_mqttsn_gw_config_pub_only_keep_alive(CC_MqttsnConfigHandle config);
 
unsigned cc_mqttsn_gw_config_sleeping_client_msg_limit(CC_MqttsnConfigHandle config);
 
unsigned cc_mqttsn_gw_config_available_predefined_topics(CC_MqttsnConfigHandle config);
 
unsigned cc_mqttsn_gw_config_get_predefined_topics(
    CC_MqttsnConfigHandle config,
    CC_MqttsnPredefinedTopicInfo* buf,
    unsigned bufLen);
 
unsigned cc_mqttsn_gw_config_available_auth_infos(CC_MqttsnConfigHandle config);
 
unsigned cc_mqttsn_gw_config_get_auth_infos(
    CC_MqttsnConfigHandle config,
    CC_MqttsnAuthInfo* buf,
    unsigned bufLen);
 
void cc_mqttsn_gw_config_topic_id_alloc_range(
    CC_MqttsnConfigHandle config,
    unsigned short* min,
    unsigned short* max);
 
const char* cc_mqttsn_gw_config_broker_address(CC_MqttsnConfigHandle config);
 
unsigned short cc_mqttsn_gw_config_broker_port(CC_MqttsnConfigHandle config);
 
const char* cc_mqttsn_gw_config_log_file(CC_MqttsnConfigHandle config);
 
CC_MqttsnClientConnectionType cc_mqttsn_gw_config_client_connection_type(CC_MqttsnConfigHandle config);
 
CC_MqttsnBrokerConnectionType cc_mqttsn_gw_config_broker_connection_type(CC_MqttsnConfigHandle config);
 
unsigned cc_mqttsn_gw_config_values_count(CC_MqttsnConfigHandle config, const char* key);
 
const char* cc_mqttsn_gw_config_get_value(CC_MqttsnConfigHandle config, const char* key, unsigned idx);
 
#ifdef __cplusplus
}
#endif