Expand description
wordval-foxglove:面向 wordval 框架的 Foxglove WebSocket 协议客户端, 用于将机器人数据流式接入 wordval 框架。
提供高弹性的 FoxgloveClient,以
foxglove.websocket.v1 协议
对接 foxglove-sdk WebSocket 服务端,特性包括:
- 高性能 — 全链路零拷贝
Bytes载荷;入站分发仅是一次 DashMap 查找 +try_send,绝不因慢消费者而阻塞 socket。 - 低内存 — 所有队列均有界(出站帧、每订阅通道、事件广播);
max_message_size/max_frame_size/max_write_buffer_size均显式配置。 - 高稳定 — 由监督任务持有连接生命周期,指数退避重连
(±25 % 抖动);订阅、客户端广播与 watch 在每次重连后自动重放;
断连时在途请求立即以
FoxgloveError::NotConnected快速失败。 - CDR / ROS 2 支持 —
cdr编码通道既可通用解码 (MessageData::decode_cdr,由广播的ros2msgschema 驱动), 也可解码为类型化的 serde 结构体(MessageData::decode_cdr_as); 发布通过PublishChannel::publish_cdr完成。
FoxglovePlugin(plugin feature,默认启用)实现了
wordval_core::Plugin 用于生命周期管理,
全局访问器(foxglove() / try_foxglove())遵循 wordval 单例模式
(可安全重启,与 wordval_nats::nats() 一致)。不使用 wordval 框架的
宿主可 default-features = false 只引入独立客户端 API。
§快速上手
ⓘ
use wordval_foxglove::{foxglove, FoxglovePlugin};
use wordval_core::PluginManager;
let mgr = PluginManager::new()
.add(FoxglovePlugin::new().with_url("ws://127.0.0.1:8765"));
mgr.start_all().await?;
// 订阅(等待主题被广播,重连后依然有效)
let mut sub = foxglove().subscribe_topic("/camera/image").await?;
while let Some(msg) = sub.recv().await {
println!("{}: {} bytes", msg.topic(), msg.payload().len());
}Re-exports§
pub use error::FoxgloveError;
Modules§
- cdr
- 面向
cdr编码通道的 CDR(OMG 通用数据表示)解码。 - error
- Foxglove 客户端错误。
- protocol
- Foxglove WebSocket 协议 v1(
foxglove.websocket.v1)消息定义与编解码器。
Structs§
- Channel
- 服务端(或本客户端)广播的通道。
- Client
Channel Spec - 客户端广播通道的规格描述。
- Client
Config - 客户端配置。
- Connection
Graph Update - 推送给已订阅客户端的连接图更新。
- Connection
Status - 可观察的连接状态,通过
watch传递。 - Foxglove
Client - Foxglove WebSocket 客户端。
- Foxglove
Plugin - 管理 foxglove 客户端连接生命周期的 Foxglove 插件。
- Message
Data - 投递给订阅者的单条通道消息。
- Parameter
- 单个参数条目。
- Publish
Channel - 客户端广播通道的句柄。
- Server
Info - 连接建立后立即发送的服务端信息。
- Service
- 服务端广播的服务。
- Service
Call FoxgloveClient::send_service_call返回的非阻塞调用句柄。- Service
Response - 成功服务调用的响应。
- Subscription
- 一个主题订阅。
- Traffic
Snapshot - 累计流量计数快照,见
FoxgloveClient::traffic。
Enums§
- CdrError
- 解码 CDR 载荷时产生的错误。
- CdrValue
- 通用解码出的 CDR 值。
- Connection
State - 连接生命周期状态。
- Foxglove
Event - 与具体请求无关的异步事件。
- Status
Level - 服务端状态消息的严重级别。
Constants§
- CAP_
ASSETS - 服务端能力:客户端可以获取资源(asset)。
- CAP_
CLIENT_ PUBLISH - 服务端能力:客户端可以广播通道并发布消息。
- CAP_
CONNECTION_ GRAPH - 服务端能力:客户端可以订阅连接图更新。
- CAP_
PARAMETERS - 服务端能力:客户端可以获取和设置参数。
- CAP_
PARAMETERS_ SUBSCRIBE - 服务端能力:客户端可以订阅参数变更。
- CAP_
SERVICES - 服务端能力:客户端可以调用服务。
- CAP_
TIME - 服务端能力:服务端可以发布二进制
ServerFrame::Time消息。 - SUBPROTOCOL
- 握手期间协商的 WebSocket 子协议(foxglove ws-protocol 规范)。
- SUBPROTOCOL_
SDK - foxglove-sdk(官方 SDK)服务端使用的子协议。
Functions§
- foxglove
- 返回全局
FoxgloveClient。 - try_
foxglove - 返回全局
FoxgloveClient的Some,未初始化时返回None。