# mod.rs.html -- source
Source to the Rust file `src/server/mod.rs`.
Keywords: rust, rustlang, rust-lang

      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

    //! Http server module
    //!
    //! The module contains everything necessary to setup
    //! HTTP server.
    //!
    //! In order to start HTTP server, first you need to create and configure it
    //! using factory that can be supplied to [new](fn.new.html).
    //!
    //! ## Factory
    //!
    //! Factory is a function that returns Application, describing how
    //! to serve incoming HTTP requests.
    //!
    //! As the server uses worker pool, the factory function is restricted to trait bounds
    //! `Send + Clone + 'static` so that each worker would be able to accept Application
    //! without a need for synchronization.
    //!
    //! If you wish to share part of state among all workers you should
    //! wrap it in `Arc` and potentially synchronization primitive like
    //! [RwLock](https://doc.rust-lang.org/std/sync/struct.RwLock.html)
    //! If the wrapped type is not thread safe.
    //!
    //! Note though that locking is not advisable for asynchronous programming
    //! and you should minimize all locks in your request handlers
    //!
    //! ## HTTPS Support
    //!
    //! Actix-web provides support for major crates that provides TLS.
    //! Each TLS implementation is provided with [AcceptorService](trait.AcceptorService.html)
    //! that describes how HTTP Server accepts connections.
    //!
    //! For `bind` and `listen` there are corresponding `bind_ssl|tls|rustls` and `listen_ssl|tls|rustls` that accepts
    //! these services.
    //!
    //! **NOTE:** `native-tls` doesn't support `HTTP2` yet
    //!
    //! ## Signal handling and shutdown
    //!
    //! By default HTTP Server listens for system signals
    //! and, gracefully shuts down at most after 30 seconds.
    //!
    //! Both signal handling and shutdown timeout can be controlled
    //! using corresponding methods.
    //!
    //! If worker, for some reason, unable to shut down within timeout
    //! it is forcibly dropped.
    //!
    //! ## Example
    //!
    //! ```rust,ignore
    //!extern crate actix;
    //!extern crate actix_web;
    //!extern crate rustls;
    //!
    //!use actix_web::{http, middleware, server, App, Error, HttpRequest, HttpResponse, Responder};
    //!use std::io::BufReader;
    //!use rustls::internal::pemfile::{certs, rsa_private_keys};
    //!use rustls::{NoClientAuth, ServerConfig};
    //!
    //!fn index(req: &HttpRequest) -> Result<HttpResponse, Error> {
    //!    Ok(HttpResponse::Ok().content_type("text/plain").body("Welcome!"))
    //!}
    //!
    //!fn load_ssl() -> ServerConfig {
    //!    use std::io::BufReader;
    //!
    //!    const CERT: &'static [u8] = include_bytes!("../cert.pem");
    //!    const KEY: &'static [u8] = include_bytes!("../key.pem");
    //!
    //!    let mut cert = BufReader::new(CERT);
    //!    let mut key = BufReader::new(KEY);
    //!
    //!    let mut config = ServerConfig::new(NoClientAuth::new());
    //!    let cert_chain = certs(&mut cert).unwrap();
    //!    let mut keys = rsa_private_keys(&mut key).unwrap();
    //!    config.set_single_cert(cert_chain, keys.remove(0)).unwrap();
    //!
    //!    config
    //!}
    //!
    //!fn main() {
    //!    let sys = actix::System::new("http-server");
    //!    // load ssl keys
    //!    let config = load_ssl();
    //!
    //!     // create and start server at once
    //!     server::new(|| {
    //!         App::new()
    //!             // register simple handler, handle all methods
    //!             .resource("/index.html", |r| r.f(index))
    //!             }))
    //!     }).bind_rustls("127.0.0.1:8443", config)
    //!     .unwrap()
    //!     .start();
    //!
    //!     println!("Started http server: 127.0.0.1:8080");
    //!     //Run system so that server would start accepting connections
    //!     let _ = sys.run();
    //!}
    //! ```
    use std::net::{Shutdown, SocketAddr};
    use std::rc::Rc;
    use std::{io, time};

    use bytes::{BufMut, BytesMut};
    use futures::{Async, Poll};
    use tokio_io::{AsyncRead, AsyncWrite};
    use tokio_tcp::TcpStream;

    pub use actix_net::server::{PauseServer, ResumeServer, StopServer};

    pub(crate) mod acceptor;
    pub(crate) mod builder;
    mod channel;
    mod error;
    pub(crate) mod h1;
    pub(crate) mod h1decoder;
    mod h1writer;
    mod h2;
    mod h2writer;
    mod handler;
    pub(crate) mod helpers;
    mod http;
    pub(crate) mod incoming;
    pub(crate) mod input;
    pub(crate) mod message;
    pub(crate) mod output;
    pub(crate) mod service;
    pub(crate) mod settings;
    mod ssl;

    pub use self::handler::*;
    pub use self::http::HttpServer;
    pub use self::message::Request;
    pub use self::ssl::*;

    pub use self::error::{AcceptorError, HttpDispatchError};
    pub use self::settings::ServerSettings;

    #[doc(hidden)]
    pub use self::acceptor::AcceptorTimeout;

    #[doc(hidden)]
    pub use self::settings::{ServiceConfig, ServiceConfigBuilder};

    #[doc(hidden)]
    pub use self::service::{H1Service, HttpService, StreamConfiguration};

    #[doc(hidden)]
    pub use self::helpers::write_content_length;

    use body::Binary;
    use extensions::Extensions;
    use header::ContentEncoding;
    use httpresponse::HttpResponse;

    /// max buffer size 64k
    pub(crate) const MAX_WRITE_BUFFER_SIZE: usize = 65_536;

    const LW_BUFFER_SIZE: usize = 4096;
    const HW_BUFFER_SIZE: usize = 32_768;

    /// Create new http server with application factory.
    ///
    /// This is shortcut for `server::HttpServer::new()` method.
    ///
    /// ```rust
    /// # extern crate actix_web;
    /// use actix_web::{actix, server, App, HttpResponse};
    ///
    /// fn main() {
    ///     let sys = actix::System::new("example");  // <- create Actix system
    ///
    ///     server::new(
    ///         || App::new()
    ///             .resource("/", |r| r.f(|_| HttpResponse::Ok())))
    ///         .bind("127.0.0.1:59090").unwrap()
    ///         .start();
    ///
    /// #       actix::System::current().stop();
    ///     sys.run();
    /// }
    /// ```
    pub fn new<F, H>(factory: F) -> HttpServer<H, F>
    where
        F: Fn() -> H + Send + Clone + 'static,
        H: IntoHttpHandler + 'static,
    {
        HttpServer::new(factory)
    }

    #[doc(hidden)]
    bitflags! {
        ///Flags that can be used to configure HTTP Server.
        pub struct ServerFlags: u8 {
            ///Use HTTP1 protocol
            const HTTP1 = 0b0000_0001;
            ///Use HTTP2 protocol
            const HTTP2 = 0b0000_0010;
        }
    }

    #[derive(Debug, PartialEq, Clone, Copy)]
    /// Server keep-alive setting
    pub enum KeepAlive {
        /// Keep alive in seconds
        Timeout(usize),
        /// Use `SO_KEEPALIVE` socket option, value in seconds
        Tcp(usize),
        /// Relay on OS to shutdown tcp connection
        Os,
        /// Disabled
        Disabled,
    }

    impl From<usize> for KeepAlive {
        fn from(keepalive: usize) -> Self {
            KeepAlive::Timeout(keepalive)
        }
    }

    impl From<Option<usize>> for KeepAlive {
        fn from(keepalive: Option<usize>) -> Self {
            if let Some(keepalive) = keepalive {
                KeepAlive::Timeout(keepalive)
            } else {
                KeepAlive::Disabled
            }
        }
    }

    #[doc(hidden)]
    #[derive(Debug)]
    pub enum WriterState {
        Done,
        Pause,
    }

    #[doc(hidden)]
    /// Stream writer
    pub trait Writer {
        /// number of bytes written to the stream
        fn written(&self) -> u64;

        #[doc(hidden)]
        fn set_date(&mut self);

        #[doc(hidden)]
        fn buffer(&mut self) -> &mut BytesMut;

        fn start(
            &mut self, req: &Request, resp: &mut HttpResponse, encoding: ContentEncoding,
        ) -> io::Result<WriterState>;

        fn write(&mut self, payload: &Binary) -> io::Result<WriterState>;

        fn write_eof(&mut self) -> io::Result<WriterState>;

        fn poll_completed(&mut self, shutdown: bool) -> Poll<(), io::Error>;
    }

    #[doc(hidden)]
    /// Low-level io stream operations
    pub trait IoStream: AsyncRead + AsyncWrite + 'static {
        fn shutdown(&mut self, how: Shutdown) -> io::Result<()>;

        /// Returns the socket address of the remote peer of this TCP connection.
        fn peer_addr(&self) -> Option<SocketAddr> {
            None
        }

        /// Sets the value of the TCP_NODELAY option on this socket.
        fn set_nodelay(&mut self, nodelay: bool) -> io::Result<()>;

        fn set_linger(&mut self, dur: Option<time::Duration>) -> io::Result<()>;

        fn set_keepalive(&mut self, dur: Option<time::Duration>) -> io::Result<()>;

        fn read_available(&mut self, buf: &mut BytesMut) -> Poll<(bool, bool), io::Error> {
            let mut read_some = false;
            loop {
                if buf.remaining_mut() < LW_BUFFER_SIZE {
                    buf.reserve(HW_BUFFER_SIZE);
                }

                let read = unsafe { self.read(buf.bytes_mut()) };
                match read {
                    Ok(n) => {
                        if n == 0 {
                            return Ok(Async::Ready((read_some, true)));
                        } else {
                            read_some = true;
                            unsafe {
                                buf.advance_mut(n);
                            }
                        }
                    }
                    Err(e) => {
                        return if e.kind() == io::ErrorKind::WouldBlock {
                            if read_some {
                                Ok(Async::Ready((read_some, false)))
                            } else {
                                Ok(Async::NotReady)
                            }
                        } else {
                            Err(e)
                        };
                    }
                }
            }
        }

        /// Extra io stream extensions
        fn extensions(&self) -> Option<Rc<Extensions>> {
            None
        }
    }

    #[cfg(all(unix, feature = "uds"))]
    impl IoStream for ::tokio_uds::UnixStream {
        #[inline]
        fn shutdown(&mut self, how: Shutdown) -> io::Result<()> {
            ::tokio_uds::UnixStream::shutdown(self, how)
        }

        #[inline]
        fn set_nodelay(&mut self, _nodelay: bool) -> io::Result<()> {
            Ok(())
        }

        #[inline]
        fn set_linger(&mut self, _dur: Option<time::Duration>) -> io::Result<()> {
            Ok(())
        }

        #[inline]
        fn set_keepalive(&mut self, _nodelay: bool) -> io::Result<()> {
            Ok(())
        }
    }

    impl IoStream for TcpStream {
        #[inline]
        fn shutdown(&mut self, how: Shutdown) -> io::Result<()> {
            TcpStream::shutdown(self, how)
        }

        #[inline]
        fn peer_addr(&self) -> Option<SocketAddr> {
            TcpStream::peer_addr(self).ok()
        }

        #[inline]
        fn set_nodelay(&mut self, nodelay: bool) -> io::Result<()> {
            TcpStream::set_nodelay(self, nodelay)
        }

        #[inline]
        fn set_linger(&mut self, dur: Option<time::Duration>) -> io::Result<()> {
            TcpStream::set_linger(self, dur)
        }

        #[inline]
        fn set_keepalive(&mut self, dur: Option<time::Duration>) -> io::Result<()> {
            TcpStream::set_keepalive(self, dur)
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)