udp_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 JUNO_UDP_API_H
#define JUNO_UDP_API_H
 
#include <stdint.h>
#include <stdbool.h>
#include "juno/status.h"
#include "juno/module.h"
#include "juno/types.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* --------------------------------------------------------------------------
 * Forward declarations
 * -------------------------------------------------------------------------- */
 
typedef struct JUNO_UDP_API_TAG   JUNO_UDP_API_T;
 
typedef struct JUNO_UDP_ROOT_TAG  JUNO_UDP_ROOT_T;
 
typedef struct JUNO_UDP_LINUX_TAG JUNO_UDP_LINUX_T;
 
typedef union  JUNO_UDP_TAG       JUNO_UDP_T;
 
/* --------------------------------------------------------------------------
 * UDP_THREAD_MSG_T — fixed-size datagram message
 * -------------------------------------------------------------------------- */
 
// @{"req": ["REQ-UDP-018"]}
typedef struct UDP_THREAD_MSG_TAG
{
    uint32_t uSeqNum;
    uint32_t uTimestampSec;
    uint32_t uTimestampSubSec;
    uint8_t  arrPayload[64];
} UDP_THREAD_MSG_T;
 
/* --------------------------------------------------------------------------
 * JUNO_UDP_CFG_T — socket configuration
 * -------------------------------------------------------------------------- */
 
// @{"req": ["REQ-UDP-017"]}
typedef struct JUNO_UDP_CFG_TAG
{
    const char *pcAddress;
    uint16_t    uPort;
    bool        bIsReceiver;
} JUNO_UDP_CFG_T;
 
/* --------------------------------------------------------------------------
 * JUNO_UDP_API_T — vtable
 * -------------------------------------------------------------------------- */
 
// @{"req": ["REQ-UDP-002"]}
struct JUNO_UDP_API_TAG
{
    JUNO_STATUS_T (*Send)   (JUNO_UDP_ROOT_T *ptRoot, const UDP_THREAD_MSG_T *ptMsg);
 
    JUNO_STATUS_T (*Receive)(JUNO_UDP_ROOT_T *ptRoot, UDP_THREAD_MSG_T *ptMsg);
 
    JUNO_STATUS_T (*Free)   (JUNO_UDP_ROOT_T *ptRoot);
};
 
/* --------------------------------------------------------------------------
 * JUNO_UDP_ROOT_T — module root (freestanding)
 * -------------------------------------------------------------------------- */
 
// @{"req": ["REQ-UDP-001", "REQ-UDP-010", "REQ-UDP-011"]}
struct JUNO_UDP_ROOT_TAG JUNO_MODULE_ROOT(JUNO_UDP_API_T, JUNO_MODULE_EMPTY);
typedef struct JUNO_UDP_ROOT_TAG JUNO_UDP_ROOT_T;
 
/* --------------------------------------------------------------------------
 * JUNO_UDP_T — module union
 * -------------------------------------------------------------------------- */
 
/* Full union definition lives in udp_linux.h — see JUNO_UDP_T forward typedef above. */
 
/* --------------------------------------------------------------------------
 * Public function declarations
 * -------------------------------------------------------------------------- */
 
// @{"req": ["REQ-UDP-016"]}
JUNO_STATUS_T JunoUdp_Init(
    JUNO_UDP_ROOT_T        *ptRoot,
    const JUNO_UDP_API_T   *ptApi,
    JUNO_FAILURE_HANDLER_T  pfcnFailureHandler,
    void                   *pvFailureUserData
);
 
#ifdef __cplusplus
}
#endif
 
#endif /* JUNO_UDP_API_H */