| <!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 `src/reactor/timeout.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>timeout.rs.html -- source</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="../../../main.css" id="themeStyle"> |
| <script src="../../../storage.js"></script> |
| |
| |
| |
| |
| </head> |
| <body class="rustdoc source"> |
| <!--[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> |
| |
| |
| </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"> |
| </div> |
| </form> |
| </nav> |
| |
| <section id='main' class="content"><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> |
| </pre><pre class="rust "> |
| <span class="doccomment">//! Support for creating futures that represent timeouts.</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! This module contains the `Timeout` type which is a future that will resolve</span> |
| <span class="doccomment">//! at a particular point in the future.</span> |
| |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::{<span class="ident">Duration</span>, <span class="ident">Instant</span>}; |
| |
| <span class="kw">use</span> <span class="ident">futures</span>::{<span class="ident">Future</span>, <span class="ident">Poll</span>, <span class="ident">Async</span>}; |
| |
| <span class="kw">use</span> <span class="ident">reactor</span>::{<span class="ident">Remote</span>, <span class="ident">Handle</span>}; |
| <span class="kw">use</span> <span class="ident">reactor</span>::<span class="ident">timeout_token</span>::<span class="ident">TimeoutToken</span>; |
| |
| <span class="doccomment">/// A future representing the notification that a timeout has occurred.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Timeouts are created through the `Timeout::new` or</span> |
| <span class="doccomment">/// `Timeout::new_at` methods indicating when a timeout should fire at.</span> |
| <span class="doccomment">/// Note that timeouts are not intended for high resolution timers, but rather</span> |
| <span class="doccomment">/// they will likely fire some granularity after the exact instant that they're</span> |
| <span class="doccomment">/// otherwise indicated to fire at.</span> |
| <span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">"futures do nothing unless polled"</span>]</span> |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Timeout</span> { |
| <span class="ident">token</span>: <span class="ident">TimeoutToken</span>, |
| <span class="ident">when</span>: <span class="ident">Instant</span>, |
| <span class="ident">handle</span>: <span class="ident">Remote</span>, |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Timeout</span> { |
| <span class="doccomment">/// Creates a new timeout which will fire at `dur` time into the future.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function will return a Result with the actual timeout object or an</span> |
| <span class="doccomment">/// error. The timeout object itself is then a future which will be</span> |
| <span class="doccomment">/// set to fire at the specified point in the future.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">dur</span>: <span class="ident">Duration</span>, <span class="ident">handle</span>: <span class="kw-2">&</span><span class="ident">Handle</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Timeout</span><span class="op">></span> { |
| <span class="ident">Timeout</span>::<span class="ident">new_at</span>(<span class="ident">Instant</span>::<span class="ident">now</span>() <span class="op">+</span> <span class="ident">dur</span>, <span class="ident">handle</span>) |
| } |
| |
| <span class="doccomment">/// Creates a new timeout which will fire at the time specified by `at`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function will return a Result with the actual timeout object or an</span> |
| <span class="doccomment">/// error. The timeout object itself is then a future which will be</span> |
| <span class="doccomment">/// set to fire at the specified point in the future.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new_at</span>(<span class="ident">at</span>: <span class="ident">Instant</span>, <span class="ident">handle</span>: <span class="kw-2">&</span><span class="ident">Handle</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Timeout</span><span class="op">></span> { |
| <span class="prelude-val">Ok</span>(<span class="ident">Timeout</span> { |
| <span class="ident">token</span>: <span class="macro">try</span><span class="macro">!</span>(<span class="ident">TimeoutToken</span>::<span class="ident">new</span>(<span class="ident">at</span>, <span class="kw-2">&</span><span class="ident">handle</span>)), |
| <span class="ident">when</span>: <span class="ident">at</span>, |
| <span class="ident">handle</span>: <span class="ident">handle</span>.<span class="ident">remote</span>().<span class="ident">clone</span>(), |
| }) |
| } |
| |
| <span class="doccomment">/// Resets this timeout to an new timeout which will fire at the time</span> |
| <span class="doccomment">/// specified by `at`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method is usable even of this instance of `Timeout` has "already</span> |
| <span class="doccomment">/// fired". That is, if this future has resolved, calling this method means</span> |
| <span class="doccomment">/// that the future will still re-resolve at the specified instant.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If `at` is in the past then this future will immediately be resolved</span> |
| <span class="doccomment">/// (when `poll` is called).</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Note that if any task is currently blocked on this future then that task</span> |
| <span class="doccomment">/// will be dropped. It is required to call `poll` again after this method</span> |
| <span class="doccomment">/// has been called to ensure that a task is blocked on this future.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">reset</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">at</span>: <span class="ident">Instant</span>) { |
| <span class="self">self</span>.<span class="ident">when</span> <span class="op">=</span> <span class="ident">at</span>; |
| <span class="self">self</span>.<span class="ident">token</span>.<span class="ident">reset_timeout</span>(<span class="self">self</span>.<span class="ident">when</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">handle</span>); |
| } |
| |
| <span class="doccomment">/// Polls this `Timeout` instance to see if it's elapsed, assuming the</span> |
| <span class="doccomment">/// current time is specified by `now`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The `Future::poll` implementation for `Timeout` will call `Instant::now`</span> |
| <span class="doccomment">/// each time it's invoked, but in some contexts this can be a costly</span> |
| <span class="doccomment">/// operation. This method is provided to amortize the cost by avoiding</span> |
| <span class="doccomment">/// usage of `Instant::now`, assuming that it's been called elsewhere.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function takes the assumed current time as the first parameter and</span> |
| <span class="doccomment">/// otherwise functions as this future's `poll` function. This will block a</span> |
| <span class="doccomment">/// task if one isn't already blocked or update a previous one if already</span> |
| <span class="doccomment">/// blocked.</span> |
| <span class="kw">fn</span> <span class="ident">poll_at</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">now</span>: <span class="ident">Instant</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span>(), <span class="ident">io</span>::<span class="ident">Error</span><span class="op">></span> { |
| <span class="kw">if</span> <span class="self">self</span>.<span class="ident">when</span> <span class="op"><=</span> <span class="ident">now</span> { |
| <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(())) |
| } <span class="kw">else</span> { |
| <span class="self">self</span>.<span class="ident">token</span>.<span class="ident">update_timeout</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">handle</span>); |
| <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">NotReady</span>) |
| } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">Timeout</span> { |
| <span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> (); |
| <span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">io</span>::<span class="ident">Error</span>; |
| |
| <span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span>(), <span class="ident">io</span>::<span class="ident">Error</span><span class="op">></span> { |
| <span class="comment">// TODO: is this fast enough?</span> |
| <span class="self">self</span>.<span class="ident">poll_at</span>(<span class="ident">Instant</span>::<span class="ident">now</span>()) |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">Timeout</span> { |
| <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) { |
| <span class="self">self</span>.<span class="ident">token</span>.<span class="ident">cancel_timeout</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">handle</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><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> |
| </div> |
| </div> |
| </aside> |
| |
| |
| |
| <script> |
| window.rootPath = "../../../"; |
| window.currentCrate = "tokio_core"; |
| </script> |
| <script src="../../../main.js"></script> |
| <script defer src="../../../search-index.js"></script> |
| </body> |
| </html> |
