Class HttpServer

Represents an HTTP server. This class encapsulates the functionality required for creating and managing an HTTP server, including binding to a network address, accepting client connections, and handling client requests.

Example

// Example of creating and starting an HttpServer with a handler which returns 200 for all requests
const httpServer = new HttpServer('127.0.0.1', 8080, (req, res) => { res.status = 200; return res; });
while(true) {
  httpServer.acceptNextClient();
}

Hierarchy

  • HttpServer

Constructors

constructor

Properties

handler logger server

Methods

acceptNextClient close handleClient

Constructors

constructor

  • Creates an instance of a HTTP server.

    Parameters

    • bindAddress: string

      The IP address or hostname the server will bind to.

    • port: number

      The port number the server will listen on.

    • handler: RequestHandler

      The request handler to be used when serving requests

    Returns HttpServer

Properties

Protected Readonly handler

handler: RequestHandler

The request handler to be used when serving requests

Protected logger

logger: Logger

Protected server

server: TCP

The underlying TCP server.

Methods

acceptNextClient

  • Accepts the next client connection. When a client connects, it handles the client's request.

    Returns void

    Example

    // Accept and handle the next client
    httpServer.acceptNextClient();

close

Private handleClient

  • Private

    Handles the client's request. Reads the request from the client, processes it, and sends back a response.

    Parameters

    • client: TCP

      The client to handle.

    Returns void

    Example

    // Internally used to handle a client's request
    this.handleClient(client);

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc