| <!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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/mio-0.8.8/src/waker.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>waker.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../mio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../mio/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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><pre class="rust"><code><span class="kw">use crate</span>::{sys, Registry, Token}; |
| |
| <span class="kw">use </span>std::io; |
| |
| <span class="doccomment">/// Waker allows cross-thread waking of [`Poll`]. |
| /// |
| /// When created it will cause events with [`readable`] readiness and the |
| /// provided `token` if [`wake`] is called, possibly from another thread. |
| /// |
| /// [`Poll`]: struct.Poll.html |
| /// [`readable`]: ./event/struct.Event.html#method.is_readable |
| /// [`wake`]: struct.Waker.html#method.wake |
| /// |
| /// # Notes |
| /// |
| /// `Waker` events are only guaranteed to be delivered while the `Waker` value |
| /// is alive. |
| /// |
| /// Only a single `Waker` can be active per [`Poll`], if multiple threads need |
| /// access to the `Waker` it can be shared via for example an `Arc`. What |
| /// happens if multiple `Waker`s are registered with the same `Poll` is |
| /// unspecified. |
| /// |
| /// # Implementation notes |
| /// |
| /// On platforms that support kqueue this will use the `EVFILT_USER` event |
| /// filter, see [implementation notes of `Poll`] to see what platforms support |
| /// kqueue. On Linux it uses [eventfd]. |
| /// |
| /// [implementation notes of `Poll`]: struct.Poll.html#implementation-notes |
| /// [eventfd]: https://man7.org/linux/man-pages/man2/eventfd.2.html |
| /// |
| /// # Examples |
| /// |
| /// Wake a [`Poll`] instance from another thread. |
| /// |
| </span><span class="attribute">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)] |
| #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">/// # fn main() -> Result<(), Box<dyn std::error::Error>> { |
| /// use std::thread; |
| /// use std::time::Duration; |
| /// use std::sync::Arc; |
| /// |
| /// use mio::{Events, Token, Poll, Waker}; |
| /// |
| /// const WAKE_TOKEN: Token = Token(10); |
| /// |
| /// let mut poll = Poll::new()?; |
| /// let mut events = Events::with_capacity(2); |
| /// |
| /// let waker = Arc::new(Waker::new(poll.registry(), WAKE_TOKEN)?); |
| /// |
| /// // We need to keep the Waker alive, so we'll create a clone for the |
| /// // thread we create below. |
| /// let waker1 = waker.clone(); |
| /// let handle = thread::spawn(move || { |
| /// // Working hard, or hardly working? |
| /// thread::sleep(Duration::from_millis(500)); |
| /// |
| /// // Now we'll wake the queue on the other thread. |
| /// waker1.wake().expect("unable to wake"); |
| /// }); |
| /// |
| /// // On our current thread we'll poll for events, without a timeout. |
| /// poll.poll(&mut events, None)?; |
| /// |
| /// // After about 500 milliseconds we should be awoken by the other thread and |
| /// // get a single event. |
| /// assert!(!events.is_empty()); |
| /// let waker_event = events.iter().next().unwrap(); |
| /// assert!(waker_event.is_readable()); |
| /// assert_eq!(waker_event.token(), WAKE_TOKEN); |
| /// # handle.join().unwrap(); |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Waker { |
| inner: sys::Waker, |
| } |
| |
| <span class="kw">impl </span>Waker { |
| <span class="doccomment">/// Create a new `Waker`. |
| </span><span class="kw">pub fn </span>new(registry: <span class="kw-2">&</span>Registry, token: Token) -> io::Result<Waker> { |
| <span class="attribute">#[cfg(debug_assertions)] |
| </span>registry.register_waker(); |
| sys::Waker::new(registry.selector(), token).map(|inner| Waker { inner }) |
| } |
| |
| <span class="doccomment">/// Wake up the [`Poll`] associated with this `Waker`. |
| /// |
| /// [`Poll`]: struct.Poll.html |
| </span><span class="kw">pub fn </span>wake(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<()> { |
| <span class="self">self</span>.inner.wake() |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="mio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
