@mojojs/core
    Preparing search index...

    Class Server

    HTTP and WebSocket server class.

    Index
    constructor
    _cluster _listen _quiet _servers _workers app headersTimeout keepAliveTimeout maxRequestsPerSocket maxWebSocketSize requestTimeout reverseProxy urls
    _createServer _handleRequest _handleUpgrade _prepareRequest start stop listenArgsForURL

    _cluster

    _cluster: boolean

    _listen

    _listen: string[]

    _quiet

    _quiet: boolean

    _servers

    _servers: (
        | Server<typeof IncomingMessage, typeof ServerResponse>
        | Server<typeof IncomingMessage, typeof ServerResponse>
    )[] = []

    _workers

    _workers: number
    app: App

    Application this server handles.

    headersTimeout: number | undefined

    Limit the amount of time the parser will wait to receive the complete HTTP headers, defaults to 60000 (60 seconds).

    keepAliveTimeout: number | undefined

    Limit the amount of time of inactivity a server needs to wait for additional incoming data, after it has finished writing the last response, before a socket will be destroyed, defaults to 5000 (5 seconds).

    maxRequestsPerSocket: number | undefined

    Maximum number of requests socket can handle before closing keep alive connection, defaults to 0.

    maxWebSocketSize: number

    Maximum WebSocket message size in bytes, defaults to 262144 (256 KiB). Connections exceeding the limit are closed with status 1009.

    requestTimeout: number | undefined

    Limit the amount of time for receiving the entire request from the client, defaults to 300000 (300 seconds).

    reverseProxy: boolean

    Reverse proxy mode.

    urls: URL[] = []

    Server URLs.

    _createServer

    • _createServer(location: string): Promise<void>

      Parameters

      • location: string

      Returns Promise<void>

    _handleRequest

    • _handleRequest(req: IncomingMessage, raw: ServerResponse): void

      Parameters

      • req: IncomingMessage
      • raw: ServerResponse

      Returns void

    _handleUpgrade

    • _handleUpgrade(
          wss: WebSocketServer,
          req: IncomingMessage,
          socket: Socket,
          head: Buffer,
      ): void

      Parameters

      • wss: WebSocketServer
      • req: IncomingMessage
      • socket: Socket
      • head: Buffer

      Returns void

    _prepareRequest

    • _prepareRequest(
          req: IncomingMessage,
          socket: Socket,
          isWebSocket: boolean,
      ): ServerRequest

      Parameters

      • req: IncomingMessage
      • socket: Socket
      • isWebSocket: boolean

      Returns ServerRequest

    • Start server.

      Returns Promise<void>

    • Stop server.

      Returns Promise<void>

    • Turn URL into listen arguments.

      Parameters

      • url: URL

      Returns ListenArgs

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods