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 ​
abstractreadonlytype:TransportType
Defined in: gateway/src/transport.ts:129
Transport type - must be set by subclass
Implementation of ​
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 ​
Methods ​
broadcast() ​
broadcast(
message):void
Defined in: gateway/src/transport.ts:159
Broadcast to all authenticated clients
Parameters ​
message ​
Returns ​
void
Implementation of ​
getAuthenticatedClients() ​
getAuthenticatedClients():
TransportClient[]
Defined in: gateway/src/transport.ts:155
Get authenticated clients
Returns ​
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 ​
getClients() ​
getClients():
TransportClient[]
Defined in: gateway/src/transport.ts:151
Get all connected clients
Returns ​
Implementation of ​
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 ​
Returns ​
void
Implementation of ​
start() ​
abstractstart():Promise<void>
Defined in: gateway/src/transport.ts:140
Start the transport server
Returns ​
Promise<void>
Implementation of ​
stop() ​
abstractstop():Promise<void>
Defined in: gateway/src/transport.ts:141
Stop the transport server
Returns ​
Promise<void>