Interface ReceivingLink

A link a rule engine listens on as well as publishes over: a LoopbackTransport, an MqttClient, a CoapClient, or anything else with the same three calls. Connect it first.

interface ReceivingLink {
    recv(timeoutMs?: number): Promise<profile.LinkMessage | null>;
    send(
        topic: string,
        payload: string | Buffer<ArrayBufferLike>,
    ): Promise<unknown>;
    subscribe(topic: string): Promise<unknown>;
}

Hierarchy (View Summary)

profile.Link
- ReceivingLink

Index

Methods

recv send subscribe

Methods

recv

recv(timeoutMs?: number): Promise<profile.LinkMessage | null>
Waits for the next message, or null when none arrives in time.
Parameters
- OptionaltimeoutMs: number
Returns Promise<profile.LinkMessage | null>
- Defined in profile/dist/engine.d.ts:30

send

send(topic: string, payload: string | Buffer<ArrayBufferLike>): Promise<unknown>
Publishes one message to a topic.
Parameters
- topic: string
- payload: string | Buffer<ArrayBufferLike>
Returns Promise<unknown>
Inherited from Link.send
- Defined in profile/dist/node.d.ts:14

subscribe(topic: string): Promise<unknown>
Subscribes to one topic.
Parameters
- topic: string
Returns Promise<unknown>
- Defined in profile/dist/engine.d.ts:28