AS AgentScopeAPI 手册 / API Reference

OkHttpWebSocketTransport

public class OkHttpWebSocketTransport implements WebSocketTransport
源码Source io/agentscope/core/model/transport/websocket/OkHttpWebSocketTransport.java:76–333

Ok HTTP WebSocket 传输层,与模型服务通信并返回生成或向量化结果。位于 io.agentscope.core.model.transport.websocket 包,实现 WebSocketTransport。核心成员包括 create、connect、shutdown。

WebSocket client implementation based on OkHttp.

Features:

  • Mature and stable HTTP client library

  • Built-in ping/pong heartbeat (pingInterval)

  • Better connection pool management

  • Client instance is reusable

Usage example:

`WebSocketTransport client = OkHttpWebSocketTransport.create();

WebSocketRequest request = WebSocketRequest.builder("wss://api.example.com/ws")
.header("Authorization", "Bearer token")
.build();

client.connect(request, String.class)
.flatMapMany(conn -> {
conn.send("{\"type\":\"config\"}").subscribe();
return conn.receive();
})
.subscribe(data -> handle(data));
`

方法摘要Method Summary

方法Method说明Description
public static OkHttpWebSocketTransport create()
static
创建客户端使用默认配置。
Create a client with default configuration.
public static OkHttpWebSocketTransport create(OkHttpClient client)
static
创建客户端使用自定义 OkHttpClient。
Create a client with custom OkHttpClient.
public static OkHttpWebSocketTransport create(WebSocketTransportConfig config)
static
创建客户端使用自定义配置。
Create a client with custom configuration.
public T Mono<WebSocketConnection<T>> connect(WebSocketRequest request, Class<T> messageType)
建立连接并完成初始化。
Performs the connect operation.
public void shutdown()
关闭资源并释放连接。
Releases resources and connections.

方法详情Method Detail

create

public static OkHttpWebSocketTransport create()
static

创建客户端使用默认配置。

Create a client with default configuration.

返回Returns OkHttpWebSocketTransport
返回OkHttpWebSocketTransport。OkHttpWebSocketTransport instance
源码Source io/agentscope/core/model/transport/websocket/OkHttpWebSocketTransport.java:91–99

create

public static OkHttpWebSocketTransport create(OkHttpClient client)
static

创建客户端使用自定义 OkHttpClient。

Create a client with custom OkHttpClient.

参数Parameters
名称Name类型Type说明Description
clientOkHttpClient客户端(类型 `OkHttpClient`)。Custom OkHttpClient instance
返回Returns OkHttpWebSocketTransport
返回OkHttpWebSocketTransport。OkHttpWebSocketTransport instance
源码Source io/agentscope/core/model/transport/websocket/OkHttpWebSocketTransport.java:107–109

create

public static OkHttpWebSocketTransport create(WebSocketTransportConfig config)
static

创建客户端使用自定义配置。

Create a client with custom configuration.

参数Parameters
名称Name类型Type说明Description
configWebSocketTransportConfigWebSocket 客户端配置。the WebSocket client configuration
返回Returns OkHttpWebSocketTransport
返回OkHttpWebSocketTransport。OkHttpWebSocketTransport instance
源码Source io/agentscope/core/model/transport/websocket/OkHttpWebSocketTransport.java:119–121

connect

public T Mono<WebSocketConnection<T>> connect(WebSocketRequest request, Class<T> messageType)

建立连接并完成初始化。

Performs the connect operation.

参数Parameters
名称Name类型Type说明Description
requestWebSocketRequest请求(类型 `WebSocketRequest`)。The request.
messageTypeClass<T>消息类型(类型 `Class`)。The message type.
返回Returns Mono<WebSocketConnection<T>>
返回Mono>。Returns mono.
源码Source io/agentscope/core/model/transport/websocket/OkHttpWebSocketTransport.java:200–296

shutdown

public void shutdown()

关闭资源并释放连接。

Releases resources and connections.

源码Source io/agentscope/core/model/transport/websocket/OkHttpWebSocketTransport.java:298–303
基于官方固定版本源码静态生成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.