| <!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/io_token.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>io_token.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> |
| <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> |
| </pre><pre class="rust "> |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicUsize</span>, <span class="ident">Ordering</span>}; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; |
| |
| <span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">task</span>; |
| <span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">event</span>::<span class="ident">Evented</span>; |
| |
| <span class="kw">use</span> <span class="ident">reactor</span>::{<span class="ident">Message</span>, <span class="ident">Remote</span>, <span class="ident">Handle</span>, <span class="ident">Direction</span>}; |
| |
| <span class="doccomment">/// A token that identifies an active timeout.</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">IoToken</span> { |
| <span class="ident">token</span>: <span class="ident">usize</span>, |
| <span class="comment">// TODO: can we avoid this allocation? It's kind of a bummer...</span> |
| <span class="ident">readiness</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">AtomicUsize</span><span class="op">></span>, |
| } |
| |
| <span class="kw">impl</span> <span class="ident">IoToken</span> { |
| <span class="doccomment">/// Add a new source to an event loop, returning a future which will resolve</span> |
| <span class="doccomment">/// to the token that can be used to identify this source.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// When a new I/O object is created it needs to be communicated to the</span> |
| <span class="doccomment">/// event loop to ensure that it's registered and ready to receive</span> |
| <span class="doccomment">/// notifications. The event loop will then respond back with the I/O object</span> |
| <span class="doccomment">/// and a token which can be used to send more messages to the event loop.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The token returned is then passed in turn to each of the methods below</span> |
| <span class="doccomment">/// to interact with notifications on the I/O object itself.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The returned future will panic if the event loop this handle is</span> |
| <span class="doccomment">/// associated with has gone away, or if there is an error communicating</span> |
| <span class="doccomment">/// with the event loop.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">source</span>: <span class="kw-2">&</span><span class="ident">Evented</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">IoToken</span><span class="op">></span> { |
| <span class="kw">match</span> <span class="ident">handle</span>.<span class="ident">inner</span>.<span class="ident">upgrade</span>() { |
| <span class="prelude-val">Some</span>(<span class="ident">inner</span>) <span class="op">=></span> { |
| <span class="kw">let</span> (<span class="ident">ready</span>, <span class="ident">token</span>) <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">inner</span>.<span class="ident">borrow_mut</span>().<span class="ident">add_source</span>(<span class="ident">source</span>)); |
| <span class="prelude-val">Ok</span>(<span class="ident">IoToken</span> { <span class="ident">token</span>: <span class="ident">token</span>, <span class="ident">readiness</span>: <span class="ident">ready</span> }) |
| } |
| <span class="prelude-val">None</span> <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">Error</span>::<span class="ident">new</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">Other</span>, <span class="string">"event loop gone"</span>)), |
| } |
| } |
| |
| <span class="doccomment">/// Consumes the last readiness notification the token this source is for</span> |
| <span class="doccomment">/// registered.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Currently sources receive readiness notifications on an edge-basis. That</span> |
| <span class="doccomment">/// is, once you receive a notification that an object can be read, you</span> |
| <span class="doccomment">/// won't receive any more notifications until all of that data has been</span> |
| <span class="doccomment">/// read.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The event loop will fill in this information and then inform futures</span> |
| <span class="doccomment">/// that they're ready to go with the `schedule` method, and then the `poll`</span> |
| <span class="doccomment">/// method can use this to figure out what happened.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// > **Note**: This method should generally not be used directly, but</span> |
| <span class="doccomment">/// > rather the `ReadinessStream` type should be used instead.</span> |
| <span class="comment">// TODO: this should really return a proper newtype/enum, not a usize</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">take_readiness</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="self">self</span>.<span class="ident">readiness</span>.<span class="ident">swap</span>(<span class="number">0</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>) |
| } |
| |
| <span class="doccomment">/// Schedule the current future task to receive a notification when the</span> |
| <span class="doccomment">/// corresponding I/O object is readable.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Once an I/O object has been registered with the event loop through the</span> |
| <span class="doccomment">/// `add_source` method, this method can be used with the assigned token to</span> |
| <span class="doccomment">/// notify the current future task when the next read notification comes in.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The current task will only receive a notification **once** and to</span> |
| <span class="doccomment">/// receive further notifications it will need to call `schedule_read`</span> |
| <span class="doccomment">/// again.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// > **Note**: This method should generally not be used directly, but</span> |
| <span class="doccomment">/// > rather the `ReadinessStream` type should be used instead.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function will panic if the event loop this handle is associated</span> |
| <span class="doccomment">/// with has gone away, or if there is an error communicating with the event</span> |
| <span class="doccomment">/// loop.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function will also panic if there is not a currently running future</span> |
| <span class="doccomment">/// task.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">schedule_read</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">handle</span>: <span class="kw-2">&</span><span class="ident">Remote</span>) { |
| <span class="ident">handle</span>.<span class="ident">send</span>(<span class="ident">Message</span>::<span class="ident">Schedule</span>(<span class="self">self</span>.<span class="ident">token</span>, <span class="ident">task</span>::<span class="ident">current</span>(), <span class="ident">Direction</span>::<span class="ident">Read</span>)); |
| } |
| |
| <span class="doccomment">/// Schedule the current future task to receive a notification when the</span> |
| <span class="doccomment">/// corresponding I/O object is writable.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Once an I/O object has been registered with the event loop through the</span> |
| <span class="doccomment">/// `add_source` method, this method can be used with the assigned token to</span> |
| <span class="doccomment">/// notify the current future task when the next write notification comes</span> |
| <span class="doccomment">/// in.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The current task will only receive a notification **once** and to</span> |
| <span class="doccomment">/// receive further notifications it will need to call `schedule_write`</span> |
| <span class="doccomment">/// again.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// > **Note**: This method should generally not be used directly, but</span> |
| <span class="doccomment">/// > rather the `ReadinessStream` type should be used instead.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function will panic if the event loop this handle is associated</span> |
| <span class="doccomment">/// with has gone away, or if there is an error communicating with the event</span> |
| <span class="doccomment">/// loop.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function will also panic if there is not a currently running future</span> |
| <span class="doccomment">/// task.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">schedule_write</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">handle</span>: <span class="kw-2">&</span><span class="ident">Remote</span>) { |
| <span class="ident">handle</span>.<span class="ident">send</span>(<span class="ident">Message</span>::<span class="ident">Schedule</span>(<span class="self">self</span>.<span class="ident">token</span>, <span class="ident">task</span>::<span class="ident">current</span>(), <span class="ident">Direction</span>::<span class="ident">Write</span>)); |
| } |
| |
| <span class="doccomment">/// Unregister all information associated with a token on an event loop,</span> |
| <span class="doccomment">/// deallocating all internal resources assigned to the given token.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method should be called whenever a source of events is being</span> |
| <span class="doccomment">/// destroyed. This will ensure that the event loop can reuse `tok` for</span> |
| <span class="doccomment">/// another I/O object if necessary and also remove it from any poll</span> |
| <span class="doccomment">/// notifications and callbacks.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Note that wake callbacks may still be invoked after this method is</span> |
| <span class="doccomment">/// called as it may take some time for the message to drop a source to</span> |
| <span class="doccomment">/// reach the event loop. Despite this fact, this method will attempt to</span> |
| <span class="doccomment">/// ensure that the callbacks are **not** invoked, so pending scheduled</span> |
| <span class="doccomment">/// callbacks cannot be relied upon to get called.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// > **Note**: This method should generally not be used directly, but</span> |
| <span class="doccomment">/// > rather the `ReadinessStream` type should be used instead.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function will panic if the event loop this handle is associated</span> |
| <span class="doccomment">/// with has gone away, or if there is an error communicating with the event</span> |
| <span class="doccomment">/// loop.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">drop_source</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">handle</span>: <span class="kw-2">&</span><span class="ident">Remote</span>) { |
| <span class="ident">handle</span>.<span class="ident">send</span>(<span class="ident">Message</span>::<span class="ident">DropSource</span>(<span class="self">self</span>.<span class="ident">token</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> |
