Setu-TS
    Preparing search index...

    Interface ILocalDiagnosticsListenerFactory

    The runtime-owned factory for the local diagnostics listener, provided by the RuntimePlugin under CAPABILITIES.LOCAL_DIAGNOSTICS_LISTENER.

    Deliberately narrow, because the application's own IHttpAdapter is stateful and cannot be reused or cloned for a second listener: this factory permits ONE active listener, binds ONLY 127.0.0.1, accepts no hostname, adapter, or body-limit option, and returns a handle whose sole operation is ILocalDiagnosticsListener.close. It is the local diagnostics transport, not a generic second HTTP server API.

    Implementations on runtimes without a supported local transport reject every listen call with one fixed unsupported-transport error before any bind is attempted.

    const factory = ctx.services.get<ILocalDiagnosticsListenerFactory>(
      CAPABILITIES.LOCAL_DIAGNOSTICS_LISTENER,
    );
    const listener = await factory.listen({ port: 4919, handler });
    await listener.close();

    0.8.0

    interface ILocalDiagnosticsListenerFactory {
        listen(
            options: LocalDiagnosticsListenerOptions,
        ): Promise<ILocalDiagnosticsListener>;
    }
    Index
    listen

    Settings
    Member Visibility

    On This Page
    Methods