OpenConnectionOptions

Defined in: packages/engine/src/lib/agent-session/connection.ts:17

Server-owned context and clock for one connection. Never supplied to the Planner.

Properties

acknowledgementTimeoutMs?

readonly optional acknowledgementTimeoutMs?: number

Defined in: packages/engine/src/lib/agent-session/connection.ts:42

Maximum wait in milliseconds for the browser to acknowledge a UI change with ui_applied. Defaults to 30,000. Must be a positive integer no greater than 2,147,483,647, or opening the connection throws. When it elapses, the run finishes with code ui_ack_timeout, every queued utterance finishes as cancelled, and the next utterance plans against its own Chart.

---

capabilities?

readonly optional capabilities?: unknown

Defined in: packages/engine/src/lib/agent-session/connection.ts:25

Browser capability manifest, opaque until Client Tools are configured.

---

clock?

readonly optional clock?: () => number

Defined in: packages/engine/src/lib/agent-session/connection.ts:27

Monotonic millisecond clock for measuring run duration. Defaults to performance.now.

Returns

number

---

scheduleTimeout?

readonly optional scheduleTimeout?: (callback, ms) => () => void

Defined in: packages/engine/src/lib/agent-session/connection.ts:33

Schedules a callback after a delay in milliseconds and returns a function that cancels it. Agent Runs use it for their deadline. Defaults to globalThis.setTimeout, cancelled with globalThis.clearTimeout.

Calls callback once after ms milliseconds and returns a function that cancels the call when it has not happened yet.

Parameters

callback

() => void

ms

number

Returns

() => void

---

sessionId

readonly sessionId: SessionId

Defined in: packages/engine/src/lib/agent-session/connection.ts:19

Session the host authorized before opening this connection.

---

token?

readonly optional token?: string

Defined in: packages/engine/src/lib/agent-session/connection.ts:23

Optional application credential. Provider API keys do not belong here.

---

user

readonly user: unknown

Defined in: packages/engine/src/lib/agent-session/connection.ts:21

Host-authenticated principal, opaque to the UI-only route. Use null for anonymous applications.