rbc_util_frame.h

Go to the documentation of this file.

#ifndef RTE_EXAMPLE_RBC_UTIL_FRAME_H
#define RTE_EXAMPLE_RBC_UTIL_FRAME_H

 
#include <stdbool.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define RBC_UTIL_FRAME_SIZE     256U
#define RBC_UTIL_HEADER_SIZE    6U
#define RBC_UTIL_PAYLOAD_MAX    (RBC_UTIL_FRAME_SIZE - RBC_UTIL_HEADER_SIZE) /* 250 */

typedef enum
{
    RBC_UTIL_MSG_KEEPALIVE   = 0, 
    RBC_UTIL_MSG_HELLO       = 1, 
    RBC_UTIL_MSG_SUBSCRIBE   = 2, 
    RBC_UTIL_MSG_UNSUBSCRIBE = 3, 
    RBC_UTIL_MSG_PUBLISH     = 4, 
    RBC_UTIL_MSG_BYE         = 5  
} rbc_util_msg_type_t;

#define RBC_UTIL_TOPIC_STATUS  1U
#define RBC_UTIL_TOPIC_JRU_LOG 2U
#define RBC_UTIL_TOPIC_KM114_FILE 3U
#define RBC_UTIL_TOPIC_TAKEOVER_CONFIRM 4U

typedef enum
{
    RBC_UTIL_SRC_UNKNOWN   = 0,
    RBC_UTIL_SRC_A         = 1,
    RBC_UTIL_SRC_B         = 2,
    RBC_UTIL_SRC_GW_TRAIN  = 3,
    RBC_UTIL_SRC_GW_IL     = 4,
    RBC_UTIL_SRC_GW_CTC    = 5,
    RBC_UTIL_SRC_GW_STATUS = 6,
    RBC_UTIL_SRC_SIM_TRAIN = 7,
    RBC_UTIL_SRC_SIM_IL    = 8,
    RBC_UTIL_SRC_SIM_CTC   = 9
} rbc_util_source_t;

typedef struct
{
    rbc_util_msg_type_t msg_type;
    uint8_t             source_id;
    uint16_t            topic_id;
    uint8_t             seq;
    uint8_t             payload_len;
    char                payload_z[RBC_UTIL_PAYLOAD_MAX + 1U]; 
} rbc_util_frame_t;

static inline void rbc_util_frame_encode(uint8_t out[RBC_UTIL_FRAME_SIZE], rbc_util_msg_type_t msg_type,
                                          uint8_t source_id, uint16_t topic_id, uint8_t seq, const char *payload)
{
    size_t len = 0U;
 
    (void)memset(out, 0, RBC_UTIL_FRAME_SIZE);
    if (payload != NULL)
    {
        len = strlen(payload);
        if (len > (size_t)RBC_UTIL_PAYLOAD_MAX)
        {
            len = (size_t)RBC_UTIL_PAYLOAD_MAX;
        }
    }
    out[0] = (uint8_t)msg_type;
    out[1] = source_id;
    out[2] = (uint8_t)(topic_id & 0xFFU);
    out[3] = (uint8_t)((topic_id >> 8) & 0xFFU);
    out[4] = seq;
    out[5] = (uint8_t)len;
    if (len > 0U)
    {
        (void)memcpy(&out[RBC_UTIL_HEADER_SIZE], payload, len);
    }
}

static inline bool rbc_util_frame_decode(const uint8_t in[RBC_UTIL_FRAME_SIZE], rbc_util_frame_t *out)
{
    uint8_t plen;
 
    if ((in == NULL) || (out == NULL))
    {
        return false;
    }
    plen = in[5];
    if (plen > (uint8_t)RBC_UTIL_PAYLOAD_MAX)
    {
        return false;
    }
    out->msg_type    = (rbc_util_msg_type_t)in[0];
    out->source_id   = in[1];
    out->topic_id    = (uint16_t)((uint16_t)in[2] | ((uint16_t)in[3] << 8));
    out->seq         = in[4];
    out->payload_len = plen;
    if (plen > 0U)
    {
        (void)memcpy(out->payload_z, &in[RBC_UTIL_HEADER_SIZE], plen);
    }
    out->payload_z[plen] = '\0';
    return true;
}
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* RTE_EXAMPLE_RBC_UTIL_FRAME_H */