Matrix653 事件标志

更新时间:
2023-11-16
下载文档

Matrix653 事件标志

本节将介绍 Matrix653 事件标志的使用。本节详细定义在 mx_event_flags.h 头文件中。

事件标志相关数据类型

类型描述
MX_EVENT_FLAGS_TYPE事件标志类型

MX_EVENT_FLAGS_TYPE

事件标志的数据类型为 MX_EVENT_FLAGS_TYPE,事件标志使用前需要定义,它可以是一个全局变量,也可以嵌入到其它数据类型当中(如结构体)作为一个成员变量。

typedef struct {
    MX_IPC_OBJECT_TYPE            ipc_object;
    MX_BITMAP_TYPE                *events_bitmap;
    MX_BITMAP_TYPE                *temp_bitmap;
} MX_EVENT_FLAGS_TYPE;
参数说明
ipc_objectIPC类对象
events_bitmap事件位图
temp_bitmap临时位图

事件标志相关 API

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

API描述
mx_event_flags_init初始化事件标志
mx_event_flags_post_bit将事件发送到事件标志
mx_event_flags_post_bitmap将事件位图发布到事件标志
mx_event_flags_wait_bitmap等待事件标志

mx_event_flags_init()

  • 描述 初始化事件标志

  • 函数原型

RETURN_CODE_TYPE mx_event_flags_init (
   MX_EVENT_FLAGS_TYPE       *event_flags,
   MX_SIZE_TYPE              nb_event,
   QUEUING_DISCIPLINE_TYPE   queuing_discipline);
  • 参数
输入/输出参数描述
[in]event_flags事件标志指针
[in]nb_event事件数
[in]queuing_discipline队列规则
  • 返回值 ERROR CODE

  • 注意事项

  • 示例

mx_event_flags_post_bit()

  • 描述 将事件发送到事件标志

  • 函数原型

RETURN_CODE_TYPE mx_event_flags_post_bit (
        MX_EVENT_FLAGS_TYPE     *event_flags,
        MX_BIT_INDEX_TYPE       event_bit_index);
  • 参数
输入/输出参数描述
[in]event_flags事件标志指针
[in]event_bit_index事件索引(1 ~ nb_event)
  • 返回值 ERROR CODE

  • 注意事项

  • 示例

mx_event_flags_post_bitmap()

  • 描述 将事件位图发布到事件标志

  • 函数原型

RETURN_CODE_TYPE mx_event_flags_post_bitmap (
        MX_EVENT_FLAGS_TYPE     *event_flags,
        const MX_BITMAP_TYPE    *events_bitmap);
  • 参数
输入/输出参数描述
[in]event_flags事件标志指针
[in]events_bitmap事件位图
  • 返回值 ERROR CODE

  • 注意事项

  • 示例

mx_event_flags_wait_bitmap()

  • 描述 等待事件标志

  • 函数原型

RETURN_CODE_TYPE mx_event_flags_wait_bitmap (
      MX_EVENT_FLAGS_TYPE   *event_flags,
      MX_SAFE_MUTEX_TYPE    *mutex,
      MX_BOOL               consume_event,
      const MX_BITMAP_TYPE  *events_bitmap,
      SYSTEM_TIME_TYPE      time_out,
      MX_BITMAP_TYPE        *recv_events_bitmap);
  • 参数
输入/输出参数描述
[in]event_flags事件标志指针
[in]mutex互斥锁指针
[in]consume_event如果成功,是否耗尽事件
[in]events_bitmap事件位图
[in]time_out超时
[in]recv_events_bitmap接收事件位图指针
  • 返回值 ERROR CODE

  • 注意事项

  • 示例

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