| <!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/token.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>token.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> |
| <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> |
| </pre><div class="example-wrap"><pre class="rust "> |
| <span class="doccomment">/// Associates readiness events with [`event::Source`]s.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// `Token` is a wrapper around `usize` and is used as an argument to</span> |
| <span class="doccomment">/// [`Registry::register`] and [`Registry::reregister`].</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// See [`Poll`] for more documentation on polling.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`event::Source`]: ./event/trait.Source.html</span> |
| <span class="doccomment">/// [`Poll`]: struct.Poll.html</span> |
| <span class="doccomment">/// [`Registry::register`]: struct.Registry.html#method.register</span> |
| <span class="doccomment">/// [`Registry::reregister`]: struct.Registry.html#method.reregister</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Example</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Using `Token` to track which socket generated the event. In this example,</span> |
| <span class="doccomment">/// `HashMap` is used, but usually something like [`slab`] is better.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`slab`]: https://crates.io/crates/slab</span> |
| <span class="doccomment">///</span> |
| <span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">all</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"os-poll"</span>, <span class="ident">feature</span> <span class="op">=</span> <span class="string">"net"</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">all</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"os-poll"</span>, <span class="ident">feature</span> <span class="op">=</span> <span class="string">"net"</span>)), <span class="ident">doc</span> <span class="op">=</span> <span class="string">"```ignore"</span>)]</span> |
| <span class="doccomment">/// # use std::error::Error;</span> |
| <span class="doccomment">/// # fn main() -> Result<(), Box<dyn Error>> {</span> |
| <span class="doccomment">/// use mio::{Events, Interest, Poll, Token};</span> |
| <span class="doccomment">/// use mio::net::TcpListener;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// use std::thread;</span> |
| <span class="doccomment">/// use std::io::{self, Read};</span> |
| <span class="doccomment">/// use std::collections::HashMap;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // After this number of sockets is accepted, the server will shutdown.</span> |
| <span class="doccomment">/// const MAX_SOCKETS: usize = 32;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // Pick a token that will not be used by any other socket and use that one</span> |
| <span class="doccomment">/// // for the listener.</span> |
| <span class="doccomment">/// const LISTENER: Token = Token(1024);</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // Used to store the sockets.</span> |
| <span class="doccomment">/// let mut sockets = HashMap::new();</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // This is used to generate a unique token for a socket</span> |
| <span class="doccomment">/// let mut next_socket_index = 0;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // The `Poll` instance</span> |
| <span class="doccomment">/// let mut poll = Poll::new()?;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // Tcp listener</span> |
| <span class="doccomment">/// let mut listener = TcpListener::bind("127.0.0.1:0".parse()?)?;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // Register the listener</span> |
| <span class="doccomment">/// poll.registry().register(&mut listener, LISTENER, Interest::READABLE)?;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // Spawn a thread that will connect a bunch of sockets then close them</span> |
| <span class="doccomment">/// let addr = listener.local_addr()?;</span> |
| <span class="doccomment">/// thread::spawn(move || {</span> |
| <span class="doccomment">/// use std::net::TcpStream;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // +1 here is to connect an extra socket to signal the socket to close</span> |
| <span class="doccomment">/// for _ in 0..(MAX_SOCKETS+1) {</span> |
| <span class="doccomment">/// // Connect then drop the socket</span> |
| <span class="doccomment">/// let _ = TcpStream::connect(addr).unwrap();</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// });</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // Event storage</span> |
| <span class="doccomment">/// let mut events = Events::with_capacity(1024);</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // Read buffer, this will never actually get filled</span> |
| <span class="doccomment">/// let mut buf = [0; 256];</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // The main event loop</span> |
| <span class="doccomment">/// loop {</span> |
| <span class="doccomment">/// // Wait for events</span> |
| <span class="doccomment">/// poll.poll(&mut events, None)?;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// for event in &events {</span> |
| <span class="doccomment">/// match event.token() {</span> |
| <span class="doccomment">/// LISTENER => {</span> |
| <span class="doccomment">/// // Perform operations in a loop until `WouldBlock` is</span> |
| <span class="doccomment">/// // encountered.</span> |
| <span class="doccomment">/// loop {</span> |
| <span class="doccomment">/// match listener.accept() {</span> |
| <span class="doccomment">/// Ok((mut socket, _)) => {</span> |
| <span class="doccomment">/// // Shutdown the server</span> |
| <span class="doccomment">/// if next_socket_index == MAX_SOCKETS {</span> |
| <span class="doccomment">/// return Ok(());</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // Get the token for the socket</span> |
| <span class="doccomment">/// let token = Token(next_socket_index);</span> |
| <span class="doccomment">/// next_socket_index += 1;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // Register the new socket w/ poll</span> |
| <span class="doccomment">/// poll.registry().register(&mut socket, token, Interest::READABLE)?;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// // Store the socket</span> |
| <span class="doccomment">/// sockets.insert(token, socket);</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => {</span> |
| <span class="doccomment">/// // Socket is not ready anymore, stop accepting</span> |
| <span class="doccomment">/// break;</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// e => panic!("err={:?}", e), // Unexpected error</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// token => {</span> |
| <span class="doccomment">/// // Always operate in a loop</span> |
| <span class="doccomment">/// loop {</span> |
| <span class="doccomment">/// match sockets.get_mut(&token).unwrap().read(&mut buf) {</span> |
| <span class="doccomment">/// Ok(0) => {</span> |
| <span class="doccomment">/// // Socket is closed, remove it from the map</span> |
| <span class="doccomment">/// sockets.remove(&token);</span> |
| <span class="doccomment">/// break;</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// // Data is not actually sent in this example</span> |
| <span class="doccomment">/// Ok(_) => unreachable!(),</span> |
| <span class="doccomment">/// Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => {</span> |
| <span class="doccomment">/// // Socket is not ready anymore, stop reading</span> |
| <span class="doccomment">/// break;</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// e => panic!("err={:?}", e), // Unexpected error</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// # }</span> |
| <span class="doccomment">/// ```</span> |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">PartialOrd</span>, <span class="ident">Ord</span>, <span class="ident">Hash</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Token</span>(<span class="kw">pub</span> <span class="ident">usize</span>); |
| |
| <span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Token</span><span class="op">></span> <span class="kw">for</span> <span class="ident">usize</span> { |
| <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">val</span>: <span class="ident">Token</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> { |
| <span class="ident">val</span>.<span class="number">0</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> |
