Documentation / @agentick/gateway / Transport

Interface: Transport

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

Transport interface - abstracts WebSocket vs HTTP/SSE.

Properties

clientCount

readonly clientCount: number

Defined in: gateway/src/transport.ts:117

Number of connected clients

---

type

readonly type: TransportType

Defined in: gateway/src/transport.ts:93

Transport type identifier

Methods

broadcast()

broadcast(message): void

Defined in: gateway/src/transport.ts:114

Broadcast to all authenticated clients

Parameters

message

GatewayMessage

Returns

void

---

getAuthenticatedClients()

getAuthenticatedClients(): TransportClient[]

Defined in: gateway/src/transport.ts:111

Get authenticated clients

Returns

TransportClient[]

---

getClient()

getClient(id): TransportClient | undefined

Defined in: gateway/src/transport.ts:105

Get a client by ID

Parameters

id

string

Returns

TransportClient | undefined

---

getClients()

getClients(): TransportClient[]

Defined in: gateway/src/transport.ts:108

Get all connected clients

Returns

TransportClient[]

---

on()

on<K>(event, handler): void

Defined in: gateway/src/transport.ts:102

Register event handlers

Type Parameters

K

K extends keyof TransportEvents

Parameters

event

K

handler

TransportEvents[K]

Returns

void

---

start()

start(): Promise<void>

Defined in: gateway/src/transport.ts:96

Start the transport server

Returns

Promise<void>

---

stop()

stop(): Promise<void>

Defined in: gateway/src/transport.ts:99

Stop the transport server

Returns

Promise<void>