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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
//! A websocket client library which supports both desktop and webassembly.
//! It's only been tested on Linux and wasm32-unknown-emscripten, but should
//! work on other desktop platforms and other webassembly targets.
//!
//! It uses a polling API for receiving messages, so it's probably most
//! suitable for games, which would poll every frame. It may not be suitable
//! for applications which need to respond to messages within milliseconds of
//! receiving them, since the polling would add a slight delay.
//!
//! This supports both text and binary data. On desktop, it uses `websocket`. On
//! webassembly, it uses JavaScript through `stdweb`.

// Needed for js! macro
#![recursion_limit = "256"]

// TODO: see if there's a way to remove all these cfg's
#[cfg(not(target_arch = "wasm32"))]
extern crate websocket;
#[cfg(target_arch = "wasm32")]
#[macro_use]
extern crate stdweb;
#[cfg(target_arch = "wasm32")]
extern crate simple_error;

#[cfg(target_arch = "wasm32")]
use simple_error::*;
#[cfg(target_arch = "wasm32")]
use std::cell::RefCell;
use std::error::Error;
#[cfg(not(target_arch = "wasm32"))]
use std::io::ErrorKind;
#[cfg(target_arch = "wasm32")]
use std::rc::Rc;
#[cfg(target_arch = "wasm32")]
use stdweb::web;
#[cfg(target_arch = "wasm32")]
use stdweb::Value;
#[cfg(not(target_arch = "wasm32"))]
use websocket::client::sync::Client;
#[cfg(not(target_arch = "wasm32"))]
use websocket::stream::sync::NetworkStream;
#[cfg(not(target_arch = "wasm32"))]
use websocket::*;
#[cfg(not(target_arch = "wasm32"))]
use std::marker::PhantomData;

#[derive(Debug, Clone)]
pub enum SocketMessage {
    Text(String),
    Binary(Vec<u8>),
}

#[cfg(target_arch = "wasm32")]
struct SocketState {
    // TODO: clean this up. Probably put everything in a single RefCell.
    queued: Rc<RefCell<Vec<SocketMessage>>>,
    received: Rc<RefCell<Vec<SocketMessage>>>,
    disconnected: Rc<RefCell<bool>>,
    error: Rc<RefCell<bool>>,
}

#[cfg(target_arch = "wasm32")]
pub struct Socket {
    js_obj: stdweb::Value,
    state: SocketState,
}

// TODO: see if there's a way to merge these impls so they can't accidentally get out of sync
#[cfg(target_arch = "wasm32")]
impl Socket {
    /// Creates a new Socket.
    pub fn new(url: String) -> Result<Socket, Box<Error>> {
        stdweb::initialize();

        let state = SocketState {
            queued: Rc::new(RefCell::new(vec![])),
            received: Rc::new(RefCell::new(vec![])),
            disconnected: Rc::new(RefCell::new(false)),
            error: Rc::new(RefCell::new(false)),
        };

        let queued = state.queued.clone();
        let received = state.received.clone();
        let received2 = state.received.clone();
        let disconnected = state.disconnected.clone();
        let error = state.error.clone();

        let get_queued = move || -> stdweb::Array {
            let mut queued = queued.borrow_mut();
            let queued: Vec<Value> = queued
                .drain(..)
                .map(|x| match x {
                    SocketMessage::Text(data) => Value::String(data),
                    SocketMessage::Binary(data) => {
                        let typed_array = web::TypedArray::from(&data[..]);
                        let data = typed_array.buffer();
                        stdweb::Value::Reference(stdweb::Reference::from(data))
                    }
                }).collect();
            stdweb::Array::from(queued)
        };

        // TODO: these two closures are never freed. Probably not a big deal though
        // since they're used throughout the life of the app.
        let add_received_text = move |msg: String| {
            let mut received = received.borrow_mut();
            received.push(SocketMessage::Text(msg));
        };
        let add_received_binary = move |msg: web::TypedArray<u8>| {
            let mut received = received2.borrow_mut();
            received.push(SocketMessage::Binary(msg.to_vec()));
        };
        let set_disconnected = move || {
            let mut disconnected = disconnected.borrow_mut();
            *disconnected = true;
        };
        let set_error = move || {
            let mut error = error.borrow_mut();
            *error = true;
        };
        let js_obj = js! {
            var socket = new WebSocket(@{url});
            var get_queued = @{get_queued};
            var add_received_text = @{add_received_text};
            var add_received_binary = @{add_received_binary};
            var set_disconnected = @{set_disconnected};
            var set_error = @{set_error};
            if (socket) {
                socket.binaryType = "arraybuffer";
                socket.onopen = function(e) {
                    var queued = get_queued();
                    for (var i = 0; i < queued.length; i++) {
                        socket.send(queued[i]);
                    }
                    get_queued.drop();
                };
                socket.onerror = function(e) {
                    console.log("Socket error: " + e);
                    set_error();
                };
                socket.onclose = function(e) {
                    console.log("Socket closed");
                    set_disconnected();
                };
                socket.onmessage = function(m) {
                    if (m.data instanceof ArrayBuffer) {
                        add_received_binary(new Uint8Array(m.data));
                    } else {
                        add_received_text(m.data);
                    }
                };
                return socket;
            } else {
                console.log("Unable to create socket.");
                return null;
            }
        };
        if js_obj == stdweb::Value::Null {
            Err(Box::new(SimpleError::new(
                "Unable to create js_obj for socket",
            )))
        } else {
            Ok(Socket { js_obj, state })
        }
    }

