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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use crate::ack::AckStatus;
use crate::message::command::Reply;
use crate::message::datagram::Datagram;
use crate::message::event::Event;
use crate::message::snapshot::Snapshot;
use crate::message::state::State;
use crate::message::stream::StreamSegment;

/// Events emitted by [`RiftClient`](super::RiftClient) via its broadcast channel.
///
/// Obtain a receiver with [`RiftClient::subscribe_events`](super::RiftClient::subscribe_events).
#[derive(Debug, Clone)]
pub enum ClientEvent {
    /// Connection established — Ready frame received.
    Connected {
        /// Server-assigned session ID.
        session_id: String,
        /// Session epoch.
        epoch: u32,
    },

    /// Connection lost.
    Disconnected {
        /// WebSocket close code.
        code: u16,
        /// Human-readable close reason.
        reason: String,
    },

    /// Business event on a subscribed topic.
    EventReceived {
        /// The topic the event was published to.
        topic: String,
        /// The decoded event payload.
        event: Event,
    },

    /// Command reply received.
    ReplyReceived {
        /// The decoded reply.
        reply: Reply,
    },

    /// State message received.
    StateReceived {
        /// The topic the state update targets.
        topic: String,
        /// The decoded state payload.
        state: State,
    },

    /// Datagram received.
    DatagramReceived {
        /// The topic the datagram was sent to.
        topic: String,
        /// The decoded datagram payload.
        datagram: Datagram,
    },

    /// Stream segment received.
    StreamReceived {
        /// The topic the stream belongs to.
        topic: String,
        /// The decoded stream segment.
        segment: StreamSegment,
    },

    /// Snapshot received.
    SnapshotReceived {
        /// The topic the snapshot belongs to.
        topic: String,
        /// The decoded snapshot payload.
        snapshot: Snapshot,
    },

    /// System message received.
    System {
        /// The system event name.
        event_name: String,
        /// The event payload.
        payload: serde_json::Value,
    },

    /// Server acknowledgement received.
    AckReceived {
        /// The message ID that was acknowledged.
        message_id: String,
        /// The acknowledgement status.
        status: AckStatus,
    },

    /// Pong received from server.
    Pong {
        /// Server-reported timestamp (milliseconds since epoch).
        timestamp: i64,
    },

    /// Protocol or transport error.
    Error(String),

    /// Client is about to attempt a reconnect.
    Reconnecting {
        /// The current reconnect attempt number (1-indexed).
        attempt: u32,
    },
}