spatial-monorepo / rtls/src / BaseAdapter
Abstract Class: BaseAdapter
Defined in: packages/rtls/src/base-adapter.ts:25
Extended by
GeolocationAdapterGenericWebSocketAdapterGenericRESTPollAdapterGenericSSEAdapterGenericMQTTAdapterCiscoFirehoseAdapterCenTrakAdapterIndoorAtlasAdapter
Implements
Constructors
Constructor
new BaseAdapter(
id):BaseAdapter
Defined in: packages/rtls/src/base-adapter.ts:42
Parameters
id
string
Returns
BaseAdapter
Properties
coordinateMode
abstractreadonlycoordinateMode:"meter"|"latlon"
Defined in: packages/rtls/src/base-adapter.ts:29
Implementation of
id
readonlyid:string
Defined in: packages/rtls/src/base-adapter.ts:26
Implementation of
transport
abstractreadonlytransport:"mqtt"|"websocket"|"sse"|"http-poll"|"grpc-web"|"sdk"
Defined in: packages/rtls/src/base-adapter.ts:28
Implementation of
vendor
abstractreadonlyvendor:RTLSVendor
Defined in: packages/rtls/src/base-adapter.ts:27
Implementation of
Methods
connect()
connect():
Promise`<void>`
Defined in: packages/rtls/src/base-adapter.ts:57
Returns
Promise`<void>`
Implementation of
disconnect()
disconnect():
Promise`<void>`
Defined in: packages/rtls/src/base-adapter.ts:65
Returns
Promise`<void>`
Implementation of
doConnect()
abstractprotecteddoConnect():Promise`<void>`
Defined in: packages/rtls/src/base-adapter.ts:50
Subclass performs actual connection (e.g., open WebSocket). Must call this.setConnected() on success or this.handleConnectionError() on failure.
Returns
Promise`<void>`
doDisconnect()
abstractprotecteddoDisconnect():Promise`<void>`
Defined in: packages/rtls/src/base-adapter.ts:53
Subclass tears down the actual connection (e.g., close WebSocket).
Returns
Promise`<void>`
emit()
protectedemit(update):void
Defined in: packages/rtls/src/base-adapter.ts:101
Broadcast a position update to all subscribers
Parameters
update
Returns
void
handleConnectionError()
protectedhandleConnectionError():void
Defined in: packages/rtls/src/base-adapter.ts:109
Call when the connection drops unexpectedly — triggers reconnection
Returns
void
health()
health():
AdapterHealth
Defined in: packages/rtls/src/base-adapter.ts:84
Returns
Implementation of
setConnected()
protectedsetConnected():void
Defined in: packages/rtls/src/base-adapter.ts:91
Call after successful connection establishment
Returns
void
subscribe()
subscribe(
cb):Unsubscribe
Defined in: packages/rtls/src/base-adapter.ts:77
Parameters
cb
(u) => void
