tcpnet 0.1.1

A simple TCP-based message transport for games that runs on Tokio
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
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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
use std::{
    collections::HashMap,
    error::Error,
    fmt,
    io::{self, ErrorKind},
    net::SocketAddr,
};
use tokio::{
    io::AsyncReadExt,
    net::{
        tcp::{OwnedReadHalf, OwnedWriteHalf},
        TcpListener,
    },
    runtime::Runtime,
    sync::mpsc,
    task::JoinHandle,
};

use crate::common::{write_data, MessageQueue};

/* -------------------------------------------------------------------------- */
/*                                   PUBLIC                                   */
/* -------------------------------------------------------------------------- */

/// Indicates that the server isn't running.
#[derive(Debug)]
pub struct NotRunningError;

impl fmt::Display for NotRunningError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "attempting to call not running server")
    }
}

impl Error for NotRunningError {}

/// Represents events received from the server.
#[derive(Clone)]
pub enum Event {
    Connect(SocketAddr),
    Disconnect(SocketAddr),
    Data(SocketAddr, Vec<u8>),
}

/// The server. Run `start()` to start the server, `stop()` to stop it.
pub struct Server {
    handle: Option<ServerHandle>,
    rt: Runtime,
}

#[allow(clippy::new_without_default)]
impl Server {
    /// Creates a new `Server` instance.
    pub fn new() -> Self {
        Self {
            handle: None,
            rt: Runtime::new().unwrap(),
        }
    }

    /// Starts the server with a specified `port`.
    pub fn start(&mut self, port: u16) {
        let handle = self.rt.block_on(async { ServerHandle::new(port) });

        self.handle = Some(handle);
    }

    /// Stops the server.
    pub fn stop(&mut self) {
        self.handle = None;
    }

    /// Disconnects (kicks) a client at `addr`.
    pub fn disconnect(&self, addr: SocketAddr) -> Result<(), Box<dyn Error>> {
        if self.running() {
            self.rt
                .block_on(async { self.handle.as_ref().unwrap().disconnect(addr) })?;
            Ok(())
        } else {
            Err(Box::new(NotRunningError))
        }
    }

    /// Sends bytes to a client at address `addr`.
    /// Doesn't do anything if specified client is not connected.
    pub fn send(&self, addr: SocketAddr, data: Vec<u8>) -> Result<(), NotRunningError> {
        if self.running() {
            self.rt
                .block_on(async { self.handle.as_ref().unwrap().send(addr, data) })?;
            Ok(())
        } else {
            Err(NotRunningError)
        }
    }

    /// Gets the events received since the last `received()` call.
    /// Flushes the internal event buffer.
    pub fn received(&mut self) -> Result<Vec<Event>, NotRunningError> {
        if self.running() {
            self.rt
                .block_on(async { self.handle.as_mut().unwrap().received() })
        } else {
            Err(NotRunningError)
        }
    }

    /// Indicates whether the server is running.
    pub fn running(&self) -> bool {
        match self.handle.as_ref() {
            Some(h) => self.rt.block_on(async { h.running() }),
            None => false,
        }
    }
}

/* -------------------------------------------------------------------------- */
/*                                   PRIVATE                                  */
/* -------------------------------------------------------------------------- */

enum ServerMessage {
    Stop,
    Disconnect(SocketAddr),
    Write(SocketAddr, Vec<u8>),
}

struct ServerHandle {
    tx: mpsc::UnboundedSender<ServerMessage>,
    queue: MessageQueue<Event>,
    handle: JoinHandle<()>,
}

impl ServerHandle {
    fn new(port: u16) -> Self {
        let (tx, rx) = mpsc::unbounded_channel();
        let queue = MessageQueue::new();

        let mut worker = ServerWorker {
            rx,
            port,
            queue: queue.clone(),
        };
        let handle = tokio::spawn(async move { worker.run().await });

        Self { tx, queue, handle }
    }

    fn received(&mut self) -> Result<Vec<Event>, NotRunningError> {
        if self.running() {
            Ok(self.queue.flush())
        } else {
            Err(NotRunningError)
        }
    }

    fn send(&self, addr: SocketAddr, data: Vec<u8>) -> Result<(), NotRunningError> {
        if self.running() {
            let _ = self.tx.send(ServerMessage::Write(addr, data));
            Ok(())
        } else {
            Err(NotRunningError)
        }
    }

    fn disconnect(&self, addr: SocketAddr) -> Result<(), NotRunningError> {
        if self.running() {
            let _ = self.tx.send(ServerMessage::Disconnect(addr));
            Ok(())
        } else {
            Err(NotRunningError)
        }
    }

    fn running(&self) -> bool {
        !self.handle.is_finished()
    }
}

impl Drop for ServerHandle {
    fn drop(&mut self) {
        let _ = self.tx.send(ServerMessage::Stop);
        self.handle.abort();
    }
}

struct ServerWorker {
    rx: mpsc::UnboundedReceiver<ServerMessage>,
    port: u16,
    queue: MessageQueue<Event>,
}

