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

//! defines a builder-style config struct for setting up websockets

/// A builder-style config struct for setting up websockets.
#[derive(Debug)]
pub struct WebsocketConfig {
    /// Scheme to use for urls - e.g. "ws" or "wss". [default = "ws"]
    pub scheme: &'static str,

    /// Seconds after which the lib will stop tracking individual request ids.
    /// [default = 30]
    pub default_request_timeout_s: usize,

    /// We will treat the socket as disconnected if we receive no messages
    /// in this timeframe, using the tcp keepalive mechanism.
    /// [default = 10]
    pub tcp_keepalive_s: usize,

    /// How many items are allowed in the outgoing queue. [default = 10]
    pub max_send_queue: usize,

    /// Maximum total message size of a websocket message. [default = 64M]
    pub max_message_size: usize,

    /// Maximum websocket frame size. [default = 16M]
    pub max_frame_size: usize,

    /// Maximum number of pending new incoming connections. [default = 255]
    pub max_pending_connections: usize,
}

impl Default for WebsocketConfig {
    fn default() -> Self {
        Self {
            scheme: "ws",
            default_request_timeout_s: 30,
            tcp_keepalive_s: 30,
            max_send_queue: 10,
            max_message_size: 64 << 20,
            max_frame_size: 16 << 20,
            max_pending_connections: 255,
        }
    }
}

impl WebsocketConfig {
    /// Builder-style setter.
    pub fn scheme(mut self, scheme: &'static str) -> Self {
        self.scheme = scheme;
        self
    }

    /// Builder-style setter.
    pub fn default_request_timeout_s(mut self, s: usize) -> Self {
        self.default_request_timeout_s = s;
        self
    }

    /// Builder-style setter.
    pub fn tcp_keepalive_s(mut self, s: usize) -> Self {
        self.tcp_keepalive_s = s;
        self
    }

    /// Builder-style setter.
    pub fn max_send_queue(mut self, max: usize) -> Self {
        self.max_send_queue = max;
        self
    }

    /// Builder-style setter.
    pub fn max_message_size(mut self, max: usize) -> Self {
        self.max_message_size = max;
        self
    }

    /// Builder-style setter.
    pub fn max_frame_size(mut self, max: usize) -> Self {
        self.max_frame_size = max;
        self
    }
}

/// internal helper to convert our configs into tungstenite configs
pub(crate) trait TungsteniteConfigExt {
    /// generate a low-level tungstenite config from our high-level config
    fn to_tungstenite(&self) -> tungstenite::protocol::WebSocketConfig;
}

impl TungsteniteConfigExt for WebsocketConfig {
    fn to_tungstenite(&self) -> tungstenite::protocol::WebSocketConfig {
        tungstenite::protocol::WebSocketConfig {
            max_send_queue: Some(self.max_send_queue),
            max_message_size: Some(self.max_message_size),
            max_frame_size: Some(self.max_frame_size),
            ..Default::default()
        }
    }
}