message_broker.h

/*
 * @file message_broker.h
 *
 * @author Olivier Chauvineau
 *
 * @copyright Copyright (C) 2024 switstack <contact@switstack.io>
 */
 
#ifndef MOKA_MESSAGE_BROKER_H
#define MOKA_MESSAGE_BROKER_H
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ---------------------------------------------------------------------------------------------- *
 * Includes                                                                                       *
 * ---------------------------------------------------------------------------------------------- */
 
/* - System */
 
/* - Project */
#include "moka/util/common.h"
 
/* - Local */
 
/* -------------------------------------------------------------------------- *
 * Definitions                                                                *
 * -------------------------------------------------------------------------- */
 
#define MESSAGE_BROKER_LOG_ON 1
#define MESSAGE_BROKER_LOG_OFF 0
 
/* ---------------------------------------------------------------------------------------------- *
 * Declarations                                                                                   *
 * ---------------------------------------------------------------------------------------------- */
 
typedef struct moka_header {
    uint64_t timestamp;
    uint32_t msg_id;
    uint8_t src;
    uint32_t src_auth_token;
    uint8_t dst;
    uint16_t dst_fnct;
    uint16_t dst_srv_err;
    uint16_t dst_fnct_err;
} moka_header_t;
 
typedef struct moka_message {
    moka_header_t hdr;
    uint16_t payload_length;
    void* payload;
} moka_message_t;
 
typedef struct moka_service {
    char name[SERVICE_MAX_NAME_SIZE];
    moka_service_type_t type;
    moka_service_proxy_t proxy;
    moka_message_broker_t* message_broker;
} moka_service_t;
 
/* -------------------------------------------------------------------------- *
 * Public Primitives                                                          *
 * -------------------------------------------------------------------------- */
 
uint16_t
msg_brk_initialize(
    moka_message_broker_t* message_broker,
    moka_service_proxy_t* service_table,
    uint8_t max_services);
 
uint8_t
msg_brk_get_maximum_supported_service(void);
 
uint16_t
msg_brk_register_service(moka_service_t* service);
 
uint16_t
msg_brk_register_lists_of_services(moka_service_t* list_of_services, uint8_t number_of_services);
 
uint16_t
msg_brk_unregister_service(moka_service_t* service);
 
uint16_t
msg_brk_send(
    moka_message_broker_t* message_broker, moka_message_t* request, moka_message_t* response);
 
uint16_t
msg_brk_set_trace(moka_message_broker_t* message_broker, uint8_t on_off);
 
moka_bool_t
msg_brk_is_service_registered(
    const moka_message_broker_t* message_broker, moka_service_type_t type);
 
moka_bool_t
msg_brk_is_service_routed(const moka_message_broker_t* message_broker, moka_service_type_t type);
 
uint16_t
msg_brk_prepare_message(
    uint8_t source,
    uint8_t destination,
    uint16_t function,
    moka_message_t* request,
    const uint8_t* payload_in,
    uint16_t payload_in_length,
    moka_message_t* response,
    const uint8_t* payload_out,
    uint16_t payload_out_length);
 
uint16_t
msg_brk_setup_service(moka_service_t* service);
 
uint16_t
msg_brk_initialize_service(moka_service_t* service, const uint8_t* inbound, uint16_t in_length);
 
uint16_t
msg_brk_cleanup_service(moka_service_t* service);
 
uint16_t
msg_brk_release_service(moka_service_t* service);
 
moka_message_broker_t*
msg_brk_get_instance(moka_service_type_t type);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* MOKA_MESSAGE_BROKER_H */