Skip to main content

Interface: Transport

Defined in: livelink.clients/livelink.agent/sources/data/Transport.ts:33

A data source feeding an EventSink.

Transports are use-case agnostic: they know how to read from or subscribe to a source and forward each decoded event; they never interpret the payload. Implement one to plug in a protocol the SDK does not bundle (OPC-UA, a WebSocket feed, a serial port) — construct it with the sink, then register the kind on the defaultTransportRegistry or pass a factory straight to a SceneIngestion.

Methods​

start()​

start(): Promise<void>;

Defined in: livelink.clients/livelink.agent/sources/data/Transport.ts:38

Connect to the source and start forwarding events to the sink. Resolves once the source is live; rejects if it cannot be established.

Returns​

Promise<void>

stop()​

stop(): Promise<void>;

Defined in: livelink.clients/livelink.agent/sources/data/Transport.ts:43

Stop forwarding events and release the connection. Must be safe to call when never started.

Returns​

Promise<void>