Documentation / @agentick/gateway / WSTransport
Class: WSTransport
Defined in: gateway/src/ws-transport.ts:68
Base class with shared transport functionality.
Extends
Constructors
Constructor
new WSTransport(
config):WSTransport
Defined in: gateway/src/ws-transport.ts:73
Parameters
config
Returns
WSTransport
Overrides
Properties
type
readonlytype:"websocket"
Defined in: gateway/src/ws-transport.ts:69
Transport type - must be set by subclass
Overrides
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
Methods
broadcast()
broadcast(
message):void
Defined in: gateway/src/transport.ts:159
Broadcast to all authenticated clients
Parameters
message
Returns
void
Inherited from
getAuthenticatedClients()
getAuthenticatedClients():
TransportClient[]
Defined in: gateway/src/transport.ts:155
Get authenticated clients
Returns
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
getClients()
getClients():
TransportClient[]
Defined in: gateway/src/transport.ts:151
Get all connected clients
Returns
Inherited from
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
Inherited from
start()
start():
Promise<void>
Defined in: gateway/src/ws-transport.ts:78
Start the transport server
Returns
Promise<void>
Overrides
stop()
stop():
Promise<void>
Defined in: gateway/src/ws-transport.ts:101
Stop the transport server
Returns
Promise<void>