AS AgentScopeAPI 手册 / API Reference

WorkspaceMessageBus

public class WorkspaceMessageBus implements MessageBus
源码Source io/agentscope/harness/agent/bus/WorkspaceMessageBus.java:55–277

工作区消息总线,承载智能体的部署、调度与服务化运行。位于 io.agentscope.harness.agent.bus 包,实现 MessageBus。核心成员包括 queuePush、queueDrain、queueDelete、queuePeek、logAppend、logRead。

MessageBus implementation backed by AbstractFilesystem.

Works with any filesystem backend (local, remote, sandbox). Cross-process delivery only works when the filesystem backend is actually shared (for example a remote/KV-backed store); a pure local disk backend remains single-process.

Mode D (pub/sub) is degraded to polling: #subscribe returns a Flux that emits an empty signal every 3 seconds; #publish is a no-op.

File layout under busRoot:


{busRoot}/
queues/{key-hash}/
{entryId}.json — Mode A entries (drain = ls + read + delete)
logs/{key-hash}/
{entryId}.json — Mode C entries (append-only)

构造器摘要Constructor Summary

构造器Constructor说明Description
public WorkspaceMessageBus(AbstractFilesystem filesystem, String busRoot)
初始化 `WorkspaceMessageBus` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public Mono<String> queuePush(String key, Map<String, Object> payload)
执行队列推送相关操作。
Performs the queue push operation.
public Mono<List<BusEntry>> queueDrain(String key, int maxCount)
执行 `queueDrain` 方法。
Performs the queue drain operation.
public Mono<Void> queueDelete(String key)
设置队列删除。
Performs the queue delete operation.
public Mono<Boolean> queuePeek(String key)
设置该参数。
Performs the queue peek operation.
public Mono<String> logAppend(String key, Map<String, Object> payload, int maxLen)
执行日志追加相关操作。
Performs the log append operation.
public Mono<List<BusEntry>> logRead(String key, String since, int maxCount)
执行日志读取相关操作。
Performs the log read operation.
public Mono<Void> logTrim(String key)
设置日志裁剪。
Performs the log trim operation.
public Mono<Void> publish(String key, Map<String, Object> payload)
执行发布相关操作。
Performs the publish operation.
public Flux<Map<String, Object>> subscribe(String key)
设置订阅。
Performs the subscribe operation.

构造器详情Constructor Detail

WorkspaceMessageBus

public WorkspaceMessageBus(AbstractFilesystem filesystem, String busRoot)

初始化 WorkspaceMessageBus 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
filesystemAbstractFilesystem文件系统(类型 `AbstractFilesystem`)。any `AbstractFilesystem` implementation
busRootString总线根(类型 `String`)。absolute path within the filesystem for bus data (e.g. `"/bus"`)
源码Source io/agentscope/harness/agent/bus/WorkspaceMessageBus.java:69–72

方法详情Method Detail

queuePush

public Mono<String> queuePush(String key, Map<String, Object> payload)

执行队列推送相关操作。

Performs the queue push operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
payloadMap<String, Object>负载(类型 `Map`)。The payload.
返回Returns Mono<String>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/bus/WorkspaceMessageBus.java:76–88

queueDrain

public Mono<List<BusEntry>> queueDrain(String key, int maxCount)

执行 queueDrain 方法。

Performs the queue drain operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
maxCountint最大数量(类型 `int`)。The max count.
返回Returns Mono<List<BusEntry>>
返回Mono>。Returns mono.
源码Source io/agentscope/harness/agent/bus/WorkspaceMessageBus.java:90–130

queueDelete

public Mono<Void> queueDelete(String key)

设置队列删除。

Performs the queue delete operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
返回Returns Mono<Void>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/bus/WorkspaceMessageBus.java:132–135

queuePeek

public Mono<Boolean> queuePeek(String key)

设置该参数。

Performs the queue peek operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
返回Returns Mono<Boolean>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/bus/WorkspaceMessageBus.java:137–140

logAppend

public Mono<String> logAppend(String key, Map<String, Object> payload, int maxLen)

执行日志追加相关操作。

Performs the log append operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
payloadMap<String, Object>负载(类型 `Map`)。The payload.
maxLenint最大 Len(类型 `int`)。The max len.
返回Returns Mono<String>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/bus/WorkspaceMessageBus.java:144–166

logRead

public Mono<List<BusEntry>> logRead(String key, String since, int maxCount)

执行日志读取相关操作。

Performs the log read operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
sinceStringsince(类型 `String`)。The since.
maxCountint最大数量(类型 `int`)。The max count.
返回Returns Mono<List<BusEntry>>
返回Mono>。Returns mono.
源码Source io/agentscope/harness/agent/bus/WorkspaceMessageBus.java:168–203

logTrim

public Mono<Void> logTrim(String key)

设置日志裁剪。

Performs the log trim operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
返回Returns Mono<Void>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/bus/WorkspaceMessageBus.java:205–208

publish

public Mono<Void> publish(String key, Map<String, Object> payload)

执行发布相关操作。

Performs the publish operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
payloadMap<String, Object>负载(类型 `Map`)。The payload.
返回Returns Mono<Void>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/bus/WorkspaceMessageBus.java:212–215

subscribe

public Flux<Map<String, Object>> subscribe(String key)

设置订阅。

Performs the subscribe operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
返回Returns Flux<Map<String, Object>>
返回Flux>。Returns flux.
源码Source io/agentscope/harness/agent/bus/WorkspaceMessageBus.java:217–221

继承成员Inherited Members

基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.