Class: TransportRegistry

Defined in: livelink.clients/livelink.agent/sources/data/transports/TransportRegistry.ts:69

Registry of transport kinds.

The defaultTransportRegistry ships with the built-in kinds ("playback", "mqtt", "azure-event-hub", "opcua", plus "file" as a deprecated alias of "playback"); register custom sources (a serial port, a proprietary bus, ...) under their own kind:

defaultTransportRegistry.register({
    kind: "serial",
    factory: (config, sink) => new MySerialTransport(config as MySerialConfig, sink),
});

Constructors

Constructor

new TransportRegistry(): TransportRegistry;

Returns

TransportRegistry

Accessors

kinds

Get Signature

get kinds(): string[];

Defined in: livelink.clients/livelink.agent/sources/data/transports/TransportRegistry.ts:78

The registered transport kinds.

Returns

string[]

Methods

register()

register(__namedParameters: {
  kind: string;
  factory: TransportFactory;
}): void;

Defined in: livelink.clients/livelink.agent/sources/data/transports/TransportRegistry.ts:87

Register a transport factory under a kind.

Parameters

Parameter	Type
__namedParameters	{ kind: string; factory: TransportFactory; }
__namedParameters.kind	string
__namedParameters.factory	TransportFactory

Returns

void

Throws

If the kind is already registered.

---

has()

has(__namedParameters: {
  kind: string;
}): boolean;

Defined in: livelink.clients/livelink.agent/sources/data/transports/TransportRegistry.ts:97

Whether a transport kind is registered.

Parameters

Parameter	Type
__namedParameters	{ kind: string; }
__namedParameters.kind	string

Returns

boolean

---

create()

create(__namedParameters: {
  spec: TransportSpec;
  sink: EventSink;
}): Promise<Transport>;

Defined in: livelink.clients/livelink.agent/sources/data/transports/TransportRegistry.ts:106

Build a transport bound to a sink from a spec.

Parameters

Parameter	Type
__namedParameters	{ spec: TransportSpec; sink: EventSink; }
__namedParameters.spec	TransportSpec
__namedParameters.sink	EventSink

Returns

Promise<Transport>

Throws

If the spec's kind is not registered.