首页
/ hpfeeds 项目技术文档

hpfeeds 项目技术文档

2024-12-26 20:59:31作者:虞亚竹Luna

1. 安装指南

hpfeeds 是一个轻量级的认证发布-订阅协议,具有简单的线缆格式,使得用户几乎可以立即使用他们喜欢的语言订阅 feeds。以下是安装 hpfeeds 客户端和经纪人(broker)的步骤:

客户端安装

hpfeeds 核心客户端没有任何依赖项。您可以使用 pip 进行安装:

pip install hpfeeds

经纪人(Broker)安装

要安装经纪人(broker)的依赖项,您同样可以使用 pip

pip install hpfeeds[broker]

另外,您也可以使用 Docker 运行经纪人(broker):

docker run -p "0.0.0.0:20000:20000" -p "0.0.0.0:9431:9431" hpfeeds/hpfeeds-broker:latest

在容器中,访问密钥将存储在 /app/var 中的 sqlite 数据库中。容器中已经安装了 sqlite 客户端用于管理访问权限。请确保 /app/var 是一个卷。您的客户端可以连接到端口 20000,而 prometheus 可以连接到端口 9431

2. 项目的使用说明

hpfeeds 允许用户通过命令行界面订阅和发布信息。以下是基本的使用说明:

订阅频道

要订阅一个 hpfeeds 频道,使用以下命令:

hpfeeds subscribe --host localhost -p 10000 -i myident -s mysecret -c mychannel

这里 --host 是服务器地址,-p 是端口,-i 是您的标识符,-s 是您的密钥,-c 是您想要订阅的频道。

发布事件

要发布一个事件到一个 hpfeeds 频道,使用以下命令:

hpfeeds publish --host localhost -p 10000 -i myident -s mysecret -c mychannel '{"event": "ping"}'

在这个命令中,-c 参数指定了要发布的频道,后面的 JSON 字符串是您要发布的事件内容。

3. 项目API使用文档

hpfeeds 提供了 Python 3 兼容的 API,可以在您的应用程序中调用。以下是基本的使用示例:

订阅

from hpfeeds.client import FeedsClient

client = FeedsClient('localhost', 10000, 'myident', 'mysecret')
client.subscribe('mychannel', callback)

在这里,callback 是一个处理接收到的消息的函数。

发布

from hpfeeds.client import FeedsClient

client = FeedsClient('localhost', 10000, 'myident', 'mysecret')
client.publish('mychannel', 'event', {'event': 'ping'})

在这里,'mychannel' 是要发布的频道,'event' 是事件的类型,后面的字典是事件的数据。

4. 项目安装方式

项目可以通过两种主要方式进行安装:

  • 使用 pip 安装客户端或经纪人(broker)的依赖项。
  • 使用 Docker 运行经纪人(broker),如前所述。

确保按照上述步骤进行安装,以便正确设置和使用 hpfeeds

登录后查看全文
热门项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
202
2.17 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
61
94
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
977
575
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
550
83
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133