= Rift Realtime Protocol / 1.0 — rifts
image:https://github.com/rift-proto/rifts/actions/workflows/ci.yml/badge.svg[CI,link=https://github.com/rift-proto/rifts/actions/workflows/ci.yml] image:https://img.shields.io/crates/v/rifts.svg[Crates.io,link=https://crates.io/crates/rifts] image:https://img.shields.io/badge/License-MIT-blue.svg[License,link=LICENSE-MIT]
![https://github.com/rift-proto/rifts/actions/workflows/ci.yml/badge.svg[CI,link=https://github.com/rift-proto/rifts/actions/workflows/ci.yml]](https://github.com/rift-proto/rifts/actions/workflows/ci.yml/badge.svg%5BCI,link=https://github.com/rift-proto/rifts/actions/workflows/ci.yml%5D){kind=link}
![https://img.shields.io/crates/v/rifts.svg[Crates.io,link=https://crates.io/crates/rifts]](https://img.shields.io/crates/v/rifts.svg%5BCrates.io,link=https://crates.io/crates/rifts%5D){kind=link}
![https://img.shields.io/badge/License-MIT-blue.svg[License,link=LICENSE-MIT]](https://img.shields.io/badge/License-MIT-blue.svg%5BLicense,link=LICENSE-MIT%5D){kind=link}
The rifts crate is a Rust server implementation of the Rift Realtime Protocol (Rift/1) — a modern,
real-time bidirectional messaging protocol designed to replace raw WebSocket + event-string models
with stronger semantics, similar to Socket.IO but with explicit guarantees.
== Crate Features
[cols="1,2"] |=== | Feature | Description
| websocket (default)
| Standalone WebSocket transport via tokio-tungstenite
| axum
| Axum framework WebSocket adapter
| actix-web
| Actix-web WebSocket adapter
| warp
| Warp framework WebSocket adapter
| ntex
| Ntex framework WebSocket adapter
| tokio-frameworks
| Shortcut: axum + warp
| all-frameworks
| Shortcut: all framework adapters
|===
== Quick Start
[source,rust]
use rifts::RiftServer; use std::sync::Arc; use tokio::sync::Notify;
#[tokio::main] async fn main() -> rifts::Result<()> { let shutdown = Arc::new(Notify::new()); let server = RiftServer::builder() .websocket_transport() .build()?; server.run("127.0.0.1:9000".parse().unwrap(), shutdown).await?; Ok(()) }
== Module Structure
[cols="1,2"] |=== | Module | Purpose
| frame
| Frame envelope, types, flags, codec, priority
| codec
| CBOR + JSON codecs with negotiation
| protocol
| Version, close codes, error codes, heartbeat, handshake
| message
| Eight message classes (event, command, reply, state, …)
| topic
| Topic profiles, retention, ordering, in-memory store
| session
| Sessions, auth, resume, offset tracking
| broker
| In-memory broker, router, fanout, dedupe, snapshots
| ack
| Acknowledgement system (9 ack types)
| flow
| Backpressure controller + token-bucket rate limiter
| transport
| Transport abstraction + WebSocket, framework adapters
| server
| RiftServer builder and event loop
| connection
| Per-connection state machine (spec §5 lifecycle)
|===
== License
Licensed under either of
- Apache License, Version 2.0 (link:LICENSE-APACHE[LICENSE-APACHE] or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (link:LICENSE-MIT[LICENSE-MIT] or https://opensource.org/licenses/MIT)
at your option.
== Contributing
Contributions are welcome! Please open an issue or pull request.