Function disposeConnection

Disposes of a client session and all related resources within a swarm.

This function terminates a client session, cleaning up associated swarm, agent, storage, state, and auxiliary resources (e.g., history, logs, performance metrics). It ensures that all dependencies are properly disposed of to prevent resource leaks, using sets to avoid redundant disposal of shared resources. The execution is wrapped in beginContext to ensure it runs outside of existing method and execution contexts, providing a clean execution environment. The function logs the operation if enabled and resolves when all disposal tasks are complete.

Throws

If session or swarm validation fails, or if any disposal operation encounters an error.

Example

await disposeConnection("client-123", "TaskSwarm");
  • disposeConnection(
        clientId: string,
        swarmName: string,
        methodName?: any,
    ): Promise<void>

    Parameters

    • clientId: string

      The unique identifier of the client session to dispose of.

    • swarmName: string

      The name of the swarm associated with the session.

    • OptionalmethodName: any

      The name of the method invoking the disposal (defaults to METHOD_NAME).

    Returns Promise<void>

    A promise that resolves when the session and all related resources are fully disposed.

Settings

Member Visibility