edgy-s 1.4.0

A minimalist WebSocket bidirectional RPC framework for building microservice applications
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

use {
    super::{
        super::types::{AtomicReqId, Packet},
        Command, IoError, IoResult, WsAccessor,
    },
    serde::{Deserialize, Serialize},
    std::{
        collections::HashMap,
        sync::{LazyLock, atomic::Ordering},
    },
    tokio::sync::{Mutex, mpsc::WeakSender, oneshot::channel as oneshot_channel},
};

pub(super) static BIND_SENDERS: LazyLock<Mutex<HashMap<String, WeakSender<Command>>>> =
    LazyLock::new(Default::default);

/// Trait for calling remote functions via WebSocket from the server side.
///
/// This trait allows the server to call a function on a connected client
/// through a WebSocket connection. The arguments are serialized and sent
/// to the client, and the return value is received back.
///
/// # Example
/// ```ignore
/// let result: i32 = (1, 2).call_remotely(&ws_accessor).await?;
/// ```
pub trait WsCaller<Args, Ret, S = ()> {
    /// Calls a remote function on a specific client connection.
    ///
    /// The `target` specifies which client connection to send the request to.
    fn call_remotely<T>(self, target: T) -> impl Future<Output = IoResult<Ret>>
    where
        T: AsRef<WsAccessor<S>>;
}

impl<Args, Ret, S> WsCaller<Args, Ret, S> for Args
where
    Args: for<'a> Deserialize<'a> + Serialize,
    Ret: for<'a> Deserialize<'a> + Serialize,
{
    async fn call_remotely<T>(self, target: T) -> IoResult<Ret>
    where
        T: AsRef<WsAccessor<S>>,
    {
        static AUTO_ID: AtomicReqId = AtomicReqId::new(0);

        let path = target.as_ref().path();
        let socket_addr = target.as_ref().get_addr();
        let Some(command) = BIND_SENDERS.lock().await.get(path).cloned() else {
            return Err(IoError::other(format!(
                "The connection with the `{}` address cannot be sent to the `{}` path to call the remote function, because the function is not bound to the server.",
                socket_addr, path,
            )));
        };
        let Some(command) = command.upgrade() else {
            return Err(IoError::other("The command channel has been dropped."));
        };

        let req_id = AUTO_ID
            .fetch_update(Ordering::SeqCst, Ordering::SeqCst, |v| {
                Some(v.wrapping_add(1))
            })
            .unwrap_or_default();
        let (tx, rx) = oneshot_channel();
        command
            .send(Command::CallRemotely {
                path: path.to_owned(),
                socket_addr,
                id: req_id,
                msg: Packet::<Args, Ret>::make_call_message(req_id, self)?,
                ret_tx: tx,
            })
            .await
            .map_err(IoError::other)?;

        match Packet::<Args, Ret>::from_message(&rx.await.map_err(IoError::other)??)? {
            Packet::Ret(id, _) if id != req_id => Err(IoError::other(format!(
                "The received message ID does not match the request ID: {} != {}",
                id, req_id
            ))),
            Packet::Ret(_id, ret) => Ok(ret),
            _ => Err(IoError::other("Unable to decode packet.")),
        }
    }
}