message hub

User_Code/module/software/message_hub/message_hub.c

@@ -0,0 +1,116 @@
+#include "message_hub.h"
+#include "stdlib.h"
+#include "string.h"
+#include "bsp_log.h"
+
+/* message_center是fake head node,是方便链表编写的技巧,这样就不需要处理链表头的特殊情况 */
+static Publisher_t message_hub = {
+        .topic_name = "Message_Manager",
+        .first_subs = NULL,
+        .next_topic_node = NULL};
+
+static void CheckName(char *name)
+{
+    if (strnlen(name, MAX_TOPIC_NAME_LEN + 1) >= MAX_TOPIC_NAME_LEN)
+    {
+        LOGERROR("EVENT NAME TOO LONG:%s", name);
+        while (1); // 进入这里说明话题名超出长度限制
+    }
+}
+
+static void CheckLen(uint8_t len1, uint8_t len2)
+{
+    if (len1 != len2)
+    {
+        LOGERROR("EVENT LEN NOT SAME:%d,%d", len1, len2);
+        while (1); // 进入这里说明相同话题的消息长度却不同
+    }
+}
+
+Publisher_t *PubRegister(char *name, uint8_t data_len)
+{
+    CheckName(name);
+    Publisher_t *node = &message_hub;
+    while (node->next_topic_node) // message_center会直接跳过,不需要特殊处理,这被称作dumb_head(编程技巧)
+    {
+        node = node->next_topic_node; // 切换到下一个发布者(话题)结点
+        if (strcmp(node->topic_name, name) == 0) // 如果已经注册了相同的话题,直接返回结点指针
+        {
+            CheckLen(data_len, node->data_len);
+            node->pub_registered_flag = 1;
+            return node;
+        }
+    } // 遍历完发现尚未创建name对应的话题
+    // 在链表尾部创建新的话题并初始化
+    node->next_topic_node = (Publisher_t *) malloc(sizeof(Publisher_t));
+    memset(node->next_topic_node, 0, sizeof(Publisher_t));
+    node->next_topic_node->data_len = data_len;
+    strcpy(node->next_topic_node->topic_name, name);
+    node->pub_registered_flag = 1;
+    return node->next_topic_node;
+}
+
+Subscriber_t *SubRegister(char *name, uint8_t data_len)
+{
+    Publisher_t *pub = PubRegister(name, data_len); // 查找或创建该话题的发布者
+    // 创建新的订阅者结点,申请内存,注意要memset因为新空间不一定是空的,可能有之前留存的垃圾值
+    Subscriber_t *ret = (Subscriber_t *) malloc(sizeof(Subscriber_t));
+    memset(ret, 0, sizeof(Subscriber_t));
+    // 对新建的Subscriber进行初始化
+    ret->data_len = data_len; // 设定数据长度
+    for (size_t i = 0; i < QUEUE_SIZE; ++i)
+    {
+        // 给消息队列的每一个元素分配空间,queue里保存的实际上是数据执指针,这样可以兼容不同的数据长度
+        ret->queue[i] = malloc(data_len);
+    }
+    // 如果是第一个订阅者,特殊处理一下,将first_subs指针指向新建的订阅者(详见文档)
+    if (pub->first_subs == NULL)
+    {
+        pub->first_subs = ret;
+        return ret;
+    }
+    // 若该话题已经有订阅者, 遍历订阅者链表,直到到达尾部
+    Subscriber_t *sub = pub->first_subs; // 作为iterator
+    while (sub->next_subs_queue) // 遍历订阅了该话题的订阅者链表
+    {
+        sub = sub->next_subs_queue; // 移动到下一个订阅者,遇到空指针停下,说明到了链表尾部
+    }
+    sub->next_subs_queue = ret; // 把刚刚创建的订阅者接上
+    return ret;
+}
+
+/* 如果队列为空,会返回0;成功获取数据,返回1;后续可以做更多的修改,比如剩余消息数目等 */
+uint8_t SubGetMessage(Subscriber_t *sub, void *data_ptr)
+{
+    if (sub->temp_size == 0)
+    {
+        return 0;
+    }
+    memcpy(data_ptr, sub->queue[sub->front_idx], sub->data_len);
+    sub->front_idx = (sub->front_idx++) % QUEUE_SIZE; // 队列头索引增加
+    sub->temp_size--; // pop一个数据,长度减1
+    return 1;
+}
+
+uint8_t PubPushMessage(Publisher_t *pub, void *data_ptr)
+{
+    static Subscriber_t *iter;
+    iter = pub->first_subs; // iter作为订阅者指针,遍历订阅该话题的所有订阅者;如果为空说明遍历结束
+    // 遍历订阅了当前话题的所有订阅者,依次填入最新消息
+    while (iter)
+    {
+        if (iter->temp_size == QUEUE_SIZE) // 如果队列已满,则需要删除最老的数据(头部),再填入
+        {
+            // 队列头索引前移动,相当于抛弃前一个位置的数据,被抛弃的位置稍后会被写入新的数据
+            iter->front_idx = (iter->front_idx + 1) % QUEUE_SIZE;
+            iter->temp_size--; // 相当于出队,size-1
+        }
+        // 将Pub的数据复制到队列的尾部(最新)
+        memcpy(iter->queue[iter->back_idx], data_ptr, pub->data_len);
+        iter->back_idx = (iter->back_idx + 1) % QUEUE_SIZE; // 队列尾部前移
+        iter->temp_size++; // 入队,size+1
+
+        iter = iter->next_subs_queue; // 访问下一个订阅者
+    }
+    return 1;
+}

