Function makeAutoDispose

Creates an auto-dispose mechanism for a client session in a swarm.

This function establishes a timer-based auto-dispose system that monitors client activity in a swarm session. If no activity is detected (via the tick method) within the specified timeout period, the session is automatically disposed using disposeConnection. The mechanism uses a Source from functools-kit to manage the timer, which can be reset or stopped manually. The execution is wrapped in beginContext for a clean environment, and an optional callback (onDestroy) can be provided to handle post-disposal actions.

Throws

If disposal via disposeConnection fails when triggered automatically.

Example

const { tick, destroy } = makeAutoDispose("client-123", "TaskSwarm", {
  timeoutSeconds: 30,
  onDestroy: (id, name) => console.log(`Session ${id} in ${name} closed`)
});
tick(); // Reset timer
setInterval(tick, 10000); // Keep alive every 10 seconds
destroy(); // Stop manually
  • makeAutoDispose(
        clientId: string,
        swarmName: string,
        args_2?: Partial<IMakeDisposeParams>,
    ): { destroy(): void; tick(): void }

    Parameters

    • clientId: string

      The unique identifier of the client session.

    • swarmName: string

      The name of the swarm associated with the session.

    • Optionalargs_2: Partial<IMakeDisposeParams>

    Returns { destroy(): void; tick(): void }

    An object with tick to signal activity and destroy to stop the auto-dispose mechanism.

Settings

Member Visibility