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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
pub mod builder; pub mod frame; mod handshake; mod parsed_addr; pub mod split; mod stream; use crate::error::WebSocketError; use builder::WebSocketBuilder; use frame::Frame; use split::{WebSocketReadHalf, WebSocketWriteHalf}; #[derive(Debug)] enum FrameType { Text, Binary, Control, } impl Default for FrameType { fn default() -> Self { Self::Control } } /// Manages the WebSocket connection; used to connect, send data, and receive data. /// /// Connect with [`WebSocket::connect()`]: /// /// ``` /// # use websockets::{WebSocket, WebSocketError}; /// # #[tokio::main] /// # async fn main() -> Result<(), WebSocketError> { /// let mut ws = WebSocket::connect("wss://echo.websocket.org/").await?; /// # Ok(()) /// # } /// ``` /// /// Cuustomize the handshake using a [`WebSocketBuilder`] obtained from [`WebSocket::builder()`]: /// /// ``` /// # use websockets::{WebSocket, WebSocketError}; /// # #[tokio::main] /// # async fn main() -> Result<(), WebSocketError> { /// let mut ws = WebSocket::builder() /// .add_subprotocol("wamp") /// .connect("wss://echo.websocket.org") /// .await?; /// # Ok(()) /// # } /// ``` /// /// Use the `WebSocket::send*` methods to send frames: /// /// ``` /// # use websockets::{WebSocket, WebSocketError}; /// # #[tokio::main] /// # async fn main() -> Result<(), WebSocketError> { /// # let mut ws = WebSocket::connect("wss://echo.websocket.org") /// # .await?; /// ws.send_text("foo".to_string()).await?; /// # Ok(()) /// # } /// ``` /// /// Use [`WebSocket::receive()`] to receive frames: /// /// ``` /// # use websockets::{WebSocket, WebSocketError, Frame}; /// # #[tokio::main] /// # async fn main() -> Result<(), WebSocketError> { /// # let mut ws = WebSocket::connect("wss://echo.websocket.org") /// # .await?; /// # ws.send_text("foo".to_string()).await?; /// if let Frame::Text { payload: received_msg, .. } = ws.receive().await? { /// // echo.websocket.org echoes text frames /// assert_eq!(received_msg, "foo".to_string()); /// } /// # else { panic!() } /// # Ok(()) /// # } /// ``` /// /// Close the connection with [`WebSocket::close()`]: /// /// ``` /// # use websockets::{WebSocket, WebSocketError, Frame}; /// # #[tokio::main] /// # async fn main() -> Result<(), WebSocketError> { /// # let mut ws = WebSocket::connect("wss://echo.websocket.org") /// # .await?; /// ws.close(Some((1000, String::new()))).await?; /// if let Frame::Close{ payload: Some((status_code, _reason)) } = ws.receive().await? { /// assert_eq!(status_code, 1000); /// } /// # Ok(()) /// # } /// ``` /// /// # Splitting /// /// To facilitate simulataneous reads and writes, the `WebSocket` can be split /// into a [read half](WebSocketReadHalf) and a [write half](WebSocketWriteHalf). /// The read half allows frames to be received, while the write half /// allows frames to be sent. /// /// If the read half receives a Ping or Close frame, it needs to send a /// Pong or echo the Close frame and close the WebSocket, respectively. /// The write half is notified of these events, but it cannot act on them /// unless it is flushed. Events can be explicitly [`flush`](WebSocketWriteHalf::flush())ed, /// but sending a frame will also flush events. If frames are not being /// sent frequently, consider explicitly flushing events. /// /// Flushing is done automatically if you are using the the `WebSocket` type by itself. #[derive(Debug)] pub struct WebSocket { read_half: WebSocketReadHalf, write_half: WebSocketWriteHalf, accepted_subprotocol: Option<String>, handshake_response_headers: Option<Vec<(String, String)>>, } impl WebSocket { /// Constructs a [`WebSocketBuilder`], which can be used to customize /// the WebSocket handshake. pub fn builder() -> WebSocketBuilder { WebSocketBuilder::new() } /// Connects to a URL (and performs the WebSocket handshake). pub async fn connect(url: &str) -> Result<Self, WebSocketError> { WebSocketBuilder::new().connect(url).await } /// Receives a [`Frame`] over the WebSocket connection. /// /// If the received frame is a Ping frame, a Pong frame will be sent. /// If the received frame is a Close frame, an echoed Close frame /// will be sent and the WebSocket will close. pub async fn receive(&mut self) -> Result<Frame, WebSocketError> { let received_frame = self.read_half.receive().await?; self.write_half.flush().await?; Ok(received_frame) } /// Receives a [`Frame`] over the WebSocket connection **without handling incoming frames.** /// For example, receiving a Ping frame will not queue a Pong frame to be sent, /// and receiving a Close frame will not queue a Close frame to be sent nor close /// the connection. /// /// To automatically handle incoming frames, use the [`receive()`](WebSocket::receive()) /// method instead. pub async fn receive_without_handling(&mut self) -> Result<Frame, WebSocketError> { self.read_half.receive_without_handling().await } /// Sends an already constructed [`Frame`] over the WebSocket connection. pub async fn send(&mut self, frame: Frame) -> Result<(), WebSocketError> { self.write_half.send(frame).await } /// Sends a Text frame over the WebSocket connection, constructed /// from passed arguments. `continuation` will be `false` and `fin` will be `true`. /// To use a custom `continuation` or `fin`, construct a [`Frame`] and use /// [`WebSocket::send()`]. pub async fn send_text(&mut self, payload: String) -> Result<(), WebSocketError> { self.write_half.send_text(payload).await } /// Sends a Binary frame over the WebSocket connection, constructed /// from passed arguments. `continuation` will be `false` and `fin` will be `true`. /// To use a custom `continuation` or `fin`, construct a [`Frame`] and use /// [`WebSocket::send()`]. pub async fn send_binary(&mut self, payload: Vec<u8>) -> Result<(), WebSocketError> { self.write_half.send_binary(payload).await } /// Sends a Close frame over the WebSocket connection, constructed /// from passed arguments, and closes the WebSocket connection. /// This method will attempt to wait for an echoed Close frame, /// which is returned. pub async fn close(&mut self, payload: Option<(u16, String)>) -> Result<(), WebSocketError> { self.write_half.close(payload).await } /// Sends a Ping frame over the WebSocket connection, constructed /// from passed arguments. pub async fn send_ping(&mut self, payload: Option<Vec<u8>>) -> Result<(), WebSocketError> { self.write_half.send_ping(payload).await } /// Sends a Pong frame over the WebSocket connection, constructed /// from passed arguments. pub async fn send_pong(&mut self, payload: Option<Vec<u8>>) -> Result<(), WebSocketError> { self.write_half.send_pong(payload).await } /// Shuts down the WebSocket connection **without sending a Close frame**. /// It is recommended to use the [`close()`](WebSocket::close()) method instead. pub async fn shutdown(&mut self) -> Result<(), WebSocketError> { self.write_half.shutdown().await } /// Splits the WebSocket into a read half and a write half, which can be used separately. /// [Accepted subprotocol](WebSocket::accepted_subprotocol()) /// and [handshake response headers](WebSocket::handshake_response_headers()) data /// will be lost. pub fn split(self) -> (WebSocketReadHalf, WebSocketWriteHalf) { (self.read_half, self.write_half) } /// Joins together a split read half and write half to reconstruct a WebSocket. pub fn join(read_half: WebSocketReadHalf, write_half: WebSocketWriteHalf) -> Self { Self { read_half, write_half, accepted_subprotocol: None, handshake_response_headers: None, } } /// Returns the subprotocol that was accepted by the server during the handshake, /// if any. This data will be lost if the WebSocket is [`split`](WebSocket::split()). pub fn accepted_subprotocol(&self) -> &Option<String> { // https://tools.ietf.org/html/rfc6455#section-1.9 &self.accepted_subprotocol } /// Returns the headers that were returned by the server during the handshake. /// This data will be lost if the WebSocket is [`split`](WebSocket::split()). pub fn handshake_response_headers(&self) -> &Option<Vec<(String, String)>> { // https://tools.ietf.org/html/rfc6455#section-4.2.2 &self.handshake_response_headers } }