wsio-server 0.12.2

Async WebSocket server framework for ws.io — provides event-based real-time messaging, namespaces, and room-like broadcasting.
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
140
141
142
143
144
145
146
147
148
149
150
151

use std::{
    collections::HashSet,
    sync::Arc,
};

use anyhow::Result;
use futures_util::{
    StreamExt,
    future::ready,
    stream::iter,
};
use roaring::RoaringTreemap;
use serde::Serialize;

use super::super::{
    NamespaceStatus,
    WsIoServerNamespace,
};
use crate::{
    connection::WsIoServerConnection,
    core::packet::WsIoPacket,
};

// Structs
#[derive(Clone)]
pub struct WsIoServerNamespaceBroadcastOperator {
    exclude_connection_ids: HashSet<u64>,
    exclude_rooms: HashSet<String>,
    include_rooms: HashSet<String>,
    namespace: Arc<WsIoServerNamespace>,
}

impl WsIoServerNamespaceBroadcastOperator {
    #[inline]
    pub(in super::super) fn new(namespace: Arc<WsIoServerNamespace>) -> Self {
        Self {
            exclude_connection_ids: HashSet::new(),
            exclude_rooms: HashSet::new(),
            include_rooms: HashSet::new(),
            namespace,
        }
    }

    // Private methods
    async fn for_each_target_connections<F, Fut>(&self, f: F)
    where
        F: Fn(Arc<WsIoServerConnection>) -> Fut + Send + Sync + 'static,
        Fut: Future<Output = Result<()>> + Send + 'static,
    {
        let mut target_connection_ids = if self.include_rooms.is_empty() {
            (**self.namespace.connection_ids.load()).clone()
        } else {
            let mut connection_ids = RoaringTreemap::new();
            for room_name in &self.include_rooms {
                if let Some(room) = self.namespace.rooms.get(room_name) {
                    connection_ids |= room.value();
                }
            }

            connection_ids
        };

        for room_name in &self.exclude_rooms {
            if let Some(room) = self.namespace.rooms.get(room_name) {
                target_connection_ids -= room.value();
                if target_connection_ids.is_empty() {
                    break;
                }
            }
        }

        for exclude_connection_id in &self.exclude_connection_ids {
            target_connection_ids.remove(*exclude_connection_id);
        }

        if target_connection_ids.is_empty() {
            return;
        }

        iter(target_connection_ids)
            .filter_map(|target_connection_id| {
                ready(
                    self.namespace
                        .connections
                        .get(&target_connection_id)
                        .map(|entry| entry.value().clone()),
                )
            })
            .for_each_concurrent(self.namespace.config.broadcast_concurrency_limit, |connection| async {
                let _ = f(connection).await;
            })
            .await;
    }

    // Public methods
    pub async fn close(self) {
        self.for_each_target_connections(|connection| async move {
            connection.close();
            Ok(())
        })
        .await;
    }

    pub async fn disconnect(self) -> Result<()> {
        let message = self.namespace.encode_packet_to_message(&WsIoPacket::new_disconnect())?;
        self.for_each_target_connections(move |connection| {
            let message = message.clone();
            async move { connection.send_message(message).await }
        })
        .await;

        Ok(())
    }

    pub async fn emit<D: Serialize>(self, event: impl AsRef<str>, data: Option<&D>) -> Result<()> {
        self.namespace.status.ensure(NamespaceStatus::Running, |status| {
            format!("Cannot emit in invalid status: {status:?}")
        })?;

        let message = self.namespace.encode_packet_to_message(&WsIoPacket::new_event(
            event.as_ref(),
            data.map(|data| self.namespace.config.packet_codec.encode_data(data))
                .transpose()?,
        ))?;

        self.for_each_target_connections(move |connection| {
            let message = message.clone();
            async move { connection.emit_event_message(message).await }
        })
        .await;

        Ok(())
    }

    #[inline]
    pub fn except(mut self, room_names: impl IntoIterator<Item = impl Into<String>>) -> Self {
        self.exclude_rooms.extend(room_names.into_iter().map(Into::into));
        self
    }

    pub fn except_connection_ids(mut self, connection_ids: impl IntoIterator<Item = u64>) -> Self {
        self.exclude_connection_ids.extend(connection_ids);
        self
    }

    #[inline]
    pub fn to(mut self, room_names: impl IntoIterator<Item = impl Into<String>>) -> Self {
        self.include_rooms.extend(room_names.into_iter().map(Into::into));
        self
    }
}