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
use std::collections::HashMap;
use std::io::ErrorKind;
use std::net::{Shutdown, SocketAddr, TcpListener, ToSocketAddrs};
use std::time::{Duration};

use anyhow::Result;
use serde::de::DeserializeOwned;
use serde::Serialize;
use socket2::{Domain, Protocol, Socket, Type};

use crate::*;

#[derive(Clone, Debug)]
pub struct ServerConfig {
  pub keep_alive_timeout: Option<Duration>,
}

impl Default for ServerConfig {
  fn default() -> Self {
    Self {
      keep_alive_timeout: None,
    }
  }
}

/// A simple server
///
/// # Examples
/// ## Echo server
/// ```
/// use packets::*;
/// use packets::server::*;
/// use std::net::SocketAddr;
/// use std::time::Instant;
///
/// // Bind the server to localhost at port 60000.
/// let mut server = Server::bind("localhost:60000", &ServerConfig::default()).unwrap();
/// let start_time = Instant::now();
/// loop {
///   server.accept_all(); // Accept all incoming connections.
///
///   // Using String as our packet type for this example, receive all incoming packets along with
///   // their addresses. Any Serde-compatible type can be used as the packet type.
///   let packets: Vec<(SocketAddr, String)> = server.receive_all().unwrap();
///   for (addr, packet) in packets {
///     server.send(addr, &packet); // Echo the data back to the client.
///   }
///
///   // For this example we shut the server down after 1 second.
///   if start_time.elapsed().as_secs() > 1 {
///     break;
///   }
/// }
///
/// server.shutdown(); // Close all connections to the server.
/// ```
#[derive(Debug)]
pub struct Server {
  connections: HashMap<SocketAddr, Connection>,
  pub listener: TcpListener,
}

impl Server {
  /// Attempt to accept a new connection.
  pub fn accept(&mut self) -> Result<Option<SocketAddr>> {
    self.listener.set_nonblocking(true)?;

    match self.listener.accept() {
      Ok((stream, addr)) => {
        let connection = Connection { stream, addr };
        self.connections.insert(addr, connection);
        Ok(Some(addr))
      }
      Err(err) => {
        if err.kind() == ErrorKind::WouldBlock {
          Ok(None)
        } else {
          Err(anyhow::Error::from(err))
        }
      }
    }
  }

  /// Use this function to accept all pending connections.
  pub fn accept_all(&mut self) -> Result<Vec<SocketAddr>> {
    let mut vec = Vec::new();
    loop {
      if let Some(accepted) = self.accept()? {
        vec.push(accepted);
      } else {
        break;
      }
    }
    Ok(vec)
  }

  /// Block until a new connection is accepted.
  pub fn accept_blocking(&mut self) -> Result<SocketAddr> {
    self.listener.set_nonblocking(false)?;
    let (stream, addr) = self.listener.accept()?;
    let connection = Connection { stream, addr };
    self.connections.insert(addr, connection);
    Ok(addr)
  }

  pub fn bind<B: ToSocketAddrs>(addr: B, config: &ServerConfig) -> Result<Server> {
    let socket_addr: SocketAddr = addr.to_socket_addrs()?.nth(0).unwrap();
    let domain = if socket_addr.is_ipv4() {
      Domain::ipv4()
    } else {
      Domain::ipv6()
    };

    let socket_type = Type::stream(); // This means TCP.

    let socket = Socket::new(domain, socket_type,
      Some(Protocol::tcp()))?;
    socket.set_keepalive(config.keep_alive_timeout)?;
    socket.bind(&socket_addr.into())?;
    socket.listen(128)?;

    let listener = socket.into_tcp_listener();
    Ok(Server { connections: HashMap::new(), listener })
  }

  pub fn block_until_receive_from(&mut self, addr: SocketAddr, timeout: Duration) -> Result<PacketReceiveStatus> {
    self.with_connection(addr, |conn| {
      crate::block_until_receive(&mut conn.stream, timeout)
    })
  }

  pub fn connections(&self) -> Vec<&Connection> {
    self.connections.values().collect()
  }

  /// Iterate over connections until we find one that is
  pub fn receive<A: Serialize + DeserializeOwned>(&mut self) -> Result<Option<(SocketAddr, A)>> {
    for conn in self.connections.values_mut() {
      let result: Option<A> = read_packet::<A>(&mut conn.stream, false)?;
      if result.is_some() {
        return Ok(Some((conn.addr, result.unwrap())))
      }
    }

    Ok(None)
  }

  pub fn receive_all<A: Serialize + DeserializeOwned>(&mut self) -> Result<Vec<(SocketAddr, A)>> {
    let mut vec = Vec::new();
    loop {
      if let Some(packet) = self.receive()? {
        vec.push(packet);
      } else {
        break;
      }
    }
    Ok(vec)
  }

  pub fn receive_from<A: Serialize + DeserializeOwned>(&mut self, addr: SocketAddr) -> Result<Option<A>> {
    self.with_connection(addr, |conn| {
      crate::read_packet::<A>(&mut conn.stream, false)
    })
  }

