mirror of
https://github.com/actix/actix-website
synced 2024-12-03 20:22:13 +01:00
117 lines
46 KiB
HTML
117 lines
46 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `HttpServer` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, HttpServer"><title>actix_web::server::HttpServer - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Struct HttpServer</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.workers">workers</a><a href="#method.backlog">backlog</a><a href="#method.maxconn">maxconn</a><a href="#method.maxconnrate">maxconnrate</a><a href="#method.keep_alive">keep_alive</a><a href="#method.client_timeout">client_timeout</a><a href="#method.client_shutdown">client_shutdown</a><a href="#method.server_hostname">server_hostname</a><a href="#method.system_exit">system_exit</a><a href="#method.disable_signals">disable_signals</a><a href="#method.shutdown_timeout">shutdown_timeout</a><a href="#method.no_http2">no_http2</a><a href="#method.addrs">addrs</a><a href="#method.addrs_with_scheme">addrs_with_scheme</a><a href="#method.listen">listen</a><a href="#method.listen_tls">listen_tls</a><a href="#method.listen_ssl">listen_ssl</a><a href="#method.bind">bind</a><a href="#method.bind_tls">bind_tls</a><a href="#method.bind_ssl">bind_ssl</a><a href="#method.start">start</a><a href="#method.run">run</a><a href="#method.register">register</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-From">From</a><a href="#impl-Into">Into</a><a href="#impl-TryFrom">TryFrom</a><a href="#impl-Borrow">Borrow</a><a href="#impl-BorrowMut">BorrowMut</a><a href="#impl-TryInto">TryInto</a><a href="#impl-Any">Any</a><a href="#impl-Erased">Erased</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>server</a></p><script>window.sidebarCurrent = {name: 'HttpServer', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/actix_web/server/http.rs.html#36-55' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>server</a>::<wbr><a class="struct" href=''>HttpServer</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct HttpServer<H, F> <span class="where fmt-newline">where<br> H: <a class="trait" href="../../actix_web/server/trait.IntoHttpHandler.html" title="trait actix_web::server::IntoHttpHandler">IntoHttpHandler</a> + 'static,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> H + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span> { /* fields omitted */ }</pre></div><div class='docblock'><p>An HTTP Server</p>
|
||
<p>By default it serves HTTP2 when HTTPs is enabled,
|
||
in order to change it, use <code>ServerFlags</code> that can be provided
|
||
to acceptor service.</p>
|
||
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<H, F> <a class="struct" href="../../actix_web/server/struct.HttpServer.html" title="struct actix_web::server::HttpServer">HttpServer</a><H, F> <span class="where fmt-newline">where<br> H: <a class="trait" href="../../actix_web/server/trait.IntoHttpHandler.html" title="trait actix_web::server::IntoHttpHandler">IntoHttpHandler</a> + 'static,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> H + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + 'static, </span></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#57-445' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(factory: F) -> <a class="struct" href="../../actix_web/server/struct.HttpServer.html" title="struct actix_web::server::HttpServer">HttpServer</a><H, F></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#63-80' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create new http server with application factory</p>
|
||
</div><h4 id='method.workers' class="method"><span id='workers.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.workers' class='fnname'>workers</a>(self, num: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#86-89' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set number of workers to start.</p>
|
||
<p>By default http server uses number of available logical cpu as threads
|
||
count.</p>
|
||
</div><h4 id='method.backlog' class="method"><span id='backlog.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.backlog' class='fnname'>backlog</a>(self, num: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#101-104' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the maximum number of pending connections.</p>
|
||
<p>This refers to the number of clients that can be waiting to be served.
|
||
Exceeding this number results in the client getting an error when
|
||
attempting to connect. It should only affect servers under significant
|
||
load.</p>
|
||
<p>Generally set in the 64-2048 range. Default value is 2048.</p>
|
||
<p>This method should be called before <code>bind()</code> method call.</p>
|
||
</div><h4 id='method.maxconn' class="method"><span id='maxconn.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.maxconn' class='fnname'>maxconn</a>(self, num: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#112-115' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the maximum per-worker number of concurrent connections.</p>
|
||
<p>All socket listeners will stop accepting connections when this limit is reached
|
||
for each worker.</p>
|
||
<p>By default max connections is set to a 25k.</p>
|
||
</div><h4 id='method.maxconnrate' class="method"><span id='maxconnrate.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.maxconnrate' class='fnname'>maxconnrate</a>(self, num: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#123-126' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the maximum per-worker concurrent connection establish process.</p>
|
||
<p>All listeners will stop accepting connections when this limit is reached. It
|
||
can be used to limit the global SSL CPU usage.</p>
|
||
<p>By default max connections is set to a 256.</p>
|
||
</div><h4 id='method.keep_alive' class="method"><span id='keep_alive.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.keep_alive' class='fnname'>keep_alive</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/server/enum.KeepAlive.html" title="enum actix_web::server::KeepAlive">KeepAlive</a>>>(self, val: T) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#131-134' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set server keep-alive setting.</p>
|
||
<p>By default keep alive is set to a 5 seconds.</p>
|
||
</div><h4 id='method.client_timeout' class="method"><span id='client_timeout.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.client_timeout' class='fnname'>client_timeout</a>(self, val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#145-148' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set server client timeout in milliseconds for first request.</p>
|
||
<p>Defines a timeout for reading client request header. If a client does not transmit
|
||
the entire set headers within this time, the request is terminated with
|
||
the 408 (Request Time-out) error.</p>
|
||
<p>To disable timeout set value to 0.</p>
|
||
<p>By default client timeout is set to 5000 milliseconds.</p>
|
||
</div><h4 id='method.client_shutdown' class="method"><span id='client_shutdown.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.client_shutdown' class='fnname'>client_shutdown</a>(self, val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#158-161' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set server connection shutdown timeout in milliseconds.</p>
|
||
<p>Defines a timeout for shutdown connection. If a shutdown procedure does not complete
|
||
within this time, the request is dropped.</p>
|
||
<p>To disable timeout set value to 0.</p>
|
||
<p>By default client timeout is set to 5000 milliseconds.</p>
|
||
</div><h4 id='method.server_hostname' class="method"><span id='server_hostname.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.server_hostname' class='fnname'>server_hostname</a>(self, val: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#168-171' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set server host name.</p>
|
||
<p>Host name is used by application router aa a hostname for url
|
||
generation. Check [ConnectionInfo](./dev/struct.ConnectionInfo.
|
||
html#method.host) documentation for more information.</p>
|
||
</div><h4 id='method.system_exit' class="method"><span id='system_exit.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.system_exit' class='fnname'>system_exit</a>(self) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#176-179' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Stop actix system.</p>
|
||
<p><code>SystemExit</code> message stops currently running system.</p>
|
||
</div><h4 id='method.disable_signals' class="method"><span id='disable_signals.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.disable_signals' class='fnname'>disable_signals</a>(self) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#182-185' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Disable signal handling</p>
|
||
</div><h4 id='method.shutdown_timeout' class="method"><span id='shutdown_timeout.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.shutdown_timeout' class='fnname'>shutdown_timeout</a>(self, sec: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#194-197' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Timeout for graceful workers shutdown.</p>
|
||
<p>After receiving a stop signal, workers have this much time to finish
|
||
serving requests. Workers still alive after the timeout are force
|
||
dropped.</p>
|
||
<p>By default shutdown timeout sets to 30 seconds.</p>
|
||
</div><h4 id='method.no_http2' class="method"><span id='no_http2.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.no_http2' class='fnname'>no_http2</a>(self) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#200-203' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Disable <code>HTTP/2</code> support</p>
|
||
</div><h4 id='method.addrs' class="method"><span id='addrs.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.addrs' class='fnname'>addrs</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#206-208' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get addresses of bound sockets.</p>
|
||
</div><h4 id='method.addrs_with_scheme' class="method"><span id='addrs_with_scheme.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.addrs_with_scheme' class='fnname'>addrs_with_scheme</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>, &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#216-218' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get addresses of bound sockets and the scheme for it.</p>
|
||
<p>This is useful when the server is bound from different sources
|
||
with some sockets listening on http and some listening on https
|
||
and the user should be presented with an enumeration of which
|
||
socket requires which protocol.</p>
|
||
</div><h4 id='method.listen' class="method"><span id='listen.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.listen' class='fnname'>listen</a>(self, lst: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/tcp/struct.TcpListener.html" title="struct std::net::tcp::TcpListener">TcpListener</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#224-237' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Use listener for accepting incoming connection requests</p>
|
||
<p>HttpServer does not change any configuration for TcpListener,
|
||
it needs to be configured before passing it to listen() method.</p>
|
||
</div><h4 id='method.listen_tls' class="method"><span id='listen_tls.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.listen_tls' class='fnname'>listen_tls</a>(self, lst: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/tcp/struct.TcpListener.html" title="struct std::net::tcp::TcpListener">TcpListener</a>, acceptor: <a class="struct" href="https://docs.rs/native-tls/0.2/native_tls/struct.TlsAcceptor.html" title="struct native_tls::TlsAcceptor">TlsAcceptor</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#262-268' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Use listener for accepting incoming tls connection requests</p>
|
||
<p>HttpServer does not change any configuration for TcpListener,
|
||
it needs to be configured before passing it to listen() method.</p>
|
||
</div><h4 id='method.listen_ssl' class="method"><span id='listen_ssl.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.listen_ssl' class='fnname'>listen_ssl</a>(<br> self, <br> lst: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/tcp/struct.TcpListener.html" title="struct std::net::tcp::TcpListener">TcpListener</a>, <br> builder: <a class="struct" href="https://docs.rs/openssl/0.10/openssl/ssl/connector/struct.SslAcceptorBuilder.html" title="struct openssl::ssl::connector::SslAcceptorBuilder">SslAcceptorBuilder</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#274-290' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Use listener for accepting incoming tls connection requests</p>
|
||
<p>This method sets alpn protocols to "h2" and "http/1.1"</p>
|
||
</div><h4 id='method.bind' class="method"><span id='bind.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bind' class='fnname'>bind</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/std/net/addr/trait.ToSocketAddrs.html" title="trait std::net::addr::ToSocketAddrs">ToSocketAddrs</a>>(self, addr: S) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#315-323' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The socket address to bind</p>
|
||
<p>To bind multiple addresses this method can be called multiple times.</p>
|
||
</div><h4 id='method.bind_tls' class="method"><span id='bind_tls.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bind_tls' class='fnname'>bind_tls</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/std/net/addr/trait.ToSocketAddrs.html" title="trait std::net::addr::ToSocketAddrs">ToSocketAddrs</a>>(<br> self, <br> addr: S, <br> acceptor: <a class="struct" href="https://docs.rs/native-tls/0.2/native_tls/struct.TlsAcceptor.html" title="struct native_tls::TlsAcceptor">TlsAcceptor</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#389-398' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The ssl socket address to bind</p>
|
||
<p>To bind multiple addresses this method can be called multiple times.</p>
|
||
</div><h4 id='method.bind_ssl' class="method"><span id='bind_ssl.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bind_ssl' class='fnname'>bind_ssl</a><S>(self, addr: S, builder: <a class="struct" href="https://docs.rs/openssl/0.10/openssl/ssl/connector/struct.SslAcceptorBuilder.html" title="struct openssl::ssl::connector::SslAcceptorBuilder">SslAcceptorBuilder</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><Self> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/std/net/addr/trait.ToSocketAddrs.html" title="trait std::net::addr::ToSocketAddrs">ToSocketAddrs</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#404-422' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Start listening for incoming tls connections.</p>
|
||
<p>This method sets alpn protocols to "h2" and "http/1.1"</p>
|
||
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<H: <a class="trait" href="../../actix_web/server/trait.IntoHttpHandler.html" title="trait actix_web::server::IntoHttpHandler">IntoHttpHandler</a>, F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> H + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="struct" href="../../actix_web/server/struct.HttpServer.html" title="struct actix_web::server::HttpServer">HttpServer</a><H, F></code><a href='#impl-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#447-567' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.start' class="method"><span id='start.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.start' class='fnname'>start</a>(self) -> <a class="struct" href="../../actix_web/actix/actix/struct.Addr.html" title="struct actix_web::actix::actix::Addr">Addr</a><Server></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#473-513' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Start listening for incoming connections.</p>
|
||
<p>This method starts number of http workers in separate threads.
|
||
For each address this method starts separate thread which does
|
||
<code>accept()</code> in a loop.</p>
|
||
<p>This methods panics if no socket addresses get bound.</p>
|
||
<p>This method requires to run within properly configured <code>Actix</code> system.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">actix_web</span>;
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">actix</span>, <span class="ident">server</span>, <span class="ident">App</span>, <span class="ident">HttpResponse</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">sys</span> <span class="op">=</span> <span class="ident">actix</span>::<span class="ident">System</span>::<span class="ident">new</span>(<span class="string">"example"</span>); <span class="comment">// <- create Actix system</span>
|
||
|
||
<span class="ident">server</span>::<span class="ident">new</span>(<span class="op">||</span> <span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">resource</span>(<span class="string">"/"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">h</span>(<span class="op">|</span><span class="kw">_</span>: <span class="kw-2">&</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>())))
|
||
.<span class="ident">bind</span>(<span class="string">"127.0.0.1:0"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"Can not bind to 127.0.0.1:0"</span>)
|
||
.<span class="ident">start</span>();
|
||
<span class="ident">sys</span>.<span class="ident">run</span>(); <span class="comment">// <- Run actix system, this method starts all async processes</span>
|
||
}</pre>
|
||
</div><h4 id='method.run' class="method"><span id='run.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.run' class='fnname'>run</a>(self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#535-539' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Spawn new thread and start listening for incoming connections.</p>
|
||
<p>This method spawns new thread and starts new actix system. Other than
|
||
that it is similar to <code>start()</code> method. This method blocks.</p>
|
||
<p>This methods panics if no socket addresses get bound.</p>
|
||
|
||
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="kw-2">*</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="ident">HttpServer</span>::<span class="ident">new</span>(<span class="op">||</span> <span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">resource</span>(<span class="string">"/"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">h</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>())))
|
||
.<span class="ident">bind</span>(<span class="string">"127.0.0.1:0"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"Can not bind to 127.0.0.1:0"</span>)
|
||
.<span class="ident">run</span>();
|
||
}</pre>
|
||
</div><h4 id='method.register' class="method"><span id='register.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.register' class='fnname'>register</a>(self, srv: Server) -> Server</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/http.rs.html#542-566' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Register current http server as actix-net's server service</p>
|
||
</div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<H, F> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/server/struct.HttpServer.html" title="struct actix_web::server::HttpServer">HttpServer</a><H, F></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<H, F> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/server/struct.HttpServer.html" title="struct actix_web::server::HttpServer">HttpServer</a><H, F></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-From' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a> for T</code><a href='#impl-From' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#462-464' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#463' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Into' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#453-458' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.into' class="method"><span id='into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#455-457' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-TryFrom' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><U>, </span></code><a href='#impl-TryFrom' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#481-487' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.never.html">!</a></code></span></h4>
|
||
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id='method.try_from' class="method"><span id='try_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#484-486' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Borrow' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219-221' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.borrow' class="method"><span id='borrow.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id='impl-BorrowMut' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#224-226' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method"><span id='borrow_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#225' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></div><h3 id='impl-TryInto' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#469-476' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><span id='Error.t-1' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></span></h4>
|
||
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id='method.try_into' class="method"><span id='try_into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#473-475' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Any' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#114-116' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.get_type_id' class="method"><span id='get_type_id.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.get_type_id' class='fnname'>get_type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#115' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>get_type_id</code>)</summary><p>this method will likely be replaced by an associated static</p>
|
||
</details></div></div><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.get_type_id">Read more</a></p>
|
||
</div></div><h3 id='impl-Erased' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> Erased for T</code><a href='#impl-Erased' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "actix_web";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |