Documentation / @agentick/gateway / TransportClient

Interface: TransportClient

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

A connected client from the transport's perspective.

Properties

id

readonly id: string

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

Unique client identifier

---

isConnected

readonly isConnected: boolean

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

Check if connected

---

state

readonly state: ClientState

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

Client state (auth, subscriptions, etc.)

Methods

close()

close(code?, reason?): void

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

Close the connection

Parameters

code?

number

reason?

string

Returns

void

---

isPressured()?

optional isPressured(): boolean

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

Check if the client is under write pressure (optional)

Returns

boolean

---

onDrain()?

optional onDrain(callback): void

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

Register a callback for when write pressure clears (optional). Paired with isPressured — without onDrain, buffered events during backpressure have no way to flush after the last push.

Parameters

callback

() => void

Returns

void

---

send()

send(message): void

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

Send a message to this client

Parameters

message

GatewayMessage

Returns

void