Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Check out our upcoming events and meetups! View events →
new AgentSocketServer<Creates the socket server for one actor instance. Construct one per instance, usually as a field of the class, and delegate the class’sTState>(actor:object,opts:AgentSocketServerOptions<TState>):AgentSocketServer<TState>
webSocket(ws, req) to attach.
import { Agent, type Env } from "@telnyx/edge-runtime";
import { AgentSocketServer, type AgentServerSocket } from "@telnyx/edge-runtime/agent-socket";
interface ConvState extends Record<string, unknown> {
status: string;
}
export class Conversation extends Agent<Env, ConvState> {
private desk = new AgentSocketServer<ConvState>(this, {
getState: () => this.getState(),
getMessages: () => this.messages.all(),
authorize: (token) => (token === undefined ? ["read"] : ["read", "rpc"]),
});
async webSocket(ws: AgentServerSocket, req: Request): Promise<void> {
await this.desk.attach(ws, req);
}
}
| Parameter | Type | Meaning |
|---|---|---|
actor | object | The instance whose @rpc() methods inbound call frames dispatch to, usually this. |
opts | AgentSocketServerOptions<TState> | How the server reads state and messages, and how it authorizes a connection. |
| Parameter | Meaning |
|---|---|
TState | The agent’s persistent state shape, as snapshotted and broadcast to clients. |
Was this page helpful?