boaPHP开发手册v5.5

stomp类
版本 1.0+
命名空间 boa\mq\driver
文件 boa/mq/driver/stomp.php
说明 stomp消息队列驱动类,继承base类
配置
配置项 默认值 类型 说明
broker tcp://127.0.0.1:61613 string 消息中间件服务器,支持tcp, ssl等
username null string 认证用户
password null string 认证密码
headers [] array 附加请求头,如:client-id等
timeout 0 int 消费消息超时(秒),0=默认
queue /queue/boa string 发布/订阅的消息队列
目录
方法 说明
__construct() 初始化
session_id() 获取当前会话ID
publish() 发布消息
subscribe() 订阅消息
has() 判断是否有可消费消息
read() 消费消息
ack() 消息消费后反馈确认
unsubscribe() 取消订阅
head() 获取当前消费消息的头
方法

__construct()

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

session_id()

说明
获取当前会话ID
返回值
成功返回会话ID(string);失败返回false(bool)

publish()

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

subscribe()

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

has()

说明
判断是否有可消费消息
返回值
有返回true(bool);否则返回false(bool)

read()

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

ack()

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

unsubscribe()

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

head()

说明
获取当前消费消息的头
返回值
返回消息头(array)