Documentation / @agentick/gateway / LocalGatewayTransport

Class: LocalGatewayTransport

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

Server-side transport that manages local in-process clients. Registered with the gateway so local clients participate in event broadcasting via sendToSubscribers.

Extends

• BaseTransport

Constructors

Constructor

new LocalGatewayTransport(): LocalGatewayTransport

Defined in: gateway/src/local-transport.ts:120

Returns

LocalGatewayTransport

Overrides

BaseTransport.constructor

Properties

type

readonly type: "local"

Defined in: gateway/src/local-transport.ts:118

Transport type - must be set by subclass

Overrides

BaseTransport.type

Accessors

clientCount

Get Signature

get clientCount(): number

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

Number of connected clients

Returns

number

Number of connected clients

Inherited from

BaseTransport.clientCount

Methods

broadcast()

broadcast(message): void

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

Broadcast to all authenticated clients

Parameters

message

GatewayMessage

Returns

void

Inherited from

BaseTransport.broadcast

---

createClientTransport()

createClientTransport(gateway): ClientTransport

Defined in: gateway/src/local-transport.ts:140

Create a new local client and return a ClientTransport for use with createClient().

Parameters

gateway

Gateway

Returns

ClientTransport

---

getAuthenticatedClients()

getAuthenticatedClients(): TransportClient[]

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

Get authenticated clients

Returns

TransportClient[]

Inherited from

BaseTransport.getAuthenticatedClients

---

getClient()

getClient(id): TransportClient | undefined

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

Get a client by ID

Parameters

id

string

Returns

TransportClient | undefined

Inherited from

BaseTransport.getClient

---

getClients()

getClients(): TransportClient[]

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

Get all connected clients

Returns

TransportClient[]

Inherited from

BaseTransport.getClients

---

on()

on<K>(event, handler): void

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

Register event handlers

Type Parameters

K

K extends keyof TransportEvents

Parameters

event

K

handler

TransportEvents[K]

Returns

void

Inherited from

BaseTransport.on

---

start()

start(): Promise<void>

Defined in: gateway/src/local-transport.ts:124

Start the transport server

Returns

Promise<void>

Overrides

BaseTransport.start

---

stop()

stop(): Promise<void>

Defined in: gateway/src/local-transport.ts:128

Stop the transport server

Returns

Promise<void>

Overrides

BaseTransport.stop