| <!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 of the Rust file `src/waker.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>waker.rs - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg"> |
| <link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"> |
| <link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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" role="button">☰</div><a href='../../mio/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button> |
| <a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></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> |
| </pre><div class="example-wrap"><pre class="rust "> |
| <span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">poll</span>, <span class="ident">sys</span>, <span class="ident">Registry</span>, <span class="ident">Token</span>}; |
| |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; |
| |
| <span class="doccomment">/// Waker allows cross-thread waking of [`Poll`].</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// When created it will cause events with [`readable`] readiness and the</span> |
| <span class="doccomment">/// provided `token` if [`wake`] is called, possibly from another thread.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`Poll`]: struct.Poll.html</span> |
| <span class="doccomment">/// [`readable`]: ./event/struct.Event.html#method.is_readable</span> |
| <span class="doccomment">/// [`wake`]: struct.Waker.html#method.wake</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Notes</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// `Waker` events are only guaranteed to be delivered while the `Waker` value</span> |
| <span class="doccomment">/// is alive.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Only a single `Waker` can be active per [`Poll`], if multiple threads need</span> |
| <span class="doccomment">/// access to the `Waker` it can be shared via for example an `Arc`. What</span> |
| <span class="doccomment">/// happens if multiple `Waker`s are registered with the same `Poll` is</span> |
| <span class="doccomment">/// unspecified.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Implementation notes</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// On platforms that support kqueue this will use the `EVFILT_USER` event</span> |
| <span class="doccomment">/// filter, see [implementation notes of `Poll`] to see what platforms support</span> |
| <span class="doccomment">/// kqueue. On Linux it uses [eventfd].</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [implementation notes of `Poll`]: struct.Poll.html#implementation-notes</span> |
| <span class="doccomment">/// [eventfd]: http://man7.org/linux/man-pages/man2/eventfd.2.html</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Examples</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Wake a [`Poll`] instance from another thread.</span> |
| <span class="doccomment">///</span> |
| <span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"os-poll"</span>, <span class="ident">doc</span> <span class="op">=</span> <span class="string">"```"</span>)]</span> |
| <span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"os-poll"</span>), <span class="ident">doc</span> <span class="op">=</span> <span class="string">"```ignore"</span>)]</span> |
| <span class="doccomment">/// # fn main() -> Result<(), Box<dyn std::error::Error>> {</span> |
| <span class="doccomment">/// use std::thread;</span> |
| <span class="doccomment">/// use std::time::Duration;</span> |
| <span class="doccomment">/// use std::sync::Arc;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// use mio::{Events, Token, Poll, Waker};</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// const WAKE_TOKEN: Token = Token(10);</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// let mut poll = Poll::new()?;</span> |
| <span class="doccomment">/// let mut events = Events::with_capacity(2);</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// let waker = Arc::new(Waker::new(poll.registry(), WAKE_TOKEN)?);</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // We need to keep the Waker alive, so we'll create a clone for the</span> |
| <span class="doccomment">/// // thread we create below.</span> |
| <span class="doccomment">/// let waker1 = waker.clone();</span> |
| <span class="doccomment">/// let handle = thread::spawn(move || {</span> |
| <span class="doccomment">/// // Working hard, or hardly working?</span> |
| <span class="doccomment">/// thread::sleep(Duration::from_millis(500));</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // Now we'll wake the queue on the other thread.</span> |
| <span class="doccomment">/// waker1.wake().expect("unable to wake");</span> |
| <span class="doccomment">/// });</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // On our current thread we'll poll for events, without a timeout.</span> |
| <span class="doccomment">/// poll.poll(&mut events, None)?;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // After about 500 milliseconds we should be awoken by the other thread and</span> |
| <span class="doccomment">/// // get a single event.</span> |
| <span class="doccomment">/// assert!(!events.is_empty());</span> |
| <span class="doccomment">/// let waker_event = events.iter().next().unwrap();</span> |
| <span class="doccomment">/// assert!(waker_event.is_readable());</span> |
| <span class="doccomment">/// assert_eq!(waker_event.token(), WAKE_TOKEN);</span> |
| <span class="doccomment">/// # handle.join().unwrap();</span> |
| <span class="doccomment">/// # Ok(())</span> |
| <span class="doccomment">/// # }</span> |
| <span class="doccomment">/// ```</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">Waker</span> { |
| <span class="ident">inner</span>: <span class="ident">sys</span>::<span class="ident">Waker</span>, |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Waker</span> { |
| <span class="doccomment">/// Create a new `Waker`.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">registry</span>: <span class="kw-2">&</span><span class="ident">Registry</span>, <span class="ident">token</span>: <span class="ident">Token</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Waker</span><span class="op">></span> { |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">debug_assertions</span>)]</span> |
| <span class="ident">registry</span>.<span class="ident">register_waker</span>(); |
| <span class="ident">sys</span>::<span class="ident">Waker</span>::<span class="ident">new</span>(<span class="ident">poll</span>::<span class="ident">selector</span>(<span class="kw-2">&</span><span class="ident">registry</span>), <span class="ident">token</span>).<span class="ident">map</span>(<span class="op">|</span><span class="ident">inner</span><span class="op">|</span> <span class="ident">Waker</span> { <span class="ident">inner</span> }) |
| } |
| |
| <span class="doccomment">/// Wake up the [`Poll`] associated with this `Waker`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`Poll`]: struct.Poll.html</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">wake</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">wake</span>() |
| } |
| } |
| </pre></div> |
| </section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="mio" data-search-js="../../search-index.js"></div> |
| <script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html> |
