主动拉取队列消息 - MessageQueuePull

函数简介

主动拉取一条消息，返回 JSON 字符串。

接口名称

MessageQueuePull

DLL调用

char* MessageQueuePull(int64_t instance, int64_t consumer, int32_t timeout_ms);

参数说明

参数名类型说明
instance长整数型OLA 实例句柄。
consumer长整数型消费者句柄（由 MessageQueueConsume 创建，且 on_message 可为 NULL）。
timeout_ms整数型超时策略：0=立即返回，>0=最多等待 N 毫秒，<0=无限等待。

返回 JSON 字段

  • topic(string)：队列名
  • is_text(int)：1=文本，0=二进制
  • ack_token(int64)：消息确认令牌，可用于 MessageQueueAck/Nack
  • data_len(int)：负载字节长度
  • data(string)：文本内容（仅 is_text=1）
  • data_hex(string)：二进制十六进制（仅 is_text=0）

示例

char* json = MessageQueuePull(instance, consumer, 1000);
if (json) {
    printf("%s\n", json);
    FreeStringPtr(instance, json);
}

返回值

JSON 字符串指针；无消息或失败返回 0。

注意事项

  • 返回值需调用 FreeStringPtr 释放。
Last Updated: