Function listenExecutionEvent

Subscribes to execution-specific events on the swarm bus service for a specific client and executes a callback for each event.

This function sets up a listener for events on the "execution-bus" topic associated with a given client ID, invoking the provided callback with the event data whenever an execution event is received. It is wrapped in beginContext for a clean execution environment and logs the operation via loggerService. The callback is queued using functools-kit to ensure sequential processing of events. The function supports a wildcard client ID ("*") for listening to all clients or validates a specific client session. It returns an unsubscribe function to stop listening.

Throws

If the clientId is not "*" and no active session exists for it.

Example

const unsubscribe = listenExecutionEvent("client-123", (event) => console.log(event));
// Logs each execution event for "client-123"
unsubscribe(); // Stops listening
  • listenExecutionEvent(
        clientId: string,
        fn: (event: IBusEvent) => void,
    ): () => void

    Parameters

    • clientId: string

      The ID of the client to subscribe to execution events for, or "*" to listen to all clients.

    • fn: (event: IBusEvent) => void

      The callback function to execute when an execution event is received, passed the event object.

    Returns () => void

    A function to unsubscribe from the execution event listener.

Settings

Member Visibility