HTTP Server

This module defines a simple, asynchronous HTTP/1.1 server implementation.

It provides the Std.Http.Server structure, which encapsulates all server state, and functions for starting, managing, and gracefully shutting down the server.

The server runs entirely using Async and uses a shared CancellationContext to signal shutdowns. Each active client connection is tracked, and the server automatically resolves its shutdown promise once all connections have closed.

structure Std.Http.Server : Type

The Server structure holds all state required to manage the lifecycle of an HTTP server, including connection tracking and shutdown coordination.

• context : CancellationContext

  The context used for shutting down all connections and the server.

• activeConnections : Mutex Nat

  Active HTTP connections

• connectionLimit : Option Semaphore

  Semaphore used to enforce the maximum number of simultaneous active connections. none means no connection limit.

• shutdownPromise : Channel Unit

  Indicates when the server has successfully shut down.

• config : Config

  Configuration of the server

• localAddr : Option Net.SocketAddress

  The local socket address the server is bound to. When serve is called with a port of 0, this reflects the ephemeral port assigned by the OS rather than the requested address. none for servers constructed without an associated listening socket (e.g. serveConnection).

def Std.Http.Server.new (config : Config := { }) (localAddr : Option Net.SocketAddress := none) : IO Server

Create a new Server structure with an optional configuration.

Equations

• One or more equations did not get rendered due to their size.

@[inline]

def Std.Http.Server.shutdown (s : Server) : Async.Async Unit

Triggers cancellation of all requests and the accept loop in the server. This function should be used in conjunction with waitShutdown to properly coordinate the shutdown sequence.

Equations

• s.shutdown = liftM (s.context.cancel Std.CancellationReason.shutdown)

@[inline]

def Std.Http.Server.waitShutdown (s : Server) : Async.Async Unit

Waits for the server to shut down. Blocks until another task or async operation calls the shutdown function.

Equations

• s.waitShutdown = do let __do_lift ← liftM s.shutdownPromise.recv Std.Async.Async.ofAsyncTask (Task.map Except.ok __do_lift)

@[inline]

def Std.Http.Server.waitShutdownSelector (s : Server) : Async.Selector Unit

Returns a Selector that waits for the server to shut down.

Equations

• s.waitShutdownSelector = s.shutdownPromise.recvSelector

@[inline]

def Std.Http.Server.shutdownAndWait (s : Server) : Async.Async Unit

Triggers cancellation of all requests and the accept loop, then waits for the server to fully shut down. This is a convenience function combining shutdown and then waitShutdown.

Equations

• s.shutdownAndWait = do liftM (s.context.cancel Std.CancellationReason.shutdown) s.waitShutdown

def Std.Http.Server.serve {σ : Type} [Handler σ] (addr : Net.SocketAddress) (handler : σ) (config : Config := { }) (backlog : UInt32 := 1024) : Async.Async Server

Start a new HTTP/1.1 server on the given socket address. This function uses Async to handle tasks and TCP connections, and returns a Server structure that can be used to cancel the server.

Equations

• One or more equations did not get rendered due to their size.