GitHub

HttpServerService

API reference for HttpServerService.

serve(app, middleware) handles requests with app until the scope closes; address is where the server listens. A backend makes one with make.

Attributes

AttributeTypeDescription
addressSocketAddress = address

Functions

__init__

__init__(serve, address) -> None
ParameterTypeDescription
serveCallable[[HttpApp, Middleware | None], Effect[None, Never, Scope]]
addressSocketAddress
def __init__(
    self,
    serve: Callable[[HttpApp, Middleware | None], Effect[None, Never, Scope]],
    address: SocketAddress,
) -> None:
    self._serve = serve
    self.address = address

serve

serve(app, middleware=None) -> Effect[None, Never, Scope]

Starts handling requests with app (wrapped by middleware when given), each with its HttpServerRequest provided, and keeps serving until the current scope closes. Succeeds once the server is serving; never fails (an app's failure becomes its request's error response).

ParameterTypeDescription
appHttpApp
middlewareMiddleware | None = None

Returns Effect[None, Never, Scope]

def serve(
    self, app: HttpApp, middleware: Middleware | None = None
) -> Effect[None, Never, Scope]:
    """Starts handling requests with ``app`` (wrapped by ``middleware``
    when given), each with its ``HttpServerRequest`` provided, and keeps
    serving until the current scope closes. Succeeds once the server is
    serving; never fails (an app's failure becomes its request's error
    response)."""
    return self._serve(app, middleware)