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

use std::sync::Arc;

use anyhow::Result;
use serde::Serialize;
pub use wsio_core as core;

pub mod builder;
mod config;
pub mod connection;
pub mod namespace;
mod request;
pub mod request_adapters;
mod runtime;

#[cfg(feature = "tower")]
use crate::request_adapters::tower::layer::WsIoServerLayer;
use crate::{
    builder::WsIoServerBuilder,
    namespace::{
        WsIoServerNamespace,
        builder::WsIoServerNamespaceBuilder,
    },
    runtime::WsIoServerRuntime,
};

// Structs
#[derive(Clone)]
pub struct WsIoServer(Arc<WsIoServerRuntime>);

impl WsIoServer {
    // Public methods
    pub fn builder() -> WsIoServerBuilder {
        WsIoServerBuilder::new()
    }

    pub async fn close_all(&self) {
        self.0.close_all().await
    }

    #[inline]
    pub fn connection_count(&self) -> usize {
        self.0.connection_count()
    }

    pub async fn disconnect_all(&self) {
        self.0.disconnect_all().await
    }

    pub async fn emit<D: Serialize>(&self, event: impl AsRef<str>, data: Option<&D>) -> Result<()> {
        self.0.emit(event.as_ref(), data).await
    }

    #[cfg(feature = "tower")]
    pub fn layer(&self) -> WsIoServerLayer {
        WsIoServerLayer::new(self.0.clone())
    }

    #[inline]
    pub fn of(&self, path: impl AsRef<str>) -> Option<Arc<WsIoServerNamespace>> {
        self.0.get_namespace(path.as_ref())
    }

    #[inline]
    pub fn namespace_count(&self) -> usize {
        self.0.namespace_count()
    }

    #[inline]
    pub fn new_namespace_builder(&self, path: impl AsRef<str>) -> WsIoServerNamespaceBuilder {
        self.0.new_namespace_builder(path.as_ref())
    }

    pub async fn remove_namespace(&self, path: impl AsRef<str>) {
        self.0.remove_namespace(path.as_ref()).await
    }

    pub async fn shutdown(&self) {
        self.0.shutdown().await
    }
}