convex 0.10.4

Client library for Convex (convex.dev)
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

use async_trait::async_trait;
use convex_sync_types::{
    ClientMessage,
    Timestamp,
};
use tokio::sync::mpsc;
use url::Url;

use crate::value::Value;

#[cfg(any(test, feature = "testing"))]
pub mod testing;
pub mod web_socket_manager;

/// Upon a protocol failure, an explanation of the failure to pass in on
/// reconnect
#[derive(Debug)]
pub struct ReconnectRequest {
    pub reason: ReconnectProtocolReason,
    pub max_observed_timestamp: Option<Timestamp>,
}

pub type ReconnectProtocolReason = String;

pub type ServerMessage = convex_sync_types::ServerMessage<Value>;

#[derive(Debug)]
pub enum ProtocolResponse {
    ServerMessage(ServerMessage),
    Failure,
}

#[derive(Debug)]
/// The state of the Convex WebSocket connection
pub enum WebSocketState {
    /// The WebSocket is open and connected
    Connected,
    /// The WebSocket is closed and connecting/reconnecting
    Connecting,
}

#[async_trait]
pub trait SyncProtocol: Send + Sized {
    async fn open(
        ws_url: Url,
        on_response: mpsc::Sender<ProtocolResponse>,
        on_state_change: Option<mpsc::Sender<WebSocketState>>,
        client_id: &str,
    ) -> anyhow::Result<Self>;
    async fn send(&mut self, message: ClientMessage) -> anyhow::Result<()>;
    async fn reconnect(&mut self, request: ReconnectRequest);
}