Class Server

HTTP and WebSocket server class.

Hierarchy

  • Server

Constructors

constructor

Properties

_cluster _listen _quiet _servers _workers app headersTimeout keepAliveTimeout maxRequestsPerSocket requestTimeout reverseProxy urls

Methods

_createServer _handleRequest _handleUpgrade _prepareRequest start stop listenArgsForURL

Constructors

constructor

Properties

_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: App

Application this server handles.

headersTimeout

headersTimeout: undefined | number

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

keepAliveTimeout

keepAliveTimeout: undefined | number

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

maxRequestsPerSocket: undefined | number

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

requestTimeout

requestTimeout: undefined | number

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

reverseProxy

reverseProxy: boolean

Reverse proxy mode.

urls

urls: URL[] = []

Server URLs.

Methods

_createServer

  • _createServer(location): Promise<void>

  • Parameters

    • location: string

    Returns Promise<void>

_handleRequest

  • _handleRequest(req, raw): void

  • Parameters

    • req: IncomingMessage
    • raw: ServerResponse<IncomingMessage>

    Returns void

_handleUpgrade

  • _handleUpgrade(wss, req, socket, head): void

  • Parameters

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

    Returns void

_prepareRequest

  • _prepareRequest(req, socket, isWebSocket): ServerRequest

  • Parameters

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

    Returns ServerRequest

start

  • Start server.

    Returns Promise<void>

stop

  • Stop server.

    Returns Promise<void>

Static listenArgsForURL

  • Turn URL into listen arguments.

    Parameters

    • url: URL

    Returns ListenArgs

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc