broker_api.h

Go to the documentation of this file.

/*
    MIT License
 
    Copyright (c) 2025 Robin A. Onsay
 
    Permission is hereby granted, free of charge, to any person obtaining
    a copy of this software and associated documentation files
    (the "Software"), to deal in the Software without restriction,
    including without limitation the rights to use, copy, modify, merge,
    publish, distribute, sublicense, and/or sell copies of the Software,
    and to permit persons to whom the Software is furnished to do so,
    subject to the following conditions:
 
    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.
*/
 
// @{"req": ["REQ-SB-013"]}
#ifndef JUNO_SB_API_H
#define JUNO_SB_API_H
#include "juno/ds/array_api.h"
#include "juno/macros.h"
#include "juno/memory/pointer_api.h"
#include "juno/status.h"
#include "juno/module.h"
#include "juno/ds/queue_api.h"
#include <stddef.h>
#include <stdint.h>
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct JUNO_SB_BROKER_ROOT_TAG JUNO_SB_BROKER_ROOT_T;
typedef struct JUNO_SB_BROKER_API_TAG JUNO_SB_BROKER_API_T;
typedef struct JUNO_SB_PIPE_TAG JUNO_SB_PIPE_T;
typedef uint32_t JUNO_SB_MID_T;
 
// @{"req": ["REQ-SB-004"]}
struct JUNO_SB_PIPE_TAG JUNO_MODULE_DERIVE(JUNO_DS_QUEUE_ROOT_T,
    JUNO_SB_MID_T iMsgId;
);
 
// @{"req": ["REQ-SB-001"]}
struct JUNO_SB_BROKER_ROOT_TAG JUNO_MODULE_ROOT(JUNO_SB_BROKER_API_T,
    JUNO_SB_PIPE_T **ptPipeRegistry;
    size_t zRegistryLength;
    size_t zRegistryCapacity;
);
 
// @{"req": ["REQ-SB-002"]}
struct JUNO_SB_BROKER_API_TAG
{
    JUNO_STATUS_T (*Publish)(JUNO_SB_BROKER_ROOT_T *ptBroker, JUNO_SB_MID_T tMid, JUNO_POINTER_T tMsg);
    JUNO_STATUS_T (*RegisterSubscriber)(JUNO_SB_BROKER_ROOT_T *ptBroker, JUNO_SB_PIPE_T *ptPipe);
};
 
static inline JUNO_STATUS_T JunoSb_BrokerApiVerify(const JUNO_SB_BROKER_API_T *ptBrokerApi)
{
    JUNO_ASSERT_EXISTS(
        ptBrokerApi &&
        ptBrokerApi->Publish &&
        ptBrokerApi->RegisterSubscriber
    );
    return JUNO_STATUS_SUCCESS;
}
 
// @{"req": ["REQ-SB-010", "REQ-SB-011"]}
static inline JUNO_STATUS_T JunoSb_BrokerVerify(const JUNO_SB_BROKER_ROOT_T *ptBroker)
{
    JUNO_STATUS_T tStatus = JUNO_STATUS_SUCCESS;
    JUNO_ASSERT_EXISTS(ptBroker);
    tStatus = JunoSb_BrokerApiVerify(ptBroker->ptApi);
    JUNO_ASSERT_SUCCESS(tStatus, return tStatus);
    JUNO_ASSERT_EXISTS(ptBroker->ptPipeRegistry && ptBroker->zRegistryCapacity);
    return tStatus;
}
 
// @{"req": ["REQ-SB-012"]}
static inline JUNO_STATUS_T JunoSb_PipeVerify(const JUNO_SB_PIPE_T *ptPipe)
{
    JUNO_ASSERT_EXISTS(ptPipe);
    JUNO_STATUS_T tStatus = JunoDs_QueueVerify(&ptPipe->tRoot);
    JUNO_ASSERT_SUCCESS(tStatus, return tStatus);
    return tStatus;
}
 
JUNO_STATUS_T JunoSb_BrokerInit(JUNO_SB_BROKER_ROOT_T *ptBroker, JUNO_SB_PIPE_T **ptPipeRegistry, size_t iRegistryCapacity, JUNO_FAILURE_HANDLER_T pfcnFailureHdlr, JUNO_USER_DATA_T *pvFailureUserData);
 
// @{"req": ["REQ-SB-005"]}
static inline JUNO_STATUS_T JunoSb_PipeInit(JUNO_SB_PIPE_T *ptPipe, JUNO_SB_MID_T iMid, JUNO_DS_ARRAY_ROOT_T *ptArray, JUNO_FAILURE_HANDLER_T pfcnFailureHandler, JUNO_USER_DATA_T *pvUserData)
{
    JUNO_ASSERT_EXISTS(ptPipe);
    ptPipe->iMsgId = iMid;
    return JunoDs_QueueInit(&ptPipe->tRoot, ptArray, pfcnFailureHandler, pvUserData);
}
 
#ifdef __cplusplus
}
#endif
#endif // JUNO_SB_API_H