Skip to content

spatial-monorepo


spatial-monorepo / rtls/src / GenericSSEAdapter

Class: GenericSSEAdapter

Defined in: packages/rtls/src/adapters/generic-sse.ts:12

Extends

Constructors

Constructor

new GenericSSEAdapter(id, url, mapPayload, opts?): GenericSSEAdapter

Defined in: packages/rtls/src/adapters/generic-sse.ts:23

Parameters

id

string

url

string

mapPayload

(raw) => PositionUpdate | null

opts?
coordinateMode?

"meter" | "latlon"

Returns

GenericSSEAdapter

Overrides

BaseAdapter.constructor

Properties

_es

_es: EventSource | null = null

Defined in: packages/rtls/src/adapters/generic-sse.ts:21

Exposed as _es for testing


coordinateMode

readonly coordinateMode: "meter" | "latlon"

Defined in: packages/rtls/src/adapters/generic-sse.ts:15

Overrides

BaseAdapter.coordinateMode


id

readonly id: string

Defined in: packages/rtls/src/base-adapter.ts:26

Inherited from

BaseAdapter.id


transport

readonly transport: "sse"

Defined in: packages/rtls/src/adapters/generic-sse.ts:14

Overrides

BaseAdapter.transport


vendor

readonly vendor: RTLSVendor = 'sse'

Defined in: packages/rtls/src/adapters/generic-sse.ts:13

Overrides

BaseAdapter.vendor

Methods

connect()

connect(): Promise`<void>`

Defined in: packages/rtls/src/base-adapter.ts:57

Returns

Promise`<void>`

Inherited from

BaseAdapter.connect


disconnect()

disconnect(): Promise`<void>`

Defined in: packages/rtls/src/base-adapter.ts:65

Returns

Promise`<void>`

Inherited from

BaseAdapter.disconnect


doConnect()

protected doConnect(): Promise`<void>`

Defined in: packages/rtls/src/adapters/generic-sse.ts:35

Subclass performs actual connection (e.g., open WebSocket). Must call this.setConnected() on success or this.handleConnectionError() on failure.

Returns

Promise`<void>`

Overrides

BaseAdapter.doConnect


doDisconnect()

protected doDisconnect(): Promise`<void>`

Defined in: packages/rtls/src/adapters/generic-sse.ts:75

Subclass tears down the actual connection (e.g., close WebSocket).

Returns

Promise`<void>`

Overrides

BaseAdapter.doDisconnect


emit()

protected emit(update): void

Defined in: packages/rtls/src/base-adapter.ts:101

Broadcast a position update to all subscribers

Parameters

update

PositionUpdate

Returns

void

Inherited from

BaseAdapter.emit


handleConnectionError()

protected handleConnectionError(): void

Defined in: packages/rtls/src/base-adapter.ts:109

Call when the connection drops unexpectedly — triggers reconnection

Returns

void

Inherited from

BaseAdapter.handleConnectionError


health()

health(): AdapterHealth

Defined in: packages/rtls/src/base-adapter.ts:84

Returns

AdapterHealth

Inherited from

BaseAdapter.health


setConnected()

protected setConnected(): void

Defined in: packages/rtls/src/base-adapter.ts:91

Call after successful connection establishment

Returns

void

Inherited from

BaseAdapter.setConnected


subscribe()

subscribe(cb): Unsubscribe

Defined in: packages/rtls/src/base-adapter.ts:77

Parameters

cb

(u) => void

Returns

Unsubscribe

Inherited from

BaseAdapter.subscribe

Released under commercial licensing.