Skip to content

AIDK API Reference / aidk-client / SSETransport

Class: SSETransport ​

Defined in: packages/client/src/core/sse-transport.ts:49

Base transport interface - all transports implement this

Implements ​

Constructors ​

Constructor ​

ts
new SSETransport(config: SSETransportConfig): SSETransport;

Defined in: packages/client/src/core/sse-transport.ts:75

Parameters ​

ParameterType
configSSETransportConfig

Returns ​

SSETransport

Methods ​

connect() ​

ts
connect(): void;

Defined in: packages/client/src/core/sse-transport.ts:93

Connect to the transport

Returns ​

void

Implementation of ​

ChannelTransport.connect


disconnect() ​

ts
disconnect(): void;

Defined in: packages/client/src/core/sse-transport.ts:98

Disconnect from the transport

Returns ​

void

Implementation of ​

ChannelTransport.disconnect


dispose() ​

ts
dispose(): void;

Defined in: packages/client/src/core/sse-transport.ts:111

Dispose and cleanup all resources

Returns ​

void

Implementation of ​

ChannelTransport.dispose


getInfo() ​

ts
getInfo(): TransportInfo;

Defined in: packages/client/src/core/sse-transport.ts:134

Get detailed connection info

Returns ​

TransportInfo

Implementation of ​

ChannelTransport.getInfo


getState() ​

ts
getState(): TransportState;

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

Get current connection state

Returns ​

TransportState

Implementation of ​

ChannelTransport.getState


isConnected() ​

ts
isConnected(): boolean;

Defined in: packages/client/src/core/sse-transport.ts:144

Check if connected

Returns ​

boolean

Implementation of ​

ChannelTransport.isConnected


onMessage() ​

ts
onMessage(handler: (data: unknown) => void): () => void;

Defined in: packages/client/src/core/sse-transport.ts:119

Register a message handler.

Parameters ​

ParameterType
handler(data: unknown) => void

Returns ​

Unsubscribe function

ts
(): void;
Returns ​

void

Implementation of ​

ChannelTransport.onMessage


reconnect() ​

ts
reconnect(): void;

Defined in: packages/client/src/core/sse-transport.ts:104

Force reconnection

Returns ​

void

Implementation of ​

ChannelTransport.reconnect


send() ​

ts
send<T>(data: unknown): Promise<T>;

Defined in: packages/client/src/core/sse-transport.ts:126

Send data through the transport. How this is implemented depends on the transport:

  • SSE: HTTP POST to configured endpoint
  • WebSocket: ws.send()
  • Polling: HTTP POST

Type Parameters ​

Type ParameterDefault type
Tunknown

Parameters ​

ParameterType
dataunknown

Returns ​

Promise<T>

Response from the send operation (e.g., HTTP response body)

Implementation of ​

ChannelTransport.send

Released under the MIT License.