  /// Send a packet to a specific connection identified by its address.
  pub fn send<A: Serialize + DeserializeOwned>(&mut self, addr: SocketAddr, packet: &A) -> Result<()> {
    self.with_connection(addr, |conn| {
      write_packet(&mut conn.stream, packet)?;
      Ok(())
    })
  }

  /// Send a packet to all connections.
  pub fn send_global<A: Serialize + DeserializeOwned>(&mut self, packet: &A) -> Result<()> {
    for conn in self.connections.values_mut() {
      write_packet(&mut conn.stream, packet)?;
    }

    Ok(())
  }

  /// Shuts this server down, closing all connections, then drops this object. The server cannot
  /// be used after it has been shut down as the Server object is moved into this function and then
  /// dropped.
  pub fn shutdown(mut self) -> Result<()> {
    for conn in &mut self.connections.values_mut() {
      conn.stream.shutdown(Shutdown::Both)?;
    }
    Ok(())
  }

  /// Run a closure on a
  pub fn with_connection<A, F>(&mut self, addr: SocketAddr, f: F) -> Result<A> where
    F: FnOnce(&mut Connection) -> Result<A> {

    if let Some(conn) = self.connections.get_mut(&addr) {
      match f(conn) {
        Ok(res) => Ok(res),
        Err(err) => {
          // We had an error sending to this client, so we remove their connection.
          if let Some(io_err) = err.downcast_ref::<std::io::Error>() {
            let kind = io_err.kind();

            // TODO Add more error types here that should remove the connection from our list.
            if kind == ErrorKind::ConnectionAborted {
              self.connections.remove(&addr);
            }
          }

          Err(err)
        }
      }
    } else {
      let kind = ErrorKind::NotConnected;
      Err(anyhow::Error::from(std::io::Error::new(kind, "Connection not found.")))
    }
  }
}

#[cfg(test)]
mod tests {
  use std::time::Duration;

  use super::*;
  use crate::client::*;

  #[test]
  pub fn test_server_send_packet() -> Result<()> {
    let addr = "localhost:60003";
    let mut server = Server::bind(addr, &ServerConfig::default())?;
    let mut client = Client::connect(addr, &ClientConfig::default())?;
    let client_addr = server.accept_blocking()?;
    let packet = 42;
    server.send_global(&packet);
    client.block_until_receive(Duration::from_millis(2000));
    let received_packet = client.receive()?
      .expect("Unable to read packet.");
    assert_eq!(packet, received_packet);

    Ok(())
  }

  #[test]
  pub fn test_server_accept_non_blocking() -> Result<()> {
    let addr = "localhost:60003";
    let mut server = Server::bind(addr, &ServerConfig::default())?;
    let client_addr = server.accept()?;
    assert_eq!(None, client_addr);

    Ok(())
  }

  #[test]
  pub fn test_server_block_until_receive_from_timeout() -> Result<()> {

    let addr = "localhost:60002";
    let mut server = Server::bind(addr, &ServerConfig::default())?;
    let mut client = Client::connect(addr, &ClientConfig::default())?;

    let client_addr = server.accept_blocking()?;

    let start_time = Instant::now();
    let millis = 200;
    let status = server.block_until_receive_from(client_addr, Duration::from_millis(millis))?;
    let elapsed = start_time.elapsed().as_millis();
    let diff = ((elapsed as i64) - (millis as i64)).abs();

    assert_eq!(PacketReceiveStatus::TimedOut, status);
    assert!(diff < 5);

    Ok(())
  }

  #[test]
  pub fn test_server_connection_lost() -> Result<()> {

    let addr = "localhost:60007";
    let mut server = Server::bind(addr, &ServerConfig::default())?;
    let mut client = Client::connect(addr, &ClientConfig::default())?;
    let client_addr = server.accept_blocking()?;
    assert_eq!(1, server.connections().len());
    client.shutdown();

    // Give the client a second to shut down.
    std::thread::sleep(Duration::from_secs(1));

    // Attempt to send to the client, causing it to be removed when the connection doesn't work out.
    server.send(client_addr, &42)
      .expect_err("Expected Err here.");

    assert_eq!(0, server.connections().len());

    Ok(())
  }

  #[test]
  pub fn test_server_non_blocking_receive_fail() -> Result<()> {
    let addr = "localhost:60006";
    let mut server = Server::bind(addr, &ServerConfig::default())?;
    let mut client = Client::connect(addr, &ClientConfig::default())?;

    // Attempt to receive when there is nothing to receive.
    let res: Option<(SocketAddr, Vec<u8>)> = server.receive()?;
    assert_eq!(None, res);

    Ok(())
  }

  #[test]
  pub fn test_server_shutdown() -> Result<()> {
    let addr = "localhost:60004";
    let mut server = Server::bind(addr, &ServerConfig::default())?;
    let mut client = Client::connect(addr, &ClientConfig::default())?;
    let client_addr = server.accept_blocking()?;
    assert_eq!(1, server.connections().len());
    server.shutdown();

    // Give the server a second to shut down.
    std::thread::sleep(Duration::from_secs(1));

    // Attempt to send to the client, causing it to be removed when the connection doesn't work out.
    client.send(&42)
      .expect_err("Expected Err here.");
    assert!(!client.is_connected());

    Ok(())
  }
}