rifts 0.3.10

Rift Realtime Protocol / 1.0 — server + client 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

use std::time::Duration;

use crate::frame::Codec;

/// Configuration for [`RiftClient`](super::RiftClient).
///
/// Create one via `Default` and then override fields as needed.
#[derive(Debug, Clone)]
pub struct RiftClientConfig {
    /// Unique client identifier (e.g. user ID or app instance).
    pub client_id: String,

    /// Authentication token (JWT or opaque).
    pub token: String,

    /// Session ID for resume; auto-generated if `None`.
    pub session_id: Option<String>,

    /// Session epoch counter, defaults to 1.
    pub epoch: u32,

    /// Preferred codecs in priority order.
    pub codecs: Vec<Codec>,

    /// Protocol feature flags to advertise in Hello.
    pub features: Vec<String>,

    /// Per-topic last-seen offsets for session resume.
    pub last_offsets: std::collections::BTreeMap<String, i64>,

    /// Automatically reconnect on disconnect.
    pub auto_reconnect: bool,

    /// Base delay before the first reconnect attempt.
    pub reconnect_delay: Duration,

    /// Maximum number of consecutive reconnect attempts before giving up.
    pub max_reconnect_attempts: u32,
}

impl Default for RiftClientConfig {
    fn default() -> Self {
        Self {
            client_id: String::new(),
            token: String::new(),
            session_id: None,
            epoch: 1,
            codecs: vec![Codec::Cbor, Codec::Json],
            features: vec!["resume".into()],
            last_offsets: std::collections::BTreeMap::new(),
            auto_reconnect: true,
            reconnect_delay: Duration::from_secs(1),
            max_reconnect_attempts: 10,
        }
    }
}