User_Code/module/software/message_hub/message_hub.h

@@ -0,0 +1,85 @@
+/**
+* @file message_hub.h
+ * @author
+ * @brief 这是一个伪pubsub机制,仅对应用之间的通信进行了隔离
+ * @version 0.1
+ * @date 2022-11-30
+ *
+ * @copyright Copyright (c) 2022
+ *
+ */
+
+#ifndef PUBSUB_H
+#define PUBSUB_H
+
+#include "stdint.h"
+
+#define MAX_TOPIC_NAME_LEN 32 // 最大的话题名长度,每个话题都有字符串来命名
+#define MAX_TOPIC_COUNT 12    // 最多支持的话题数量
+#define QUEUE_SIZE 1
+
+typedef struct mqt
+{
+    /* 用数组模拟FIFO队列 */
+    void *queue[QUEUE_SIZE];
+    uint8_t data_len;
+    uint8_t front_idx;
+    uint8_t back_idx;
+    uint8_t temp_size; // 当前队列长度
+
+    /* 指向下一个订阅了相同的话题的订阅者的指针 */
+    struct mqt *next_subs_queue; // 使得发布者可以通过链表访问所有订阅了相同话题的订阅者
+} Subscriber_t;
+
+/**
+ * @brief 发布者类型.每个发布者拥有发布者实例,并且可以通过链表访问所有订阅了自己发布的话题的订阅者
+ *
+ */
+typedef struct ent
+{
+    /* 话题名称 */
+    char topic_name[MAX_TOPIC_NAME_LEN + 1]; // 1个字节用于存放字符串结束符 '\0'
+    uint8_t data_len; // 该话题的数据长度
+    /* 指向第一个订阅了该话题的订阅者,通过链表访问所有订阅者 */
+    Subscriber_t *first_subs;
+    /* 指向下一个Publisher的指针 */
+    struct ent *next_topic_node;
+    uint8_t pub_registered_flag; // 用于标记该发布者是否已经注册
+} Publisher_t;
+
+/**
+ * @brief 订阅name的话题消息
+ *
+ * @param name 话题名称
+ * @param data_len 消息长度,通过sizeof()获取
+ * @return Subscriber_t* 返回订阅者实例
+ */
+Subscriber_t *SubRegister(char *name, uint8_t data_len);
+
+/**
+ * @brief 注册成为消息发布者
+ *
+ * @param name 发布者发布的话题名称(话题)
+ * @return Publisher_t* 返回发布者实例
+ */
+Publisher_t *PubRegister(char *name, uint8_t data_len);
+
+/**
+ * @brief 获取消息
+ *
+ * @param sub 订阅者实例指针
+ * @param data_ptr 数据指针,接收的消息将会放到此处
+ * @return uint8_t 返回值为0说明没有新的消息(消息队列为空),为1说明获取到了新的消息
+ */
+uint8_t SubGetMessage(Subscriber_t *sub, void *data_ptr);
+
+/**
+ * @brief 发布者给所有订阅了话题的订阅者推送消息
+ *
+ * @param pub 发布者实例指针
+ * @param data_ptr 指向要发布的数据的指针
+ * @return uint8_t 新消息成功推送给几个订阅者
+ */
+uint8_t PubPushMessage(Publisher_t *pub, void *data_ptr);
+
+#endif // !PUBSUB_H