s9_websocket 0.0.2

A simple client library for blocking and non-blocking WebSockets.
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

use std::time::Duration;
use crate::error::{S9Result, S9WebSocketError};

// ============================================================================
// Configuration options
// ============================================================================

#[derive(Debug, Clone, Default)]
pub(crate) struct SharedOptions {
    pub(crate) spin_wait_duration: Option<Duration>,
    pub(crate) nodelay: Option<bool>,
    pub(crate) ttl: Option<u32>,
}

/// Configuration options for the non-blocking WebSocket client.
#[derive(Debug, Clone, Default)]
pub struct NonBlockingOptions {
    pub(crate) shared: SharedOptions,
}

impl NonBlockingOptions {
    /// Creates a new `NonBlockingOptions` with default values.
    ///
    /// All options are set to their defaults. Use builder methods to configure.
    pub fn new() -> Self {
        Self::default()
    }

    /// Sets the sleep duration between event loop iterations.
    ///
    /// - `None`: Maximum performance, 100% CPU usage (busy spin loop)
    /// - `Some(duration)`: Sleeps between iterations, reduces CPU usage
    ///
    /// Duration must be greater than zero if specified.
    pub fn spin_wait_duration(mut self, duration: Option<Duration>) -> S9Result<Self> {
        if let Some(duration) = duration {
            if duration.is_zero() {
                return Err(S9WebSocketError::InvalidConfiguration("Spin wait duration cannot be zero".to_string()).into());
            }
        }
        self.shared.spin_wait_duration = duration;
        Ok(self)
    }

    /// Enables or disables the `TCP_NODELAY` option for messages to be sent.
    pub fn nodelay(mut self, nodelay: bool) -> Self {
        self.shared.nodelay = Some(nodelay);
        self
    }

    /// Sets the TTL (Time To Live, # of hops) for the socket.
    /// None for the system default
    pub fn ttl(mut self, ttl: Option<u32>) -> S9Result<Self> {
        self.shared.ttl = ttl;
        Ok(self)
    }
}

/// Configuration options for the blocking WebSocket client.
#[derive(Debug, Clone, Default)]
pub struct BlockingOptions {
    pub(crate) shared: SharedOptions,
    pub(crate) read_timeout: Option<Duration>,
    pub(crate) write_timeout: Option<Duration>,
}

impl BlockingOptions {
    /// Creates a new `BlockingOptions` with default values.
    ///
    /// All options are set to their defaults. Use builder methods to configure.
    pub fn new() -> Self {
        Self::default()
    }

    /// Sets the sleep duration between event loop iterations.
    ///
    /// - `None`: No sleep (only meaningful with read/write timeouts)
    /// - `Some(duration)`: Sleeps between iterations, reduces CPU usage
    ///
    /// Duration must be greater than zero if specified.
    pub fn spin_wait_duration(mut self, duration: Option<Duration>) -> S9Result<Self> {
        if let Some(duration) = duration {
            if duration.is_zero() {
                return Err(S9WebSocketError::InvalidConfiguration("Spin wait duration cannot be zero".to_string()).into());
            }
        }
        self.shared.spin_wait_duration = duration;
        Ok(self)
    }

    /// Enables or disables the `TCP_NODELAY` option for messages to be sent.
    pub fn nodelay(mut self, nodelay: bool) -> Self {
        self.shared.nodelay = Some(nodelay);
        self
    }

    /// Sets the TTL (Time To Live, # of hops) for the socket.
    /// None for the system default
    pub fn ttl(mut self, ttl: Option<u32>) -> S9Result<Self> {
        self.shared.ttl = ttl;
        Ok(self)
    }

    /// Sets the read timeout for the socket.
    /// Must be None for the indefinitely blocking of socket read or greater than zero
    pub fn read_timeout(mut self, timeout: Option<Duration>) -> S9Result<Self> {
        if let Some(timeout) = timeout {
            if timeout.is_zero() {
                return Err(S9WebSocketError::InvalidConfiguration("Read timeout duration cannot be zero".to_string()).into());
            }
        }
        self.read_timeout = timeout;
        Ok(self)
    }

    /// Sets the write timeout for the socket.
    /// /// Must be None for the indefinitely blocking of socket write or greater than zero
    pub fn write_timeout(mut self, timeout: Option<Duration>) -> S9Result<Self> {
        if let Some(timeout) = timeout {
            if timeout.is_zero() {
                return Err(S9WebSocketError::InvalidConfiguration("Write timeout duration cannot be zero".to_string()).into());
            }
        }
        self.write_timeout = timeout;
        Ok(self)
    }
}