<!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="Source to the Rust file `/home/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/solicit-0.4.4/src/server/mod.rs`."> <meta name="keywords" content="rust, rustlang, rust-lang"> <title>mod.rs.html -- source</title> <link rel="stylesheet" type="text/css" href="../../../rustdoc.css"> <link rel="stylesheet" type="text/css" href="../../../main.css"> </head> <body class="rustdoc"> <!--[if lte IE 8]> <div class="warning"> This old browser is unsupported and will most likely display funky things. </div> <![endif]--> <nav class="sidebar"> </nav> <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"> </div> </form> </nav> <section id='main' class="content source"><pre class="line-numbers"><span id="1"> 1</span> <span id="2"> 2</span> <span id="3"> 3</span> <span id="4"> 4</span> <span id="5"> 5</span> <span id="6"> 6</span> <span id="7"> 7</span> <span id="8"> 8</span> <span id="9"> 9</span> <span id="10"> 10</span> <span id="11"> 11</span> <span id="12"> 12</span> <span id="13"> 13</span> <span id="14"> 14</span> <span id="15"> 15</span> <span id="16"> 16</span> <span id="17"> 17</span> <span id="18"> 18</span> <span id="19"> 19</span> <span id="20"> 20</span> <span id="21"> 21</span> <span id="22"> 22</span> <span id="23"> 23</span> <span id="24"> 24</span> <span id="25"> 25</span> <span id="26"> 26</span> <span id="27"> 27</span> <span id="28"> 28</span> <span id="29"> 29</span> <span id="30"> 30</span> <span id="31"> 31</span> <span id="32"> 32</span> <span id="33"> 33</span> <span id="34"> 34</span> <span id="35"> 35</span> <span id="36"> 36</span> <span id="37"> 37</span> <span id="38"> 38</span> <span id="39"> 39</span> <span id="40"> 40</span> <span id="41"> 41</span> <span id="42"> 42</span> <span id="43"> 43</span> <span id="44"> 44</span> <span id="45"> 45</span> <span id="46"> 46</span> <span id="47"> 47</span> <span id="48"> 48</span> <span id="49"> 49</span> <span id="50"> 50</span> <span id="51"> 51</span> <span id="52"> 52</span> <span id="53"> 53</span> <span id="54"> 54</span> <span id="55"> 55</span> <span id="56"> 56</span> <span id="57"> 57</span> <span id="58"> 58</span> <span id="59"> 59</span> <span id="60"> 60</span> <span id="61"> 61</span> <span id="62"> 62</span> <span id="63"> 63</span> <span id="64"> 64</span> <span id="65"> 65</span> <span id="66"> 66</span> <span id="67"> 67</span> <span id="68"> 68</span> <span id="69"> 69</span> <span id="70"> 70</span> <span id="71"> 71</span> <span id="72"> 72</span> <span id="73"> 73</span> <span id="74"> 74</span> <span id="75"> 75</span> <span id="76"> 76</span> <span id="77"> 77</span> <span id="78"> 78</span> <span id="79"> 79</span> <span id="80"> 80</span> <span id="81"> 81</span> <span id="82"> 82</span> <span id="83"> 83</span> <span id="84"> 84</span> <span id="85"> 85</span> <span id="86"> 86</span> <span id="87"> 87</span> <span id="88"> 88</span> <span id="89"> 89</span> <span id="90"> 90</span> <span id="91"> 91</span> <span id="92"> 92</span> <span id="93"> 93</span> <span id="94"> 94</span> <span id="95"> 95</span> <span id="96"> 96</span> <span id="97"> 97</span> <span id="98"> 98</span> <span id="99"> 99</span> <span id="100">100</span> <span id="101">101</span> <span id="102">102</span> <span id="103">103</span> <span id="104">104</span> <span id="105">105</span> <span id="106">106</span> <span id="107">107</span> <span id="108">108</span> <span id="109">109</span> <span id="110">110</span> <span id="111">111</span> <span id="112">112</span> <span id="113">113</span> <span id="114">114</span> <span id="115">115</span> <span id="116">116</span> <span id="117">117</span> <span id="118">118</span> <span id="119">119</span> <span id="120">120</span> <span id="121">121</span> <span id="122">122</span> <span id="123">123</span> <span id="124">124</span> <span id="125">125</span> <span id="126">126</span> <span id="127">127</span> <span id="128">128</span> <span id="129">129</span> <span id="130">130</span> <span id="131">131</span> <span id="132">132</span> <span id="133">133</span> <span id="134">134</span> <span id="135">135</span> <span id="136">136</span> <span id="137">137</span> <span id="138">138</span> <span id="139">139</span> <span id="140">140</span> <span id="141">141</span> <span id="142">142</span> <span id="143">143</span> <span id="144">144</span> <span id="145">145</span> <span id="146">146</span> <span id="147">147</span> <span id="148">148</span> <span id="149">149</span> <span id="150">150</span> <span id="151">151</span> <span id="152">152</span> <span id="153">153</span> <span id="154">154</span> <span id="155">155</span> <span id="156">156</span> <span id="157">157</span> <span id="158">158</span> <span id="159">159</span> <span id="160">160</span> <span id="161">161</span> </pre><pre class='rust '> <span class='doccomment'>//! The module contains a simple HTTP/2 server implementation.</span> <span class='kw'>use</span> <span class='ident'>http</span>::{<span class='ident'>Response</span>, <span class='ident'>HttpResult</span>, <span class='ident'>HttpError</span>, <span class='ident'>HttpScheme</span>, <span class='ident'>Header</span>, <span class='ident'>StreamId</span>}; <span class='kw'>use</span> <span class='ident'>http</span>::<span class='ident'>transport</span>::<span class='ident'>TransportStream</span>; <span class='kw'>use</span> <span class='ident'>http</span>::<span class='ident'>connection</span>::{<span class='ident'>HttpConnection</span>, <span class='ident'>EndStream</span>, <span class='ident'>SendStatus</span>}; <span class='kw'>use</span> <span class='ident'>http</span>::<span class='ident'>session</span>::{<span class='ident'>DefaultSessionState</span>, <span class='ident'>SessionState</span>, <span class='ident'>Stream</span>}; <span class='kw'>use</span> <span class='ident'>http</span>::<span class='ident'>server</span>::<span class='ident'>ServerConnection</span>; <span class='doccomment'>/// The struct represents a fully received request.</span> <span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>ServerRequest</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> { <span class='kw'>pub</span> <span class='ident'>stream_id</span>: <span class='ident'>StreamId</span>, <span class='kw'>pub</span> <span class='ident'>headers</span>: <span class='kw-2'>&</span><span class='lifetime'>'a</span> [<span class='ident'>Header</span>], <span class='kw'>pub</span> <span class='ident'>body</span>: <span class='kw-2'>&</span><span class='lifetime'>'a</span> [<span class='ident'>u8</span>], } <span class='doccomment'>/// The struct implements a simple HTTP/2 server that allows users to register a request handler (a</span> <span class='doccomment'>/// callback taking a `ServerRequest` and returning a `Response`) which is run on all received</span> <span class='doccomment'>/// requests.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// The `handle_next` method needs to be called regularly in order to have the server process</span> <span class='doccomment'>/// received frames, as well as send out the responses.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// This is an exceedingly simple implementation of an HTTP/2 server and is mostly an example of</span> <span class='doccomment'>/// how the `solicit::http` API can be used to make one.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// # Examples</span> <span class='doccomment'>///</span> <span class='doccomment'>/// ```no_run</span> <span class='doccomment'>/// extern crate solicit;</span> <span class='doccomment'>/// use std::str;</span> <span class='doccomment'>/// use std::net::{TcpListener, TcpStream};</span> <span class='doccomment'>/// use std::thread;</span> <span class='doccomment'>///</span> <span class='doccomment'>/// use solicit::server::SimpleServer;</span> <span class='doccomment'>///</span> <span class='doccomment'>/// use solicit::http::Response;</span> <span class='doccomment'>///</span> <span class='doccomment'>/// fn main() {</span> <span class='doccomment'>/// fn handle_client(stream: TcpStream) {</span> <span class='doccomment'>/// let mut server = SimpleServer::new(stream, |req| {</span> <span class='doccomment'>/// println!("Received request:");</span> <span class='doccomment'>/// for header in req.headers.iter() {</span> <span class='doccomment'>/// println!(" {}: {}",</span> <span class='doccomment'>/// str::from_utf8(&header.0).unwrap(),</span> <span class='doccomment'>/// str::from_utf8(&header.1).unwrap());</span> <span class='doccomment'>/// }</span> <span class='doccomment'>/// println!("Body:\n{}", str::from_utf8(&req.body).unwrap());</span> <span class='doccomment'>///</span> <span class='doccomment'>/// // Return a dummy response for every request</span> <span class='doccomment'>/// Response {</span> <span class='doccomment'>/// headers: vec![</span> <span class='doccomment'>/// (b":status".to_vec(), b"200".to_vec()),</span> <span class='doccomment'>/// (b"x-solicit".to_vec(), b"Hello, World!".to_vec()),</span> <span class='doccomment'>/// ],</span> <span class='doccomment'>/// body: vec![65],</span> <span class='doccomment'>/// stream_id: req.stream_id,</span> <span class='doccomment'>/// }</span> <span class='doccomment'>/// }).unwrap();</span> <span class='doccomment'>/// while let Ok(_) = server.handle_next() {}</span> <span class='doccomment'>/// println!("Server done (client disconnected)");</span> <span class='doccomment'>/// }</span> <span class='doccomment'>///</span> <span class='doccomment'>/// let listener = TcpListener::bind("127.0.0.1:8080").unwrap();</span> <span class='doccomment'>/// for stream in listener.incoming() {</span> <span class='doccomment'>/// let stream = stream.unwrap();</span> <span class='doccomment'>/// thread::spawn(move || {</span> <span class='doccomment'>/// handle_client(stream)</span> <span class='doccomment'>/// });</span> <span class='doccomment'>/// }</span> <span class='doccomment'>/// }</span> <span class='doccomment'>/// ```</span> <span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>SimpleServer</span><span class='op'><</span><span class='ident'>TS</span>, <span class='ident'>H</span><span class='op'>></span> <span class='kw'>where</span> <span class='ident'>TS</span>: <span class='ident'>TransportStream</span>, <span class='ident'>H</span>: <span class='ident'>FnMut</span>(<span class='ident'>ServerRequest</span>) <span class='op'>-></span> <span class='ident'>Response</span> { <span class='ident'>conn</span>: <span class='ident'>ServerConnection</span><span class='op'><</span><span class='ident'>TS</span>, <span class='ident'>TS</span><span class='op'>></span>, <span class='ident'>handler</span>: <span class='ident'>H</span>, } <span class='kw'>impl</span><span class='op'><</span><span class='ident'>TS</span>, <span class='ident'>H</span><span class='op'>></span> <span class='ident'>SimpleServer</span><span class='op'><</span><span class='ident'>TS</span>, <span class='ident'>H</span><span class='op'>></span> <span class='kw'>where</span> <span class='ident'>TS</span>: <span class='ident'>TransportStream</span>, <span class='ident'>H</span>: <span class='ident'>FnMut</span>(<span class='ident'>ServerRequest</span>) <span class='op'>-></span> <span class='ident'>Response</span> { <span class='doccomment'>/// Creates a new `SimpleServer` that will use the given `TransportStream` to communicate to</span> <span class='doccomment'>/// the client. Assumes that the stream is fully uninitialized -- no preface sent or read yet.</span> <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span>(<span class='kw-2'>mut</span> <span class='ident'>stream</span>: <span class='ident'>TS</span>, <span class='ident'>handler</span>: <span class='ident'>H</span>) <span class='op'>-></span> <span class='ident'>HttpResult</span><span class='op'><</span><span class='ident'>SimpleServer</span><span class='op'><</span><span class='ident'>TS</span>, <span class='ident'>H</span><span class='op'>>></span> { <span class='comment'>// First assert that the preface is received</span> <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>preface</span> <span class='op'>=</span> [<span class='number'>0</span>; <span class='number'>24</span>]; <span class='ident'>TransportStream</span>::<span class='ident'>read_exact</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>stream</span>, <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>preface</span>).<span class='ident'>unwrap</span>(); <span class='kw'>if</span> <span class='kw-2'>&</span><span class='ident'>preface</span> <span class='op'>!=</span> <span class='string'>b"PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n"</span> { <span class='kw'>return</span> <span class='prelude-val'>Err</span>(<span class='ident'>HttpError</span>::<span class='ident'>UnableToConnect</span>); } <span class='kw'>let</span> <span class='ident'>conn</span> <span class='op'>=</span> <span class='ident'>HttpConnection</span>::<span class='op'><</span><span class='ident'>TS</span>, <span class='ident'>TS</span><span class='op'>></span>::<span class='ident'>with_stream</span>(<span class='ident'>stream</span>, <span class='ident'>HttpScheme</span>::<span class='ident'>Http</span>); <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>server</span> <span class='op'>=</span> <span class='ident'>SimpleServer</span> { <span class='ident'>conn</span>: <span class='ident'>ServerConnection</span>::<span class='ident'>with_connection</span>(<span class='ident'>conn</span>, <span class='ident'>DefaultSessionState</span>::<span class='ident'>new</span>()), <span class='ident'>handler</span>: <span class='ident'>handler</span>, }; <span class='comment'>// Initialize the connection -- send own settings and process the peer's</span> <span class='macro'>try</span><span class='macro'>!</span>(<span class='ident'>server</span>.<span class='ident'>conn</span>.<span class='ident'>init</span>()); <span class='comment'>// Set up done</span> <span class='prelude-val'>Ok</span>(<span class='ident'>server</span>) } <span class='doccomment'>/// Handles the next incoming frame, blocking to receive it if nothing is available on the</span> <span class='doccomment'>/// underlying stream.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// Handling the frame can trigger the handler callback. Any responses returned by the handler</span> <span class='doccomment'>/// are immediately flushed out to the client (blocking the call until it's done).</span> <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>handle_next</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>HttpResult</span><span class='op'><</span>()<span class='op'>></span> { <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>conn</span>.<span class='ident'>handle_next_frame</span>()); <span class='kw'>let</span> <span class='ident'>responses</span> <span class='op'>=</span> <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>handle_requests</span>()); <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>prepare_responses</span>(<span class='ident'>responses</span>)); <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>flush_streams</span>()); <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>reap_streams</span>()); <span class='prelude-val'>Ok</span>(()) } <span class='doccomment'>/// Invokes the request handler for each fully received request. Collects all the responses</span> <span class='doccomment'>/// into the returned `Vec`.</span> <span class='kw'>fn</span> <span class='ident'>handle_requests</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>HttpResult</span><span class='op'><</span><span class='ident'>Vec</span><span class='op'><</span><span class='ident'>Response</span><span class='op'>>></span> { <span class='kw'>let</span> <span class='ident'>handler</span> <span class='op'>=</span> <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>.<span class='ident'>handler</span>; <span class='prelude-val'>Ok</span>(<span class='self'>self</span>.<span class='ident'>conn</span>.<span class='ident'>state</span>.<span class='ident'>iter</span>().<span class='ident'>filter</span>(<span class='op'>|</span><span class='ident'>s</span><span class='op'>|</span> <span class='ident'>s</span>.<span class='ident'>is_closed_remote</span>()).<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>stream</span><span class='op'>|</span> { <span class='kw'>let</span> <span class='ident'>req</span> <span class='op'>=</span> <span class='ident'>ServerRequest</span> { <span class='ident'>stream_id</span>: <span class='ident'>stream</span>.<span class='ident'>stream_id</span>, <span class='ident'>headers</span>: <span class='ident'>stream</span>.<span class='ident'>headers</span>.<span class='ident'>as_ref</span>().<span class='ident'>unwrap</span>(), <span class='ident'>body</span>: <span class='kw-2'>&</span><span class='ident'>stream</span>.<span class='ident'>body</span>, }; <span class='ident'>handler</span>(<span class='ident'>req</span>) }).<span class='ident'>collect</span>()) } <span class='doccomment'>/// Prepares the streams for each of the given responses. Headers for each response are</span> <span class='doccomment'>/// immediately sent and the data staged into the streams' outgoing buffer.</span> <span class='kw'>fn</span> <span class='ident'>prepare_responses</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>responses</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>Response</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>HttpResult</span><span class='op'><</span>()<span class='op'>></span> { <span class='kw'>for</span> <span class='ident'>response</span> <span class='kw'>in</span> <span class='ident'>responses</span>.<span class='ident'>into_iter</span>() { <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>conn</span>.<span class='ident'>start_response</span>( <span class='ident'>response</span>.<span class='ident'>headers</span>, <span class='ident'>response</span>.<span class='ident'>stream_id</span>, <span class='ident'>EndStream</span>::<span class='ident'>No</span>)); <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>stream</span> <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>conn</span>.<span class='ident'>state</span>.<span class='ident'>get_stream_mut</span>(<span class='ident'>response</span>.<span class='ident'>stream_id</span>).<span class='ident'>unwrap</span>(); <span class='ident'>stream</span>.<span class='ident'>set_full_data</span>(<span class='ident'>response</span>.<span class='ident'>body</span>); } <span class='prelude-val'>Ok</span>(()) } <span class='doccomment'>/// Flushes the outgoing buffers of all streams.</span> <span class='attribute'>#[<span class='ident'>inline</span>]</span> <span class='kw'>fn</span> <span class='ident'>flush_streams</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>HttpResult</span><span class='op'><</span>()<span class='op'>></span> { <span class='kw'>while</span> <span class='kw'>let</span> <span class='ident'>SendStatus</span>::<span class='ident'>Sent</span> <span class='op'>=</span> <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>conn</span>.<span class='ident'>send_next_data</span>()) {} <span class='prelude-val'>Ok</span>(()) } <span class='doccomment'>/// Removes closed streams from the connection state.</span> <span class='attribute'>#[<span class='ident'>inline</span>]</span> <span class='kw'>fn</span> <span class='ident'>reap_streams</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>HttpResult</span><span class='op'><</span>()<span class='op'>></span> { <span class='comment'>// Moves the streams out of the state and then drops them</span> <span class='kw'>let</span> _ <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>conn</span>.<span class='ident'>state</span>.<span class='ident'>get_closed</span>(); <span class='prelude-val'>Ok</span>(()) } } </pre> </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>?</dt> <dd>Show this help dialog</dd> <dt>S</dt> <dd>Focus the search field</dd> <dt>⇤</dt> <dd>Move up in search results</dd> <dt>⇥</dt> <dd>Move down in search results</dd> <dt>⏎</dt> <dd>Go to active search result</dd> <dt>+</dt> <dd>Collapse/expand 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> </div> </div> </aside> <script> window.rootPath = "../../../"; window.currentCrate = "solicit"; window.playgroundUrl = ""; </script> <script src="../../../jquery.js"></script> <script src="../../../main.js"></script> <script defer src="../../../search-index.js"></script> </body> </html>