AS AgentScopeAPI 手册 / API Reference

ServiceManager

public abstract class ServiceManager implements AutoCloseable
源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:33–234

服务管理器,承载智能体的部署、调度与服务化运行。位于 io.agentscope.runtime.engine.shared 包,实现 AutoCloseable。核心成员包括 registerDefaultServices、register、registerService、start、stop、close。

Abstract base class for service managers Provides common functionality for service registration and lifecycle management

构造器摘要Constructor Summary

构造器Constructor说明Description
public ServiceManager()
初始化 `ServiceManager` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
protected abstract void registerDefaultServices()
abstract
注册默认服务。
Register default services for this manager, override in subclasses
public ServiceManager register(Class<? extends Service> serviceClass, String name, Object... args)
执行注册相关操作。
Register a service
public ServiceManager registerService(String name, Service service)
注册服务。
Register an instantiated service
public CompletableFuture<Void> start()
返回启动。
Start all registered services
public CompletableFuture<Void> stop()
返回停止。
Stop all services
public void close() throws Exception
关闭连接并释放相关资源。
Releases resources and connections.
public Service getService(String name)
获取服务。
Enable property access for services, e.g., manager.env, manager.session
public Service getService(String name, Service defaultService)
获取服务。
Explicitly retrieve service instance, supports default value
public boolean hasService(String name)
判断是否具有服务。
Check if service exists
public List<String> listServices()
列出服务。
List all registered service names
public Map<String, Service> getAllServices()
获取所有服务。
Retrieve all service instances
public CompletableFuture<Map<String, Boolean>> healthCheck()
检查健康状态状态的所有服务。
Check health status of all services

构造器详情Constructor Detail

ServiceManager

public ServiceManager()

初始化 ServiceManager 实例。

Creates a new instance.

源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:40–43

方法详情Method Detail

registerDefaultServices

protected abstract void registerDefaultServices()
abstract

注册默认服务。

Register default services for this manager, override in subclasses

源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:48

register

public ServiceManager register(Class<? extends Service> serviceClass, String name, Object... args)

执行注册相关操作。

Register a service

参数Parameters
名称Name类型Type说明Description
serviceClassClass<? extends Service>服务类到注册。The service class to register
nameString名称(类型 `String`)。Optional service name, defaults to class name with "Service" suffix removed and converted to lowercase
args varargsObject...参数(类型 `Object...`)。Positional arguments for service initialization
返回Returns ServiceManager
返回ServiceManager。this For method chaining
源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:58–71

registerService

public ServiceManager registerService(String name, Service service)

注册服务。

Register an instantiated service

参数Parameters
名称Name类型Type说明Description
nameString名称(类型 `String`)。Service name
serviceService服务(类型 `Service`)。Service instance
返回Returns ServiceManager
返回ServiceManager。this For method chaining
源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:80–87

start

public CompletableFuture<Void> start()

返回启动。

Start all registered services

返回Returns CompletableFuture<Void>
返回CompletableFuture。CompletableFuture Asynchronous startup result
源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:94–132

stop

public CompletableFuture<Void> stop()

返回停止。

Stop all services

返回Returns CompletableFuture<Void>
返回CompletableFuture。CompletableFuture Asynchronous stop result
源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:139–152

close

public void close() throws Exception

关闭连接并释放相关资源。

Releases resources and connections.

抛出Throws
  • Exception 可能抛出 `Exception`。Thrown when the operation cannot be completed.
源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:154–157

getService

public Service getService(String name)

获取服务。

Enable property access for services, e.g., manager.env, manager.session

参数Parameters
名称Name类型Type说明Description
nameString名称(类型 `String`)。The name.
返回Returns Service
返回服务。Returns service.
源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:162–168

getService

public Service getService(String name, Service defaultService)

获取服务。

Explicitly retrieve service instance, supports default value

参数Parameters
名称Name类型Type说明Description
nameString名称(类型 `String`)。The name.
defaultServiceService默认服务(类型 `Service`)。The default service.
返回Returns Service
返回服务。Returns service.
源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:173–175

hasService

public boolean hasService(String name)

判断是否具有服务。

Check if service exists

参数Parameters
名称Name类型Type说明Description
nameString名称(类型 `String`)。The name.
返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:180–182

listServices

public List<String> listServices()

列出服务。

List all registered service names

返回Returns List<String>
返回列出。Returns list.
源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:187–189

getAllServices

public Map<String, Service> getAllServices()

获取所有服务。

Retrieve all service instances

返回Returns Map<String, Service>
返回映射。Returns map.
源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:194–196

healthCheck

public CompletableFuture<Map<String, Boolean>> healthCheck()

检查健康状态状态的所有服务。

Check health status of all services

返回Returns CompletableFuture<Map<String, Boolean>>
返回CompletableFuture>。CompletableFuture > Asynchronous health check result
源码Source io/agentscope/runtime/engine/shared/ServiceManager.java:203–218
基于官方固定版本源码静态生成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.