impl ServerWorker {
    async fn run(&mut self) {
        let ln = TcpListener::bind(format!("127.0.0.1:{}", self.port))
            .await
            .unwrap();

        let writer = Writer::new();

        let (stop_tx, mut stop_rx) = mpsc::unbounded_channel();
        let mut listeners = HashMap::<SocketAddr, Listener>::new();

        println!("Listening on port {}", self.port);

        loop {
            tokio::select! {
                res = ln.accept() => {
                    match res {
                        Ok((conn, addr)) => {
                            let (read_half, write_half) = conn.into_split();
                            listeners.insert(addr, Listener::new(addr, read_half, self.queue.clone(), stop_tx.clone()));
                            writer.add(addr, write_half);
                            self.queue.push(Event::Connect(addr));
                            println!("Client at address {} connected", addr);
                        },
                        Err(e) => {
                            eprintln!("Error encountered while accepting connection: {}", e);
                            continue;
                        }
                    }
                },
                Some(msg) = self.rx.recv() => {
                    match msg {
                        ServerMessage::Stop => {
                            eprintln!("Stopping server");

                            // Return drops the writer as well as all listeners.
                            return;
                        },
                        ServerMessage::Disconnect(addr) => {
                            listeners.remove(&addr);
                            writer.remove(addr);
                        },
                        ServerMessage::Write(addr, data) => {
                            writer.write(addr, data);
                        },
                    };
                },
                Some(addr) = stop_rx.recv() => {
                    listeners.remove(&addr);
                    writer.remove(addr);
                    self.queue.push(Event::Disconnect(addr));
                }
            }
        }
    }
}

/* -------------------------------- LISTENER -------------------------------- */

// Stop the listener by dropping it.
struct Listener {
    handle: JoinHandle<()>,
}

impl Listener {
    fn new(
        addr: SocketAddr,
        reader: OwnedReadHalf,
        queue: MessageQueue<Event>,
        stop_tx: mpsc::UnboundedSender<SocketAddr>,
    ) -> Self {
        let mut worker = ListenerWorker {
            addr,
            reader,
            queue: queue.clone(),
            stop_tx,
        };
        let handle = tokio::spawn(async move { worker.run().await });

        Self { handle }
    }
}

impl Drop for Listener {
    fn drop(&mut self) {
        self.handle.abort();
    }
}

struct ListenerWorker {
    addr: SocketAddr,
    reader: OwnedReadHalf,
    queue: MessageQueue<Event>,
    // Channel to send a stop token to
    stop_tx: mpsc::UnboundedSender<SocketAddr>,
}

impl ListenerWorker {
    async fn run(&mut self) {
        loop {
            // Get length of message
            let mut len_buf = [0u8; 4];
            match self.reader.read_exact(len_buf.as_mut_slice()).await {
                Ok(_) => {}
                Err(e) if e.kind() == ErrorKind::UnexpectedEof => break,
                Err(e) => {
                    eprintln!("Error while reading: {}", e);
                    break;
                }
            }
            let len = u32::from_le_bytes(len_buf);

            // Get message with the length len
            let mut buf = vec![0u8; len as usize];
            let n = match self.reader.read_exact(&mut buf).await {
                Ok(n) => n,
                Err(e) if e.kind() == ErrorKind::UnexpectedEof => break,
                Err(e) => {
                    eprintln!("Error while reading: {}", e);
                    break;
                }
            };

            eprintln!("Received {} bytes from {}", n, self.addr);

            self.queue.push(Event::Data(self.addr, buf));
        }

        let _ = self.stop_tx.send(self.addr);
    }
}

/* --------------------------------- WRITER --------------------------------- */

enum WriterMessage {
    Stop,
    Write(SocketAddr, Vec<u8>),
    AddWriter(SocketAddr, OwnedWriteHalf),
    RemoveWriter(SocketAddr),
}

#[derive(Clone)]
struct Writer {
    tx: mpsc::UnboundedSender<WriterMessage>,
}

impl Writer {
    fn new() -> Self {
        let (tx, rx) = mpsc::unbounded_channel();
        let mut worker = WriterWorker { rx };
        tokio::spawn(async move { worker.run().await });

        Self { tx }
    }

    fn write(&self, addr: SocketAddr, data: Vec<u8>) {
        let _ = self.tx.send(WriterMessage::Write(addr, data));
    }

    fn add(&self, addr: SocketAddr, writer: OwnedWriteHalf) {
        let _ = self.tx.send(WriterMessage::AddWriter(addr, writer));
    }

    fn remove(&self, addr: SocketAddr) {
        let _ = self.tx.send(WriterMessage::RemoveWriter(addr));
    }
}

impl Drop for Writer {
    fn drop(&mut self) {
        let _ = self.tx.send(WriterMessage::Stop);
    }
}

struct WriterWorker {
    rx: mpsc::UnboundedReceiver<WriterMessage>,
}

impl WriterWorker {
    async fn run(&mut self) -> io::Result<()> {
        let mut writers = HashMap::<SocketAddr, OwnedWriteHalf>::new();

        while let Some(msg) = self.rx.recv().await {
            match msg {
                WriterMessage::Stop => return Ok(()),
                WriterMessage::Write(addr, data) => Self::write(&mut writers, addr, data).await,
                WriterMessage::AddWriter(addr, writer) => {
                    writers.insert(addr, writer);
                }
                WriterMessage::RemoveWriter(addr) => {
                    writers.remove(&addr);
                }
            };
        }

        Ok(())
    }

    async fn write(
        writers: &mut HashMap<SocketAddr, OwnedWriteHalf>,
        addr: SocketAddr,
        mut data: Vec<u8>,
    ) {
        if let Some(writer) = writers.get_mut(&addr) {
            match write_data(writer, &mut data).await {
                Ok(_) => {
                    println!("Wrote {} bytes to {}", data.len(), addr);
                }
                Err(e) => {
                    eprintln!("Error while writing data: {}", e);
                }
            }
        }
    }
}