API Reference

Complete technical documentation for all Rage framework classes and modules.

Core Components​

Controller​

Base controller functionality for handling HTTP requests and responses.

Router​

Define and manage application routes.

Configuration​

Configure your Rage application settings and environment.

HTTP Handling​

Request​

Access and manipulate incoming HTTP request data.

Response​

Build and send HTTP responses to clients.

Cookies​

Read and write HTTP cookies.

Session​

Manage user session data across requests.

UploadedFile​

Handle file uploads from multipart form data.

SSE::Message​

Build Server-Sent Events messages.

SSE::ConnectionProxy​

Low-level interface for SSE connections.

Middleware​

CORS Middleware​

Enable Cross-Origin Resource Sharing for your API.

RequestID Middleware​

Mark requests with unique identifiers for logging and debugging.

EnqueueMiddlewareInterface​

Intercept and modify deferred task enqueueing operations.

PerformMiddlewareInterface​

Intercept and modify deferred task execution.

Telemetry​

Handler​

Monitor and respond to specific span executions in your application.

Spans​

Telemetry span definitions for tracing framework operations and events.

SpanResult​

Access the outcome and status of telemetry span execution.

Capacity​

Access runtime metrics for server load and queued connections.

Async & Concurrency​

Fiber​

Work with Ruby fibers for lightweight concurrency.

Deferred​

Handle deferred execution and asynchronous operations.

Daemon​

Build and manage long-lived background processes.

Events​

Events​

Build event-driven applications with the Rage event system.

Subscriber​

Subscribe to and handle application events.

WebSockets​

Channel​

Create WebSocket channels for real-time communication.

Connection​

Manage WebSocket connection lifecycle and authentication.

Utilities​

Logger​

Log application messages with configurable levels and formats.