Matrix653 队列

更新时间:
2023-12-14
下载文档

Matrix653 队列

本节将介绍 Matrix653 队列的使用。本节详细定义在 mx_queue.h 头文件中。

队列相关数据类型

类型描述
MX_QUEUE_TYPE队列类型

MX_QUEUE_TYPE

typedef struct {
    MX_UINT32                       length;
    MX_UINT32                       size;
    MX_UINT32                       element_size;
    MX_UINT32                       in;
    MX_UINT32                       out;
    MX_UINT8                        *array;
} MX_QUEUE_TYPE;
参数说明
length长度
size大小
element_size元素大小
in输入
out输出
array数组

事件标志相关 API

下表展示了事件标志相关的 API:

API描述
mx_queue_create创建队列
mx_queue_length获取队列中元素的个数
mx_queue_size获取队列的深度
mx_queue_clear清理队列
mx_queue_is_empty确定指定队列是否为空
mx_queue_is_full确定指定的队列是否已满
mx_queue_put将一个元素放入队列
mx_queue_get从队列中获取一个元素

mx_queue_create()

  • 描述 创建队列

  • 函数原型

MX_QUEUE_TYPE *mx_queue_create (
               MX_UINT32       size,
               MX_UINT32       element_size);
  • 参数
输入/输出参数描述
[in]size大小
[in]element_size元素大小
  • 返回值 成功返回队列指针,失败返回 MX_NULL

  • 注意事项

  • 示例

mx_queue_length()

  • 描述 获取队列中元素的个数

  • 函数原型

MX_UINT32 mx_queue_length (MX_QUEUE_TYPE *queue);
  • 参数
输入/输出参数描述
[in]queue队列指针
  • 返回值 队列中元素的个数

  • 注意事项

  • 示例

mx_queue_size()

  • 描述 获取队列的深度

  • 函数原型

MX_UINT32 mx_queue_size (MX_QUEUE_TYPE  *queue);
  • 参数
输入/输出参数描述
[in]queue队列指针
  • 返回值 队列的深度

  • 注意事项

  • 示例

mx_queue_clear()

  • 描述 清理队列

  • 函数原型

void mx_queue_clear (MX_QUEUE_TYPE  *queue);
  • 参数
输入/输出参数描述
[in]queue队列指针
  • 返回值

  • 注意事项

  • 示例

mx_queue_is_empty()

  • 描述 确定指定队列是否为空

  • 函数原型

MX_BOOL mx_queue_is_empty (
          MX_QUEUE_TYPE          *queue);
  • 参数
输入/输出参数描述
[in]queue队列指针
  • 返回值 MX_TRUE: empty, MX_FALSE: no empty

  • 注意事项

  • 示例

mx_queue_is_full()

  • 描述 确定指定的队列是否已满

  • 函数原型

MX_BOOL mx_queue_is_full (
          MX_QUEUE_TYPE          *queue);
  • 参数
输入/输出参数描述
[in]queue队列指针
  • 返回值 MX_TRUE: full, MX_FALSE: no full

  • 注意事项

  • 示例

mx_queue_put()

  • 描述 将一个元素放入队列

  • 函数原型

MX_BOOL mx_queue_put (
        MX_QUEUE_TYPE   *queue,
        void            *element);
  • 参数
输入/输出参数描述
[in]queue队列指针
[in]element元素指针
  • 返回值 MX_TRUE: success, MX_FALSE: failed

  • 注意事项

  • 示例

mx_queue_get()

  • 描述 从队列中获取一个元素

  • 函数原型

MX_BOOL mx_queue_get (
        MX_QUEUE_TYPE   *queue,
        void            *element);
  • 参数
输入/输出参数描述
[in]queue队列指针
[in]element元素指针
  • 返回值 MX_TRUE: success, MX_FALSE: failed

  • 注意事项

  • 示例

文档内容是否对您有所帮助?
有帮助
没帮助