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
use crate::aioserver::enhanced_stream::EnhancedStream;
use crate::aioserver::event_channel::{channel, EventedSender};
use crate::aioserver::id_generator::IdGenerator;
use crate::aioserver::worker::WorkerPool;
use crate::request::Request;
use crate::response::Response;

use std::io::ErrorKind;

use log::{error, trace};
use std::ops::Drop;

use std::collections::HashMap;

use std::sync::mpsc::Receiver;
use std::sync::{Arc, Condvar, Mutex};

use mio::net::{TcpListener, TcpStream};

use mio::{Events, Interest, Poll, Token, Waker};

const SERVER: Token = Token(0);
const SHUTDOWN: Token = Token(1);
const DELETE: Token = Token(2);
const WAKER: Token = Token(3);

type Status = Arc<(Mutex<bool>, Condvar)>;
pub(crate) type SafeStream<R> = Arc<Mutex<EnhancedStream<R>>>;

pub(crate) enum LoopTask {
    Shutdown,
    Close(usize),
}

/// Main struct of the crate, represent the http server
pub struct AIOServer<H> {
    handler: Arc<H>,
    pool: WorkerPool<H>,
    receiver: Receiver<LoopTask>,
    handle: ServerHandle,
    poll: mio::Poll,
    server: TcpListener,
}

impl<H> AIOServer<H>
where
    H: Send + Sync + 'static + Fn(&Request) -> Response,
{
    /// Start the server with the given thread pool size and bind to the given address
    /// The given function is executed for each http request received
    ///
    /// # Argument
    ///
    /// * `size` - Number of thread that will be spawned minimum is 1. The total minimum number of thread is 2 :
    /// 1 to handle request and 1 to run the event loop
    /// * `addr` - Address the server will bind to. The format is the same as std::net::TcpListener.
    /// If the address is incorrect or cannot be bound to, the function will panic
    /// * `handler` - function executed for each received http request
    ///
    /// # Example
    ///
    /// Create a simple server that will respond with a HTTP response with status 200, content type header
    /// "text/plain" and body "Hello"
    ///
    /// ```
    /// let server = mini_async_http::AIOServer::new(3, "0.0.0.0:7878", move |request|{
    ///     mini_async_http::ResponseBuilder::empty_200()
    ///         .body(b"Hello")
    ///         .content_type("text/plain")
    ///         .build()
    ///         .unwrap()
    /// });
    /// ```
    pub fn new(size: i32, addr: &str, handler: H) -> AIOServer<H> {
        let handler = Arc::from(handler);
        let poll = Poll::new().unwrap();
        let waker = Arc::new(Waker::new(poll.registry(), WAKER).unwrap());
        let (sender, receiver) = channel(waker);
        let pool = WorkerPool::new(handler.clone(), size, sender.clone());
        let server = TcpListener::bind(addr.parse().unwrap()).unwrap();

        AIOServer {
            handler,
            pool,
            poll,
            receiver,
            handle: ServerHandle::new(sender),
            server,
        }
    }

    /// Start the event loop. This call is blocking but you can still interact with the server through the Handle
    ///
    /// # Example
    ///
    /// Create a simple server and then start it.
    /// It is started from another thread as the start call is blocking.
    /// After spawning the thread, wait for the server to be ready and then shut it down
    ///
    /// ```
    /// let mut server = mini_async_http::AIOServer::new(3, "0.0.0.0:7879", move |request|{
    ///     mini_async_http::ResponseBuilder::empty_200()
    ///         .body(b"Hello")
    ///         .content_type("text/plain")
    ///         .build()
    ///         .unwrap()
    /// });
    /// let handle = server.handle();
    ///
    /// std::thread::spawn(move || {
    ///     server.start();
    /// });
    ///
    /// handle.ready();
    /// handle.shutdown();
    ///
    /// ```
    pub fn start(&mut self) {
        let mut map = HashMap::new();

        let mut events = Events::with_capacity(32768);

        let mut gen = IdGenerator::new(4);

        self.poll
            .registry()
            .register(&mut self.server, SERVER, Interest::READABLE)
            .unwrap();

        self.pool.start();

        self.handle.set_ready(true);

        loop {
            trace!("Opened connection: {}", map.len());
            trace!("Connection pool capacity: {}", map.capacity());
            self.poll.poll(&mut events, None).unwrap();

            for event in events.iter() {
                match event.token() {
                    SERVER => loop {
                        let connection = match self.server.accept() {
                            Ok((conn, _)) => conn,
                            Err(ref e) if e.kind() == ErrorKind::WouldBlock => {
                                break;
                            }
                            Err(e) => {
                                error!("Error when accepting conn : {}", e);
                                continue;
                            }
                        };

                        let id = gen.id();
                        let token = Token(id);
                        let mut stream = EnhancedStream::new(id, connection);

                        match self
                            .poll
                            .registry()
                            .register(&mut stream, token, Interest::READABLE)
                        {
                            Ok(_) => {}
                            Err(e) => {
                                if stream.shutdown().is_err() {
                                    trace!("Error when shutting down not registered connection")
                                }
                                error!("Error when registering conn : {}", e);
                                continue;
                            }
                        }

                        let stream = Arc::from(Mutex::from(stream));
                        map.insert(token, stream.clone());
                        self.pool.work(stream).unwrap();

                        trace!("New client with id : {}", id);
                    },
                    WAKER => {
                        while let Ok(task) = self.receiver.try_recv() {
                            match task {
                                LoopTask::Shutdown => {
                                    trace!("Shutting down");
                                    self.pool.join();
                                    self.handle.set_ready(false);
                                    return;
                                }
                                LoopTask::Close(id) => {
                                    AIOServer::<H>::remove_connection(
                                        id, &mut map, &self.poll, &mut gen,
                                    );
                                }
                            }
                        }
                    }
                    token => {
                        trace!("Data from id : {}", token.0);

                        let stream = match map.get(&token) {
                            Some(stream) => stream.clone(),
                            None => {
                                error!("Could not retrieve stream with id : {}", token.0);
                                continue;
                            }
                        };

                        self.pool.work(stream).unwrap();
                    }
                }
            }
        }
    }
}

