boaPHP开发手册v5.5

mq类
版本 1.0+
命名空间 boa
文件 boa/mq.php
说明 消息队列类,配置:'MQ' => [],
配置
配置项 默认值 类型 说明
driver stomp string 消息队列驱动;可选值:stomp, zeromq
目录
方法 说明
__construct() 初始化
cfg() 获取或设置配置信息
publish() 发布消息
subscribe() 订阅消息
read() 消费消息
ack() 消息消费后反馈确认
unsubscribe() 取消订阅
obj() 获取驱动对象,当驱动功能有差异时,可以直接访问驱动功能
方法

__construct()

说明
初始化
参数 必须 默认值 类型 说明
$cfg [] array 配置数据
示例
$mq = boa::mq()

cfg()

说明
获取或设置配置信息
参数 必须 默认值 类型 说明
$k null string
$v null string
返回值
同 base 类
示例
$mq->cfg('broker', '...')

publish()

说明
发布消息
参数 必须 默认值 类型 说明
$msg Y mixed 消息,支持所有类型
返回值
成功返回true(bool);失败返回false(bool)
示例
$mq->publish('boaPHP is so easy')

subscribe()

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

read()

说明
消费消息
返回值
返回消息正文(mixed),出错产生error日志
示例
$body = $mq->read()

ack()

说明
消息消费后反馈确认
返回值
成功返回true(bool);失败返回false(bool)
示例
$mq->ack()

unsubscribe()

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

obj()

说明
获取驱动对象,当驱动功能有差异时,可以直接访问驱动功能
返回值
返回驱动对象(object)
示例
$sid = $mq->obj()->session_id(); // 只有stomp驱动有此方法