supabase-client-realtime 0.2.1

Realtime WebSocket client for supabase-client
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use std::sync::atomic::{AtomicU64, Ordering};

use serde_json::{json, Value};

use crate::types::{JoinPayload, PhoenixMessage};

/// Atomic counter for generating unique message reference IDs.
pub(crate) struct RefCounter {
    counter: AtomicU64,
}

impl RefCounter {
    pub fn new() -> Self {
        Self {
            counter: AtomicU64::new(1),
        }
    }

    pub fn next(&self) -> String {
        self.counter.fetch_add(1, Ordering::Relaxed).to_string()
    }
}

/// Build a heartbeat message (sent to topic "phoenix").
pub(crate) fn build_heartbeat(ref_counter: &RefCounter) -> PhoenixMessage {
    PhoenixMessage {
        event: "heartbeat".to_string(),
        topic: "phoenix".to_string(),
        payload: json!({}),
        msg_ref: Some(ref_counter.next()),
        join_ref: None,
    }
}

/// Build a phx_join message for a channel.
pub(crate) fn build_join(
    topic: &str,
    join_payload: &JoinPayload,
    ref_counter: &RefCounter,
) -> PhoenixMessage {
    let ref_id = ref_counter.next();
    PhoenixMessage {
        event: "phx_join".to_string(),
        topic: topic.to_string(),
        payload: serde_json::to_value(join_payload).unwrap_or(json!({})),
        msg_ref: Some(ref_id.clone()),
        join_ref: Some(ref_id),
    }
}

/// Build a phx_leave message for a channel.
pub(crate) fn build_leave(
    topic: &str,
    join_ref: &str,
    ref_counter: &RefCounter,
) -> PhoenixMessage {
    PhoenixMessage {
        event: "phx_leave".to_string(),
        topic: topic.to_string(),
        payload: json!({}),
        msg_ref: Some(ref_counter.next()),
        join_ref: Some(join_ref.to_string()),
    }
}

/// Build a broadcast message.
pub(crate) fn build_broadcast(
    topic: &str,
    event: &str,
    payload: Value,
    join_ref: &str,
    ref_counter: &RefCounter,
) -> PhoenixMessage {
    PhoenixMessage {
        event: "broadcast".to_string(),
        topic: topic.to_string(),
        payload: json!({
            "event": event,
            "payload": payload,
            "type": "broadcast",
        }),
        msg_ref: Some(ref_counter.next()),
        join_ref: Some(join_ref.to_string()),
    }
}

/// Build a presence track message.
pub(crate) fn build_presence_track(
    topic: &str,
    payload: Value,
    join_ref: &str,
    ref_counter: &RefCounter,
) -> PhoenixMessage {
    PhoenixMessage {
        event: "presence".to_string(),
        topic: topic.to_string(),
        payload: json!({
            "type": "presence",
            "event": "track",
            "payload": payload,
        }),
        msg_ref: Some(ref_counter.next()),
        join_ref: Some(join_ref.to_string()),
    }
}

/// Build a presence untrack message.
pub(crate) fn build_presence_untrack(
    topic: &str,
    join_ref: &str,
    ref_counter: &RefCounter,
) -> PhoenixMessage {
    PhoenixMessage {
        event: "presence".to_string(),
        topic: topic.to_string(),
        payload: json!({
            "type": "presence",
            "event": "untrack",
        }),
        msg_ref: Some(ref_counter.next()),
        join_ref: Some(join_ref.to_string()),
    }
}

/// Build an access_token refresh message.
pub(crate) fn build_access_token(
    topic: &str,
    token: &str,
    join_ref: &str,
    ref_counter: &RefCounter,
) -> PhoenixMessage {
    PhoenixMessage {
        event: "access_token".to_string(),
        topic: topic.to_string(),
        payload: json!({ "access_token": token }),
        msg_ref: Some(ref_counter.next()),
        join_ref: Some(join_ref.to_string()),
    }
}