Documentation / @agentick/client / ClientTransport

Interface: ClientTransport

Defined in: shared/src/transport.ts:40

Transport interface - abstracts SSE/HTTP vs WebSocket vs Local.

Extended by

• WSTransport

Properties

connectionId

readonly connectionId: string | undefined

Defined in: shared/src/transport.ts:45

Connection ID (if assigned by server)

---

state

readonly state: TransportState

Defined in: shared/src/transport.ts:42

Current connection state

Methods

abortSession()

abortSession(sessionId, reason?): Promise<void>

Defined in: shared/src/transport.ts:72

Abort a session's execution

Parameters

sessionId

string

reason?

string

Returns

Promise<void>

---

closeSession()

closeSession(sessionId): Promise<void>

Defined in: shared/src/transport.ts:75

Close a session

Parameters

sessionId

string

Returns

Promise<void>

---

connect()

connect(): Promise<void>

Defined in: shared/src/transport.ts:48

Connect to the server

Returns

Promise<void>

---

disconnect()

disconnect(): void

Defined in: shared/src/transport.ts:51

Disconnect from the server

Returns

void

---

dispatch()?

optional dispatch(sessionId, name, input): Promise<ContentBlock[]>

Defined in: shared/src/transport.ts:91

Dispatch a tool by name. Optional — not all transports support this.

Parameters

sessionId

string

name

string

input

Record<string, unknown>

Returns

Promise<ContentBlock[]>

---

onEvent()

onEvent(handler): () => void

Defined in: shared/src/transport.ts:98

Register event handler for incoming events

Parameters

handler

TransportEventHandler

Returns

(): void

Returns

void

---

onStateChange()

onStateChange(handler): () => void

Defined in: shared/src/transport.ts:101

Register state change handler

Parameters

handler

(state) => void

Returns

(): void

Returns

void

---

publishToChannel()

publishToChannel(sessionId, channel, event): Promise<void>

Defined in: shared/src/transport.ts:85

Publish to a channel

Parameters

sessionId

string

channel

string

event

ChannelEvent

Returns

Promise<void>

---

send()

send(input, sessionId?): AsyncIterable<TransportEventData, any, any> & object

Defined in: shared/src/transport.ts:57

Send a message and return a stream of events. Returns an async iterator of events for this execution.

Parameters

input

SendInput

sessionId?

string

Returns

---

submitToolResult()

submitToolResult(sessionId, toolUseId, result): Promise<void>

Defined in: shared/src/transport.ts:78

Submit tool result

Parameters

sessionId

string

toolUseId

string

result

ToolConfirmationResponse

Returns

Promise<void>

---

subscribeToChannel()

subscribeToChannel(sessionId, channel): Promise<void>

Defined in: shared/src/transport.ts:88

Subscribe to a channel

Parameters

sessionId

string

channel

string

Returns

Promise<void>

---

subscribeToSession()

subscribeToSession(sessionId): Promise<void>

Defined in: shared/src/transport.ts:66

Subscribe to session events

Parameters

sessionId

string

Returns

Promise<void>

---

unsubscribeFromSession()

unsubscribeFromSession(sessionId): Promise<void>

Defined in: shared/src/transport.ts:69

Unsubscribe from session events

Parameters

sessionId

string

Returns

Promise<void>