Skip to content

Documentation / @agentick/gateway / BaseTransport

Abstract Class: BaseTransport

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

Base class with shared transport functionality.

Extended by

Implements

Constructors

Constructor

new BaseTransport(config?): BaseTransport

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

Parameters

config?

TransportConfig = {}

Returns

BaseTransport

Properties

type

abstract readonly type: TransportType

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

Transport type - must be set by subclass

Implementation of

Transport.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

Implementation of

Transport.clientCount

Methods

broadcast()

broadcast(message): void

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

Broadcast to all authenticated clients

Parameters

message

GatewayMessage

Returns

void

Implementation of

Transport.broadcast


getAuthenticatedClients()

getAuthenticatedClients(): TransportClient[]

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

Get authenticated clients

Returns

TransportClient[]

Implementation of

Transport.getAuthenticatedClients


getClient()

getClient(id): TransportClient | undefined

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

Get a client by ID

Parameters

id

string

Returns

TransportClient | undefined

Implementation of

Transport.getClient


getClients()

getClients(): TransportClient[]

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

Get all connected clients

Returns

TransportClient[]

Implementation of

Transport.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

Implementation of

Transport.on


start()

abstract start(): Promise<void>

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

Start the transport server

Returns

Promise<void>

Implementation of

Transport.start


stop()

abstract stop(): Promise<void>

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

Stop the transport server

Returns

Promise<void>

Implementation of

Transport.stop

Released under the ISC License.