@vpalmisano/webrtcperf
    Preparing search index...

    Class Server

    An HTTP server instance that allows to control the tool using a REST interface. Moreover, it allows to aggregate stats data coming from multiple running tool instances.

    Index

    Constructors

    • Server instance. All the HTTP endpoints are protected by basic authentication with user admin and password Server.serverSecret.

      Parameters

      • __namedParameters: {
            pageLogPath?: string;
            serverData?: string;
            serverPort?: number;
            serverSecret?: string;
            serverUseHttps?: boolean;
            videoCachePath?: string;
        } = {}
      • stats: Stats

        A Stats class instance.

      Returns Server

    Properties

    pageLogPath: string

    The file path that will be used to serve the /view/page.log requests.

    serverData: string

    An optional path that the HTTP server will expose with the /data endpoint.

    serverPort: number

    The server listening port.

    serverSecret: string

    The basic auth secret.

    serverUseHttps: boolean

    If HTTPS protocol should be used.

    stats: Stats

    A Stats class instance.

    videoCachePath: string

    The path that will be used to serve the /cache requests.

    Methods

    • Starts the Server instance.

      Returns Promise<void>