net

local net = require("@lute/net")

WARNING

These APIs are still open to future evolution. In new major versions, they may change in backwards incompatible ways.

Summary

Entry	Description
Configuration	Configuration for starting an HTTP server.
Handler	A request handler function: receives a ReceivedRequest and Server, and returns a ServerResponse.
Metadata	HTTP request metadata, including optional method, body, and headers.
ReceivedRequest	An HTTP request received by the server, containing method, path, body, query params, and headers.
Response	An HTTP response, containing status code, headers, body, and a success flag.
Server	A running HTTP server handle, with hostname, port, and lifecycle methods.
ServerResponse	A response that can be returned from a server handler: a plain string body, or a table with status, body, and headers.
ServerWebSocket	A server-side WebSocket connection handle.
WebSocket	A client-side WebSocket connection handle.
WebSocketHandlers	Event handlers for server-side WebSocket connections.
WebSocketOptions	Options for establishing a WebSocket connection, including optional event handlers.

---

Types

Configuration

Configuration for starting an HTTP server.

type Configuration = server.Configuration

---

Handler

A request handler function: receives a ReceivedRequest and Server, and returns a ServerResponse.

type Handler = server.Handler

---

Metadata

HTTP request metadata, including optional method, body, and headers.

type Metadata = client.Metadata

---

ReceivedRequest

An HTTP request received by the server, containing method, path, body, query params, and headers.

type ReceivedRequest = server.ReceivedRequest

---

Response

An HTTP response, containing status code, headers, body, and a success flag.

type Response = client.Response

---

Server

A running HTTP server handle, with hostname, port, and lifecycle methods.

type Server = server.Server

---

ServerResponse

A response that can be returned from a server handler: a plain string body, or a table with status, body, and headers.

type ServerResponse = server.ServerResponse

---

ServerWebSocket

A server-side WebSocket connection handle.

type ServerWebSocket = server.ServerWebSocket

---

WebSocket

A client-side WebSocket connection handle.

type WebSocket = client.WebSocket

---

WebSocketHandlers

Event handlers for server-side WebSocket connections.

type WebSocketHandlers = server.WebSocketHandlers

---

WebSocketOptions

Options for establishing a WebSocket connection, including optional event handlers.

type WebSocketOptions = client.WebSocketOptions

---