rifts 0.2.0

Rift Realtime Protocol / 1.0 — server-side implementation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

# Rift Realtime Protocol / 1.0 — `rifts`

[![CI](https://github.com/lazhenyi/rifts/actions/workflows/ci.yml/badge.svg)](https://github.com/lazhenyi/rifts/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/rifts.svg)](https://crates.io/crates/rifts)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE-MIT)

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

| 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

```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

| 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 ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)

at your option.

## Contributing

Contributions are welcome! Please open an issue or pull request.