boa框架开发手册v5.2

mq类
版本 1.0+
命名空间 boa
文件 boa/mq.php
说明 消息队列类,配置:'MQ' => [],
配置
配置项 默认值 类型 说明
driver stomp string 消息队列驱动;可选值:stomp, zeromq
目录
方法 说明
__construct() 初始化
cfg() 获取或设置配置信息
publish() 发布消息
subscribe() 订阅消息
read() 消费消息
ack() 消息消费后反馈确认
unsubscribe() 取消订阅
__call() 魔术方法,映射到消息队列驱动中的方法
方法

__construct()

说明
初始化
参数 必须 默认值 类型 说明
$cfg [] array 配置数据

cfg()

说明
获取或设置配置信息
参数 必须 默认值 类型 说明
$k null string
$v null string
返回值
如果设定$k和$v:则设置配置中$k项,返回$this(object);
如果只设定$k:则返回配置中$k值(string);
如果都未设定:则返回整个配置数据(array);

publish()

说明
发布消息
参数 必须 默认值 类型 说明
$msg Y mixed 消息,支持所有类型
返回值
成功返回true(bool);失败返回false(bool)

subscribe()

说明
订阅消息
参数 必须 默认值 类型 说明
$queue null string 消息队列,默认取配置queue
返回值
成功返回true(bool);失败返回false(bool)

read()

说明
消费消息
返回值
返回消息正文(mixed),出错产生error日志

ack()

说明
消息消费后反馈确认
返回值
成功返回true(bool);失败返回false(bool)

unsubscribe()

说明
取消订阅
参数 必须 默认值 类型 说明
$queue null string 消息队列,默认取配置queue
返回值
成功返回true(bool);失败返回false(bool)

__call()

说明
魔术方法,映射到消息队列驱动中的方法
参数 必须 默认值 类型 说明
$method Y string 驱动中的方法
$args mixed 方法对应参数
返回值
返回执行结果(mixed)