API Reference¶

This section provides auto-generated API documentation for Palfrey's core modules, extracted directly from the codebase docstrings.

Overview¶

The API reference is organized by functional area:

• Server — Core ASGI server implementation
• HTTP/1.1 — HTTP/1.1 protocol handler
• HTTP/2 — HTTP/2 multiplexing support
• HTTP/3 — HTTP/3 over QUIC implementation
• WebSocket — WebSocket protocol handler
• Configuration — Server configuration and CLI
• Acceleration — Rust acceleration shim layer

Usage¶

Each module page lists:

• Public classes with their methods and attributes
• Public functions with signatures and parameters
• Docstrings following Google style conventions

Private functions (prefixed with _) are excluded from the reference.

Note¶

This documentation is auto-generated from the source code. If you find issues or have suggestions, please refer to the Contributing Guide.