AS AgentScopeAPI 手册 / API Reference

WebSocketConnection

public interface WebSocketConnection<T>
源码Source io/agentscope/core/model/transport/websocket/WebSocketConnection.java:81–151

WebSocket 连接。位于 io.agentscope.core.model.transport.websocket 包。核心成员包括 send、receive、close、isOpen、getCloseInfo。

WebSocket connection interface.

Represents an active WebSocket connection with send/receive capabilities. Uses generic type parameter to support different message formats:

  • WebSocketConnection<String> - Text protocol (JSON over WebSocket)

  • WebSocketConnection<byte[]> - Binary protocol

Error handling: All methods return Mono/Flux that propagate errors through Reactor's error channel. Errors are wrapped in WebSocketTransportException with connection context.

Logging: Implementations should log at appropriate levels:

  • INFO: Connection established/closed

  • DEBUG: Message send/receive operations

  • TRACE: Detailed message content (size, preview)

  • ERROR: Connection errors, send/receive failures

Usage example (text protocol):

`WebSocketTransport client = JdkWebSocketTransport.create();
client.connect(request, String.class)
.flatMapMany(connection -> {
// Send JSON message
connection.send("{\"type\":\"config\"}").subscribe();

// Receive JSON messages
return connection.receive();
})
.subscribe(
json -> handleMessage(json),
error -> handleError(error) // WebSocketTransportException with context
);
`

Usage example (binary protocol):

`client.connect(request, byte[].class)
.flatMapMany(connection -> {
// Send binary message
connection.send(binaryData).subscribe();

// Receive binary messages
return connection.receive();
})
.subscribe(
data -> handleBinaryMessage(data),
error -> handleError(error)
);
`

方法摘要Method Summary

方法Method说明Description
public Mono<Void> send(T data)
设置发送。
Send a message.
public Flux<T> receive()
返回接收。
Receive message stream.
public Mono<Void> close()
关闭连接并释放相关资源。
Close the connection.
public boolean isOpen()
检查if 连接是打开。
Check if connection is open.
public CloseInfo getCloseInfo()
获取关闭信息。
Get close information (if closed).

方法详情Method Detail

send

public Mono<Void> send(T data)

设置发送。

Send a message.

参数Parameters
名称Name类型Type说明Description
dataT数据(类型 `T`)。Message data (String or byte[])
返回Returns Mono<Void>
返回Mono。Mono that completes when send is done, or emits WebSocketTransportException on error
源码Source io/agentscope/core/model/transport/websocket/WebSocketConnection.java:98

receive

public Flux<T> receive()

返回接收。

Receive message stream.

返回Returns Flux<T>
返回Flux。Message stream (String or byte[])
源码Source io/agentscope/core/model/transport/websocket/WebSocketConnection.java:121

close

public Mono<Void> close()

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

Close the connection.

返回Returns Mono<Void>
返回Mono。Mono that completes when connection is closed
源码Source io/agentscope/core/model/transport/websocket/WebSocketConnection.java:136

isOpen

public boolean isOpen()

检查if 连接是打开。

Check if connection is open.

返回Returns boolean
返回布尔值,表示判断结果。true if connection is open
源码Source io/agentscope/core/model/transport/websocket/WebSocketConnection.java:143

getCloseInfo

public CloseInfo getCloseInfo()

获取关闭信息。

Get close information (if closed).

返回Returns CloseInfo
返回CloseInfo。Close info, or null if not closed
源码Source io/agentscope/core/model/transport/websocket/WebSocketConnection.java:150
基于官方固定版本源码静态生成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.