Development · Native API migration preview · Coverage validation in progress Published release →

API Browser

Member group

Serve

Declaring type: HttpServer
Module: System.Web.Http
Assembly: System.Web.dll
Source file: HttpServer.rvn

Overloads / Variants

Serve

func Serve(handler: (HttpContext) -> Task<Result<void, HttpError>>, cancellationToken: CancellationToken = default) -> Task<Result<void, HttpError>>

Source file: HttpServer.rvn

Starts server-managed concurrent request handling. The returned task represents server lifetime. Up to 16 exchanges run concurrently; request failures are recorded and do not stop serving. Cancellation closes the server. Completion waits for every started handler task to settle. Close completes normally; caller cancellation cancels the lifetime task; listener failure returns Error.

Parameters

Name Type Description
handler Function
cancellationToken CancellationToken

Return value

Task<Result<void, HttpError>>

Recommended entry point for HTTP web applications. Starts concurrent, server-owned request dispatch. This method returns immediately; its task represents the lifetime of the server, not an individual request.

Awaiting this lifetime task in async Main does not serialize requests. Retain and observe it when coordinating shutdown separately; dropping a task does not offload work to another thread.

The context callback is the canonical application API. The request callback returns a separately constructed response.

Parameters

handler: An asynchronous context callback returning Task<Result<(), HttpError>>, or a request callback returning Task<Result<HttpResponse, HttpError>>. The server observes every started task and owns each successful response, including late or invalid responses and their owned content. It does not create an OS thread per handler; blocking synchronous code blocks the cooperative dispatcher.

Returns and lifetime

The lifetime task succeeds after Close() and settlement of every started handler. An already active/closed server rejects startup with InvalidRequest. Listener failure terminates serving with a transport error. Request errors close only their exchange, update FailedRequests/LastRequestError, and serving continues.

The server admits at most 16 exchanges and owns acceptance exclusively. Closing connections does not force arbitrary handler tasks to finish; a handler that never settles prevents lifetime completion. See the server lifetime contract.

Cancellation

cancellationToken defaults to default, a non-cancellable token. Pre-cancellation cancels the returned task without closing the listener. Later cancellation stops acceptance and closes connections. The lifetime task settles only after every started handler settles. Cancellation does not forcibly terminate application work; capture a suitable application token inside the handler when needed.

Serve

func Serve(handler: (HttpRequest) -> Task<Result<HttpResponse, HttpError>>, cancellationToken: CancellationToken = default) -> Task<Result<void, HttpError>>

Source file: HttpServer.rvn

Starts server-managed concurrent request handling. The returned task represents server lifetime. Up to 16 exchanges run concurrently; request failures are recorded and do not stop serving. Cancellation closes the server. Completion waits for every started handler task to settle. Close completes normally; caller cancellation cancels the lifetime task; listener failure returns Error.

Parameters

Name Type Description
handler Function
cancellationToken CancellationToken

Return value

Task<Result<void, HttpError>>

Recommended entry point for HTTP web applications. Starts concurrent, server-owned request dispatch. This method returns immediately; its task represents the lifetime of the server, not an individual request.

Awaiting this lifetime task in async Main does not serialize requests. Retain and observe it when coordinating shutdown separately; dropping a task does not offload work to another thread.

The context callback is the canonical application API. The request callback returns a separately constructed response.

Parameters

handler: An asynchronous context callback returning Task<Result<(), HttpError>>, or a request callback returning Task<Result<HttpResponse, HttpError>>. The server observes every started task and owns each successful response, including late or invalid responses and their owned content. It does not create an OS thread per handler; blocking synchronous code blocks the cooperative dispatcher.

Returns and lifetime

The lifetime task succeeds after Close() and settlement of every started handler. An already active/closed server rejects startup with InvalidRequest. Listener failure terminates serving with a transport error. Request errors close only their exchange, update FailedRequests/LastRequestError, and serving continues.

The server admits at most 16 exchanges and owns acceptance exclusively. Closing connections does not force arbitrary handler tasks to finish; a handler that never settles prevents lifetime completion. See the server lifetime contract.

Cancellation

cancellationToken defaults to default, a non-cancellable token. Pre-cancellation cancels the returned task without closing the listener. Later cancellation stops acceptance and closes connections. The lifetime task settles only after every started handler settles. Cancellation does not forcibly terminate application work; capture a suitable application token inside the handler when needed.