impl<H> AIOServer<H> {
    /// Get a [`ServerHandle`] to this server
    ///
    /// [`ServerHandle`]: struct.ServerHandle.html
    pub fn handle(&self) -> ServerHandle {
        self.handle.clone()
    }

    fn remove_connection(
        id: usize,
        map: &mut HashMap<Token, SafeStream<TcpStream>>,
        poll: &Poll,
        generator: &mut IdGenerator,
    ) {
        let to_close = match map.remove(&Token(id)) {
            Some(val) => val,
            None => return,
        };

        let mut to_close = to_close.lock().unwrap();

        match to_close.shutdown() {
            Ok(_) => {}
            Err(e) => {
                error!("Issue when closing TCP connection {} : {}", id, e);
            }
        };

        match poll.registry().deregister(&mut (*to_close)) {
            Ok(_) => {}
            Err(e) => {
                error!("Issue when deregistering connection {} : {}", id, e);
            }
        };

        generator.remove(id);
    }
}

impl<H> Drop for AIOServer<H> {
    fn drop(&mut self) {
        self.handle.shutdown();
    }
}
/// Clonable handle to a server.
/// Can only be retrieved from a Server instance.
/// Used to wait for the server to be ready or to shut it down.
#[derive(Clone)]
pub struct ServerHandle {
    ready: Status,
    sender: EventedSender<LoopTask>,
}

impl ServerHandle {
    fn new(sender: EventedSender<LoopTask>) -> Self {
        ServerHandle {
            ready: Arc::new((Mutex::from(false), Condvar::new())),
            sender,
        }
    }

    fn set_ready(&self, ready_val: bool) {
        let (lock, cvar) = &*self.ready;
        let mut ready = lock.lock().unwrap();
        *ready = ready_val;

        cvar.notify_all();
    }

    /// Send a shutdown signal to the server.
    /// The server wait for all the received request to be handled and the stop
    ///
    /// # Example
    ///
    /// Creates a server and starts it. From another thread we send the shutdown signal
    /// causing the server to stop and the program to end.
    ///
    /// ```
    /// let mut server = mini_async_http::AIOServer::new(3, "0.0.0.0:7880", move |request|{
    ///     mini_async_http::ResponseBuilder::empty_200()
    ///         .body(b"Hello")
    ///         .content_type("text/plain")
    ///         .build()
    ///         .unwrap()
    /// });
    /// let handle = server.handle();
    ///
    /// std::thread::spawn(move || {
    ///     handle.shutdown();
    /// });
    ///
    /// server.start();
    ///
    /// ```
    pub fn shutdown(&self) {
        self.sender.send(LoopTask::Shutdown).unwrap();

        let (lock, cvar) = &*self.ready;
        let mut started = lock.lock().unwrap();

        while *started {
            started = cvar.wait(started).unwrap();
        }
    }

    /// Block untill the server is ready to receive requests
    ///
    /// # Example
    ///
    /// Creates a server and starts it in a separate thread.
    /// The main thread waits for the server to be ready and then ends
    ///
    /// ```
    /// let mut server = mini_async_http::AIOServer::new(3, "0.0.0.0:7880", move |request|{
    ///     mini_async_http::ResponseBuilder::empty_200()
    ///         .body(b"Hello")
    ///         .content_type("text/plain")
    ///         .build()
    ///         .unwrap()
    /// });
    /// let handle = server.handle();
    ///
    /// std::thread::spawn(move || {
    ///     server.start();
    /// });
    ///
    /// handle.ready();
    ///
    /// ```
    pub fn ready(&self) {
        let (lock, cvar) = &*self.ready;
        let mut started = lock.lock().unwrap();

        while !*started {
            started = cvar.wait(started).unwrap();
        }
    }
}