Documentation / @agentick/client / SSETransport

Class: SSETransport

Defined in: client/src/sse-transport.ts:55

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

Implements

• ClientTransport

Constructors

Constructor

new SSETransport(config): SSETransport

Defined in: client/src/sse-transport.ts:72

Parameters

config

SSETransportConfig

Returns

SSETransport

Accessors

connectionId

Get Signature

get connectionId(): string | undefined

Defined in: client/src/sse-transport.ts:90

Connection ID (if assigned by server)

Returns

string | undefined

Connection ID (if assigned by server)

Implementation of

ClientTransport.connectionId

---

state

Get Signature

get state(): TransportState

Defined in: client/src/sse-transport.ts:86

Current connection state

Returns

TransportState

Current connection state

Implementation of

ClientTransport.state

Methods

abortSession()

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

Defined in: client/src/sse-transport.ts:402

Abort a session's execution

Parameters

sessionId

string

reason?

string

Returns

Promise<void>

Implementation of

ClientTransport.abortSession

---

closeSession()

closeSession(sessionId): Promise<void>

Defined in: client/src/sse-transport.ts:420

Close a session

Parameters

sessionId

string

Returns

Promise<void>

Implementation of

ClientTransport.closeSession

---

connect()

connect(): Promise<void>

Defined in: client/src/sse-transport.ts:106

Connect to the server

Returns

Promise<void>

Implementation of

ClientTransport.connect

---

disconnect()

disconnect(): void

Defined in: client/src/sse-transport.ts:130

Disconnect from the server

Returns

void

Implementation of

ClientTransport.disconnect

---

onEvent()

onEvent(handler): () => void

Defined in: client/src/sse-transport.ts:509

Register event handler for incoming events

Parameters

handler

TransportEventHandler

Returns

(): void

Returns

void

Implementation of

ClientTransport.onEvent

---

onStateChange()

onStateChange(handler): () => void

Defined in: client/src/sse-transport.ts:516

Register state change handler

Parameters

handler

(state) => void

Returns

(): void

Returns

void

Implementation of

ClientTransport.onStateChange

---

publishToChannel()

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

Defined in: client/src/sse-transport.ts:462

Publish to a channel

Parameters

sessionId

string

channel

string

event

ChannelEvent

Returns

Promise<void>

Implementation of

ClientTransport.publishToChannel

---

send()

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

Defined in: client/src/sse-transport.ts:270

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

Parameters

input

SendInput

sessionId?

string

Returns

AsyncIterable<TransportEventData, any, any> & object

Implementation of

ClientTransport.send

---

submitToolResult()

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

Defined in: client/src/sse-transport.ts:440

Submit tool result

Parameters

sessionId

string

toolUseId

string

result

ToolConfirmationResponse

Returns

Promise<void>

Implementation of

ClientTransport.submitToolResult

---

subscribeToChannel()

subscribeToChannel(sessionId, channel): Promise<void>

Defined in: client/src/sse-transport.ts:487

Subscribe to a channel

Parameters

sessionId

string

channel

string

Returns

Promise<void>

Implementation of

ClientTransport.subscribeToChannel

---

subscribeToSession()

subscribeToSession(sessionId): Promise<void>

Defined in: client/src/sse-transport.ts:345

Subscribe to session events

Parameters

sessionId

string

Returns

Promise<void>

Implementation of

ClientTransport.subscribeToSession

---

unsubscribeFromSession()

unsubscribeFromSession(sessionId): Promise<void>

Defined in: client/src/sse-transport.ts:377

Unsubscribe from session events

Parameters

sessionId

string

Returns

Promise<void>

Implementation of

ClientTransport.unsubscribeFromSession