pushwire-server 0.1.1

Generic multiplexed push server with WebSocket and SSE transports
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

# pushwire-server

Generic, multiplexed push server for real-time applications. Built on [Axum](https://crates.io/crates/axum) with WebSocket and SSE transports.

Part of the [pushwire](https://crates.io/crates/pushwire) protocol family.

## Features

- **`PushServer<C>`** — generic over your `ChannelKind`, register per-channel handlers
- **WebSocket + SSE** — dual transport with `/rps` (WebSocket), `/rps/sse` (SSE), `/rps/ack` (HTTP POST)
- **Cursor-based replay** — clients resume after disconnect without message loss
- **Priority queuing** — high/normal/low lanes based on `ChannelKind::priority()`
- **Auth validation** — pluggable `AuthValidator` callback on handshake
- **Binary assets** — inline (base64) or pointer delivery with SHA-256 integrity
- **Transport manager** — Direct/P2P/Relay routing with automatic failover and backoff
- **Relay controller** — bandwidth-limited server-side relay with token-bucket rate limiting
- **WebRTC signaling** — optional peer-to-peer signaling relay (`rtc` feature)

## Quick start

```rust
use pushwire_server::PushServer;
use std::sync::Arc;

// Define MyChannel implementing ChannelKind (see pushwire-core)

let server: Arc<PushServer<MyChannel>> = Arc::new(PushServer::new());

server.register_handler(MyChannel::Chat, |client_id, frame, server| {
    // Echo to all connected clients
    for id in server.connected_client_ids() {
        let _ = server.send(id, frame.clone());
    }
});

let app = server.clone().router();
let listener = tokio::net::TcpListener::bind("0.0.0.0:9100").await.unwrap();
axum::serve(listener, app.into_make_service()).await.unwrap();
```

## Endpoints

| Route | Method | Description |
|-------|--------|-------------|
| `/rps` | GET (WebSocket upgrade) | Primary push channel — auth handshake, bidirectional frames |
| `/rps/sse` | GET | Server-Sent Events stream — `?client_id=...&channels=chat,system` |
| `/rps/ack` | POST | HTTP acknowledgment — `{ client_id, channel, cursor }` |

## Feature flags

- **`rtc`** (default) — enables WebRTC signaling relay via `pushwire-core/rtc`

## License

Apache-2.0