    // TODO: the 'send' functions should probably pass borrowed data
    /// Sends a textual message.
    pub fn send(&mut self, data: String) -> Result<(), Box<Error>> {
        let queued = self.state.queued.clone();
        let ready = match js! {
        var socket = @{&self.js_obj};
        if (socket.readyState == 2 || socket.readyState == 3) {
            console.log("Error: socket already closed!");
            // TODO: return error
        }
        return socket.readyState === 1;
        } {
            Value::Bool(bool) => bool,
            _ => panic!("invalid type"),
        };
        if ready {
            js! {
                var data = @{data};
                var socket = @{&self.js_obj};
                socket.send(data);
            };
        } else {
            let mut queued = queued.borrow_mut();
            queued.push(SocketMessage::Text(data));
        }
        Ok(())
    }

    /// Sends a binary message.
    pub fn send_binary(&mut self, data: Vec<u8>) -> Result<(), Box<Error>> {
        let queued = self.state.queued.clone();
        let ready = match js! {
            var socket = @{&self.js_obj};
            if (socket.readyState == 2 || socket.readyState == 3) {
                console.log("Error: socket already closed!");
                // TODO: return error
            }
            return socket.readyState === 1;
        } {
            Value::Bool(bool) => bool,
            _ => panic!("invalid type"),
        };
        if ready {
            let typed_array = web::TypedArray::from(&data[..]);
            let data = typed_array.buffer();
            js! {
                var data = @{data};
                var socket = @{&self.js_obj};
                socket.send(data);
            };
        } else {
            let mut queued = queued.borrow_mut();
            queued.push(SocketMessage::Binary(data));
        }

        Ok(())
    }

    /// Returns all messages that have been received since the last call to
    /// this function.
    ///
    /// Returns `None` if there's be an error or the Socket has been
    /// disconnected, and `Some(vec![])` if no messages have been received.
    /// If this returns `None`, this `Socket` should no longer be used.
    pub fn messages(&mut self) -> Option<Vec<SocketMessage>> {
        let disconnected = self.state.disconnected.borrow();
        let error = self.state.error.borrow();
        if *disconnected || *error {
            None
        } else {
            let mut received = self.state.received.borrow_mut();
            let res = received.drain(..).collect();
            Some(res)
        }
    }
}

#[cfg(target_arch = "wasm32")]
impl Drop for Socket {
    fn drop(&mut self) {
        js! {
            var socket = @{&self.js_obj};
            socket.close();
        }
    }
}

#[cfg(not(target_arch = "wasm32"))]
pub struct Socket {
    client: Client<Box<NetworkStream + Send>>,
    // This is used to mark this type as !Send, to match the wasm version of this
    // struct which can't implement `Send`.
    not_send: PhantomData<*const ()>,
}

#[cfg(not(target_arch = "wasm32"))]
impl Socket {
    /// Creates a new Socket.
    pub fn new(url: String) -> Result<Socket, Box<Error>> {
        let client = ClientBuilder::new(&url)?.connect(None)?;
        // In theory, NetworkStream *should* imply AsTcpStream, but that doesn't seem
        // to work in practice. Possibly a bug in `websocket`.
        client.stream_ref().as_tcp().set_nodelay(true)?;
        client.stream_ref().as_tcp().set_nonblocking(true)?;

        Ok(Socket { client, not_send: PhantomData })
    }

    /// Sends a textual message.
    pub fn send(&mut self, data: String) -> Result<(), Box<Error>> {
        self.client
            .send_message(&message::OwnedMessage::Text(data))?;
        Ok(())
    }

    /// Sends a binary message.
    pub fn send_binary(&mut self, data: Vec<u8>) -> Result<(), Box<Error>> {
        self.client
            .send_message(&message::OwnedMessage::Binary(data))?;
        Ok(())
    }

    /// Returns all messages that have been received since the last call to
    /// this function.
    ///
    /// Returns `None` if there's be an error or the Socket has been
    /// disconnected, and `Some(vec![])` if no messages have been received.
    /// If this returns `None`, this `Socket` should no longer be used.
    pub fn messages(&mut self) -> Option<Vec<SocketMessage>> {
        let mut res = vec![];
        loop {
            match self.client.recv_message() {
                Ok(message) => {
                    match message {
                        message::OwnedMessage::Text(msg) => res.push(SocketMessage::Text(msg)),
                        message::OwnedMessage::Binary(msg) => res.push(SocketMessage::Binary(msg)),
                        message::OwnedMessage::Ping(data) => {
                            self.client
                                .send_message(&message::OwnedMessage::Pong(data))
                                .unwrap();
                        }
                        message::OwnedMessage::Close(_) => {
                            return None;
                        }
                        other => panic!("Unsupported message type: {:?}", other),
                    };
                }
                Err(err) => match err {
                    WebSocketError::IoError(ref err) if err.kind() == ErrorKind::WouldBlock => {
                        break;
                    }
                    _ => {
                        return None;
                    }
                },
            }
        }
        Some(res)
    }
}