udp_msg_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.
*/
 
#ifndef UDP_MSG_API_H
#define UDP_MSG_API_H
 
#include "udp_api.h"
#include "juno/ds/array_api.h"
#include "juno/memory/pointer_api.h"
#include "juno/sb/broker_api.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* --------------------------------------------------------------------------
 * Constants
 * -------------------------------------------------------------------------- */
 
#define UDPTH_PIPE_CAPACITY  8u
 
#define UDPTH_MSG_MID  ((JUNO_SB_MID_T)1u)
 
/* --------------------------------------------------------------------------
 * UDPTH_MSG_ARRAY_T — concrete array for pipe queue backing storage
 * -------------------------------------------------------------------------- */
 
struct UDPTH_MSG_ARRAY_TAG JUNO_MODULE_DERIVE(JUNO_DS_ARRAY_ROOT_T,
    UDP_THREAD_MSG_T atBuffer[UDPTH_PIPE_CAPACITY];
);
typedef struct UDPTH_MSG_ARRAY_TAG UDPTH_MSG_ARRAY_T;
 
/* --------------------------------------------------------------------------
 * Globals
 * -------------------------------------------------------------------------- */
 
extern const JUNO_POINTER_API_T g_udpThreadMsgPointerApi;
 
extern const JUNO_DS_ARRAY_API_T g_udpThreadMsgArrayApi;
 
/* --------------------------------------------------------------------------
 * Macros and helpers
 * -------------------------------------------------------------------------- */
 
#define UdpThreadMsg_PointerInit(addr) \
    JunoMemory_PointerInit(&g_udpThreadMsgPointerApi, UDP_THREAD_MSG_T, (addr))
 
static inline JUNO_STATUS_T UdpThreadMsgArray_Init(
    UDPTH_MSG_ARRAY_T *ptArr,
    JUNO_FAILURE_HANDLER_T pfcnHandler,
    JUNO_USER_DATA_T *pvUserData)
{
    return JunoDs_ArrayInit(&ptArr->tRoot, &g_udpThreadMsgArrayApi,
                            UDPTH_PIPE_CAPACITY, pfcnHandler, pvUserData);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* UDP_MSG_API_H */