AIDK API Reference / aidk-client / ChannelTransport
Interface: ChannelTransport ​
Defined in: packages/client/src/core/transport.ts:60
Base transport interface - all transports implement this
Methods ​
connect() ​
connect(): void;Defined in: packages/client/src/core/transport.ts:66
Connect to the transport
Returns ​
void
disconnect() ​
disconnect(): void;Defined in: packages/client/src/core/transport.ts:69
Disconnect from the transport
Returns ​
void
dispose() ​
dispose(): void;Defined in: packages/client/src/core/transport.ts:75
Dispose and cleanup all resources
Returns ​
void
getInfo() ​
getInfo(): TransportInfo;Defined in: packages/client/src/core/transport.ts:106
Get detailed connection info
Returns ​
getState() ​
getState(): TransportState;Defined in: packages/client/src/core/transport.ts:103
Get current connection state
Returns ​
isConnected() ​
isConnected(): boolean;Defined in: packages/client/src/core/transport.ts:109
Check if connected
Returns ​
boolean
onMessage() ​
onMessage(handler: (data: unknown) => void): () => void;Defined in: packages/client/src/core/transport.ts:85
Register a message handler.
Parameters ​
| Parameter | Type |
|---|---|
handler | (data: unknown) => void |
Returns ​
Unsubscribe function
(): void;Returns ​
void
reconnect() ​
reconnect(): void;Defined in: packages/client/src/core/transport.ts:72
Force reconnection
Returns ​
void
send() ​
send<T>(data: unknown): Promise<T>;Defined in: packages/client/src/core/transport.ts:96
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 Parameter | Default type |
|---|---|
T | unknown |
Parameters ​
| Parameter | Type |
|---|---|
data | unknown |
Returns ​
Promise<T>
Response from the send operation (e.g., HTTP response body)