278 lines
26 KiB
HTML
278 lines
26 KiB
HTML
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/lib.rs`."><title>lib.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="attr">#![deny(
|
|
<a href=#2 id=2 data-nosnippet>2</a> missing_docs,
|
|
<a href=#3 id=3 data-nosnippet>3</a> missing_debug_implementations,
|
|
<a href=#4 id=4 data-nosnippet>4</a> rust_2018_idioms,
|
|
<a href=#5 id=5 data-nosnippet>5</a> unused_imports,
|
|
<a href=#6 id=6 data-nosnippet>6</a> dead_code
|
|
<a href=#7 id=7 data-nosnippet>7</a>)]
|
|
<a href=#8 id=8 data-nosnippet>8</a>#![cfg_attr(docsrs, feature(doc_cfg))]
|
|
<a href=#9 id=9 data-nosnippet>9</a></span><span class="comment">// Disallow warnings when running tests.
|
|
<a href=#10 id=10 data-nosnippet>10</a></span><span class="attr">#![cfg_attr(test, deny(warnings))]
|
|
<a href=#11 id=11 data-nosnippet>11</a></span><span class="comment">// Disallow warnings in examples.
|
|
<a href=#12 id=12 data-nosnippet>12</a></span><span class="attr">#![doc(test(attr(deny(warnings))))]
|
|
<a href=#13 id=13 data-nosnippet>13</a>
|
|
<a href=#14 id=14 data-nosnippet>14</a></span><span class="doccomment">//! Mio is a fast, low-level I/O library for Rust focusing on non-blocking APIs
|
|
<a href=#15 id=15 data-nosnippet>15</a>//! and event notification for building high performance I/O apps with as little
|
|
<a href=#16 id=16 data-nosnippet>16</a>//! overhead as possible over the OS abstractions.
|
|
<a href=#17 id=17 data-nosnippet>17</a>//!
|
|
<a href=#18 id=18 data-nosnippet>18</a>//! # Usage
|
|
<a href=#19 id=19 data-nosnippet>19</a>//!
|
|
<a href=#20 id=20 data-nosnippet>20</a>//! Using Mio starts by creating a [`Poll`], which reads events from the OS and
|
|
<a href=#21 id=21 data-nosnippet>21</a>//! puts them into [`Events`]. You can handle I/O events from the OS with it.
|
|
<a href=#22 id=22 data-nosnippet>22</a>//!
|
|
<a href=#23 id=23 data-nosnippet>23</a>//! For more detail, see [`Poll`].
|
|
<a href=#24 id=24 data-nosnippet>24</a>//!
|
|
<a href=#25 id=25 data-nosnippet>25</a>//! [`Poll`]: ../mio/struct.Poll.html
|
|
<a href=#26 id=26 data-nosnippet>26</a>//! [`Events`]: ../mio/event/struct.Events.html
|
|
<a href=#27 id=27 data-nosnippet>27</a>//!
|
|
<a href=#28 id=28 data-nosnippet>28</a>//! ## Examples
|
|
<a href=#29 id=29 data-nosnippet>29</a>//!
|
|
<a href=#30 id=30 data-nosnippet>30</a>//! Examples can be found in the `examples` directory of the source code, or [on
|
|
<a href=#31 id=31 data-nosnippet>31</a>//! GitHub].
|
|
<a href=#32 id=32 data-nosnippet>32</a>//!
|
|
<a href=#33 id=33 data-nosnippet>33</a>//! [on GitHub]: https://github.com/tokio-rs/mio/tree/master/examples
|
|
<a href=#34 id=34 data-nosnippet>34</a>//!
|
|
<a href=#35 id=35 data-nosnippet>35</a>//! ## Guide
|
|
<a href=#36 id=36 data-nosnippet>36</a>//!
|
|
<a href=#37 id=37 data-nosnippet>37</a>//! A getting started guide is available in the [`guide`] module.
|
|
<a href=#38 id=38 data-nosnippet>38</a>//!
|
|
<a href=#39 id=39 data-nosnippet>39</a>//! ## Available features
|
|
<a href=#40 id=40 data-nosnippet>40</a>//!
|
|
<a href=#41 id=41 data-nosnippet>41</a>//! The available features are described in the [`features`] module.
|
|
<a href=#42 id=42 data-nosnippet>42</a>
|
|
<a href=#43 id=43 data-nosnippet>43</a></span><span class="attr">#[cfg(all(target_family = <span class="string">"wasm"</span>, not(target_os = <span class="string">"wasi"</span>)))]
|
|
<a href=#44 id=44 data-nosnippet>44</a></span><span class="macro">compile_error!</span>(<span class="string">"This wasm target is unsupported by mio. If using Tokio, disable the net feature."</span>);
|
|
<a href=#45 id=45 data-nosnippet>45</a>
|
|
<a href=#46 id=46 data-nosnippet>46</a><span class="comment">// macros used internally
|
|
<a href=#47 id=47 data-nosnippet>47</a></span><span class="attr">#[macro_use]
|
|
<a href=#48 id=48 data-nosnippet>48</a></span><span class="kw">mod </span>macros;
|
|
<a href=#49 id=49 data-nosnippet>49</a>
|
|
<a href=#50 id=50 data-nosnippet>50</a><span class="kw">mod </span>interest;
|
|
<a href=#51 id=51 data-nosnippet>51</a><span class="kw">mod </span>poll;
|
|
<a href=#52 id=52 data-nosnippet>52</a><span class="kw">mod </span>sys;
|
|
<a href=#53 id=53 data-nosnippet>53</a><span class="kw">mod </span>token;
|
|
<a href=#54 id=54 data-nosnippet>54</a><span class="attr">#[cfg(not(target_os = <span class="string">"wasi"</span>))]
|
|
<a href=#55 id=55 data-nosnippet>55</a></span><span class="kw">mod </span>waker;
|
|
<a href=#56 id=56 data-nosnippet>56</a>
|
|
<a href=#57 id=57 data-nosnippet>57</a><span class="kw">pub mod </span>event;
|
|
<a href=#58 id=58 data-nosnippet>58</a>
|
|
<a href=#59 id=59 data-nosnippet>59</a><span class="macro">cfg_io_source!</span> {
|
|
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">mod </span>io_source;
|
|
<a href=#61 id=61 data-nosnippet>61</a>}
|
|
<a href=#62 id=62 data-nosnippet>62</a>
|
|
<a href=#63 id=63 data-nosnippet>63</a><span class="macro">cfg_net!</span> {
|
|
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">pub mod </span>net;
|
|
<a href=#65 id=65 data-nosnippet>65</a>}
|
|
<a href=#66 id=66 data-nosnippet>66</a>
|
|
<a href=#67 id=67 data-nosnippet>67</a><span class="attr">#[doc(no_inline)]
|
|
<a href=#68 id=68 data-nosnippet>68</a></span><span class="kw">pub use </span>event::Events;
|
|
<a href=#69 id=69 data-nosnippet>69</a><span class="kw">pub use </span>interest::Interest;
|
|
<a href=#70 id=70 data-nosnippet>70</a><span class="kw">pub use </span>poll::{Poll, Registry};
|
|
<a href=#71 id=71 data-nosnippet>71</a><span class="kw">pub use </span>token::Token;
|
|
<a href=#72 id=72 data-nosnippet>72</a><span class="attr">#[cfg(not(target_os = <span class="string">"wasi"</span>))]
|
|
<a href=#73 id=73 data-nosnippet>73</a></span><span class="kw">pub use </span>waker::Waker;
|
|
<a href=#74 id=74 data-nosnippet>74</a>
|
|
<a href=#75 id=75 data-nosnippet>75</a><span class="attr">#[cfg(all(unix, feature = <span class="string">"os-ext"</span>))]
|
|
<a href=#76 id=76 data-nosnippet>76</a>#[cfg_attr(docsrs, doc(cfg(all(unix, feature = <span class="string">"os-ext"</span>))))]
|
|
<a href=#77 id=77 data-nosnippet>77</a></span><span class="kw">pub mod </span>unix {
|
|
<a href=#78 id=78 data-nosnippet>78</a> <span class="doccomment">//! Unix only extensions.
|
|
<a href=#79 id=79 data-nosnippet>79</a>
|
|
<a href=#80 id=80 data-nosnippet>80</a> </span><span class="kw">pub mod </span>pipe {
|
|
<a href=#81 id=81 data-nosnippet>81</a> <span class="doccomment">//! Unix pipe.
|
|
<a href=#82 id=82 data-nosnippet>82</a> //!
|
|
<a href=#83 id=83 data-nosnippet>83</a> //! See the [`new`] function for documentation.
|
|
<a href=#84 id=84 data-nosnippet>84</a>
|
|
<a href=#85 id=85 data-nosnippet>85</a> </span><span class="kw">pub use </span><span class="kw">crate</span>::sys::pipe::{new, Receiver, Sender};
|
|
<a href=#86 id=86 data-nosnippet>86</a> }
|
|
<a href=#87 id=87 data-nosnippet>87</a>
|
|
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">pub use </span><span class="kw">crate</span>::sys::SourceFd;
|
|
<a href=#89 id=89 data-nosnippet>89</a>}
|
|
<a href=#90 id=90 data-nosnippet>90</a>
|
|
<a href=#91 id=91 data-nosnippet>91</a><span class="attr">#[cfg(all(target_os = <span class="string">"hermit"</span>, feature = <span class="string">"os-ext"</span>))]
|
|
<a href=#92 id=92 data-nosnippet>92</a>#[cfg_attr(docsrs, doc(cfg(all(target_os = <span class="string">"hermit"</span>, feature = <span class="string">"os-ext"</span>))))]
|
|
<a href=#93 id=93 data-nosnippet>93</a></span><span class="kw">pub mod </span>hermit {
|
|
<a href=#94 id=94 data-nosnippet>94</a> <span class="doccomment">//! Hermit only extensions.
|
|
<a href=#95 id=95 data-nosnippet>95</a>
|
|
<a href=#96 id=96 data-nosnippet>96</a> </span><span class="kw">pub use </span><span class="kw">crate</span>::sys::SourceFd;
|
|
<a href=#97 id=97 data-nosnippet>97</a>}
|
|
<a href=#98 id=98 data-nosnippet>98</a>
|
|
<a href=#99 id=99 data-nosnippet>99</a><span class="attr">#[cfg(all(windows, feature = <span class="string">"os-ext"</span>))]
|
|
<a href=#100 id=100 data-nosnippet>100</a>#[cfg_attr(docsrs, doc(cfg(all(windows, feature = <span class="string">"os-ext"</span>))))]
|
|
<a href=#101 id=101 data-nosnippet>101</a></span><span class="kw">pub mod </span>windows {
|
|
<a href=#102 id=102 data-nosnippet>102</a> <span class="doccomment">//! Windows only extensions.
|
|
<a href=#103 id=103 data-nosnippet>103</a>
|
|
<a href=#104 id=104 data-nosnippet>104</a> </span><span class="kw">pub use </span><span class="kw">crate</span>::sys::named_pipe::NamedPipe;
|
|
<a href=#105 id=105 data-nosnippet>105</a>}
|
|
<a href=#106 id=106 data-nosnippet>106</a>
|
|
<a href=#107 id=107 data-nosnippet>107</a><span class="kw">pub mod </span>features {
|
|
<a href=#108 id=108 data-nosnippet>108</a> <span class="doccomment">//! # Mio's optional features.
|
|
<a href=#109 id=109 data-nosnippet>109</a> //!
|
|
<a href=#110 id=110 data-nosnippet>110</a> //! This document describes the available features in Mio.
|
|
<a href=#111 id=111 data-nosnippet>111</a> //!
|
|
<a href=#112 id=112 data-nosnippet>112</a> </span><span class="attr">#![cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"## `os-poll` (enabled)"</span>)]
|
|
<a href=#113 id=113 data-nosnippet>113</a> #![cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"## `os-poll` (disabled)"</span>)]
|
|
<a href=#114 id=114 data-nosnippet>114</a> </span><span class="doccomment">//!
|
|
<a href=#115 id=115 data-nosnippet>115</a> //! Mio by default provides only a shell implementation that `panic!`s the
|
|
<a href=#116 id=116 data-nosnippet>116</a> //! moment it is actually run. To run it requires OS support, this is
|
|
<a href=#117 id=117 data-nosnippet>117</a> //! enabled by activating the `os-poll` feature.
|
|
<a href=#118 id=118 data-nosnippet>118</a> //!
|
|
<a href=#119 id=119 data-nosnippet>119</a> //! This makes `Poll`, `Registry` and `Waker` functional.
|
|
<a href=#120 id=120 data-nosnippet>120</a> //!
|
|
<a href=#121 id=121 data-nosnippet>121</a> </span><span class="attr">#![cfg_attr(feature = <span class="string">"os-ext"</span>, doc = <span class="string">"## `os-ext` (enabled)"</span>)]
|
|
<a href=#122 id=122 data-nosnippet>122</a> #![cfg_attr(not(feature = <span class="string">"os-ext"</span>), doc = <span class="string">"## `os-ext` (disabled)"</span>)]
|
|
<a href=#123 id=123 data-nosnippet>123</a> </span><span class="doccomment">//!
|
|
<a href=#124 id=124 data-nosnippet>124</a> //! `os-ext` enables additional OS specific facilities. These facilities can
|
|
<a href=#125 id=125 data-nosnippet>125</a> //! be found in the `unix` and `windows` module.
|
|
<a href=#126 id=126 data-nosnippet>126</a> //!
|
|
<a href=#127 id=127 data-nosnippet>127</a> </span><span class="attr">#![cfg_attr(feature = <span class="string">"net"</span>, doc = <span class="string">"## Network types (enabled)"</span>)]
|
|
<a href=#128 id=128 data-nosnippet>128</a> #![cfg_attr(not(feature = <span class="string">"net"</span>), doc = <span class="string">"## Network types (disabled)"</span>)]
|
|
<a href=#129 id=129 data-nosnippet>129</a> </span><span class="doccomment">//!
|
|
<a href=#130 id=130 data-nosnippet>130</a> //! The `net` feature enables networking primitives in the `net` module.
|
|
<a href=#131 id=131 data-nosnippet>131</a></span>}
|
|
<a href=#132 id=132 data-nosnippet>132</a>
|
|
<a href=#133 id=133 data-nosnippet>133</a><span class="kw">pub mod </span>guide {
|
|
<a href=#134 id=134 data-nosnippet>134</a> <span class="doccomment">//! # Getting started guide.
|
|
<a href=#135 id=135 data-nosnippet>135</a> //!
|
|
<a href=#136 id=136 data-nosnippet>136</a> //! In this guide we'll do the following:
|
|
<a href=#137 id=137 data-nosnippet>137</a> //!
|
|
<a href=#138 id=138 data-nosnippet>138</a> //! 1. Create a [`Poll`] instance (and learn what it is).
|
|
<a href=#139 id=139 data-nosnippet>139</a> //! 2. Register an [event source].
|
|
<a href=#140 id=140 data-nosnippet>140</a> //! 3. Create an event loop.
|
|
<a href=#141 id=141 data-nosnippet>141</a> //!
|
|
<a href=#142 id=142 data-nosnippet>142</a> //! At the end you'll have a very small (but quick) TCP server that accepts
|
|
<a href=#143 id=143 data-nosnippet>143</a> //! connections and then drops (disconnects) them.
|
|
<a href=#144 id=144 data-nosnippet>144</a> //!
|
|
<a href=#145 id=145 data-nosnippet>145</a> //! ## 1. Creating a `Poll` instance
|
|
<a href=#146 id=146 data-nosnippet>146</a> //!
|
|
<a href=#147 id=147 data-nosnippet>147</a> //! Using Mio starts by creating a [`Poll`] instance, which monitors events
|
|
<a href=#148 id=148 data-nosnippet>148</a> //! from the OS and puts them into [`Events`]. This allows us to execute I/O
|
|
<a href=#149 id=149 data-nosnippet>149</a> //! operations based on what operations are ready.
|
|
<a href=#150 id=150 data-nosnippet>150</a> //!
|
|
<a href=#151 id=151 data-nosnippet>151</a> //! [`Poll`]: ../struct.Poll.html
|
|
<a href=#152 id=152 data-nosnippet>152</a> //! [`Events`]: ../event/struct.Events.html
|
|
<a href=#153 id=153 data-nosnippet>153</a> //!
|
|
<a href=#154 id=154 data-nosnippet>154</a> </span><span class="attr">#![cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
|
|
<a href=#155 id=155 data-nosnippet>155</a> #![cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
|
|
<a href=#156 id=156 data-nosnippet>156</a> </span><span class="doccomment">//! # use mio::{Poll, Events};
|
|
<a href=#157 id=157 data-nosnippet>157</a> //! # fn main() -> std::io::Result<()> {
|
|
<a href=#158 id=158 data-nosnippet>158</a> //! // `Poll` allows for polling of readiness events.
|
|
<a href=#159 id=159 data-nosnippet>159</a> //! let poll = Poll::new()?;
|
|
<a href=#160 id=160 data-nosnippet>160</a> //! // `Events` is collection of readiness `Event`s and can be filled by
|
|
<a href=#161 id=161 data-nosnippet>161</a> //! // calling `Poll::poll`.
|
|
<a href=#162 id=162 data-nosnippet>162</a> //! let events = Events::with_capacity(128);
|
|
<a href=#163 id=163 data-nosnippet>163</a> //! # drop((poll, events));
|
|
<a href=#164 id=164 data-nosnippet>164</a> //! # Ok(())
|
|
<a href=#165 id=165 data-nosnippet>165</a> //! # }
|
|
<a href=#166 id=166 data-nosnippet>166</a> //! ```
|
|
<a href=#167 id=167 data-nosnippet>167</a> //!
|
|
<a href=#168 id=168 data-nosnippet>168</a> //! For example if we're using a [`TcpListener`], we'll only want to
|
|
<a href=#169 id=169 data-nosnippet>169</a> //! attempt to accept an incoming connection *iff* any connections are
|
|
<a href=#170 id=170 data-nosnippet>170</a> //! queued and ready to be accepted. We don't want to waste our time if no
|
|
<a href=#171 id=171 data-nosnippet>171</a> //! connections are ready.
|
|
<a href=#172 id=172 data-nosnippet>172</a> //!
|
|
<a href=#173 id=173 data-nosnippet>173</a> //! [`TcpListener`]: ../net/struct.TcpListener.html
|
|
<a href=#174 id=174 data-nosnippet>174</a> //!
|
|
<a href=#175 id=175 data-nosnippet>175</a> //! ## 2. Registering event source
|
|
<a href=#176 id=176 data-nosnippet>176</a> //!
|
|
<a href=#177 id=177 data-nosnippet>177</a> //! After we've created a [`Poll`] instance that monitors events from the OS
|
|
<a href=#178 id=178 data-nosnippet>178</a> //! for us, we need to provide it with a source of events. This is done by
|
|
<a href=#179 id=179 data-nosnippet>179</a> //! registering an [event source]. As the name “event source” suggests it is
|
|
<a href=#180 id=180 data-nosnippet>180</a> //! a source of events which can be polled using a `Poll` instance. On Unix
|
|
<a href=#181 id=181 data-nosnippet>181</a> //! systems this is usually a file descriptor, or a socket/handle on
|
|
<a href=#182 id=182 data-nosnippet>182</a> //! Windows.
|
|
<a href=#183 id=183 data-nosnippet>183</a> //!
|
|
<a href=#184 id=184 data-nosnippet>184</a> //! In the example below we'll use a [`TcpListener`] for which we'll receive
|
|
<a href=#185 id=185 data-nosnippet>185</a> //! an event (from [`Poll`]) once a connection is ready to be accepted.
|
|
<a href=#186 id=186 data-nosnippet>186</a> //!
|
|
<a href=#187 id=187 data-nosnippet>187</a> //! [event source]: ../event/trait.Source.html
|
|
<a href=#188 id=188 data-nosnippet>188</a> //!
|
|
<a href=#189 id=189 data-nosnippet>189</a> </span><span class="attr">#![cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)]
|
|
<a href=#190 id=190 data-nosnippet>190</a> #![cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)]
|
|
<a href=#191 id=191 data-nosnippet>191</a> </span><span class="doccomment">//! # use mio::net::TcpListener;
|
|
<a href=#192 id=192 data-nosnippet>192</a> //! # use mio::{Poll, Token, Interest};
|
|
<a href=#193 id=193 data-nosnippet>193</a> //! # fn main() -> std::io::Result<()> {
|
|
<a href=#194 id=194 data-nosnippet>194</a> //! # let poll = Poll::new()?;
|
|
<a href=#195 id=195 data-nosnippet>195</a> //! # let address = "127.0.0.1:0".parse().unwrap();
|
|
<a href=#196 id=196 data-nosnippet>196</a> //! // Create a `TcpListener`, binding it to `address`.
|
|
<a href=#197 id=197 data-nosnippet>197</a> //! let mut listener = TcpListener::bind(address)?;
|
|
<a href=#198 id=198 data-nosnippet>198</a> //!
|
|
<a href=#199 id=199 data-nosnippet>199</a> //! // Next we register it with `Poll` to receive events for it. The `SERVER`
|
|
<a href=#200 id=200 data-nosnippet>200</a> //! // `Token` is used to determine that we received an event for the listener
|
|
<a href=#201 id=201 data-nosnippet>201</a> //! // later on.
|
|
<a href=#202 id=202 data-nosnippet>202</a> //! const SERVER: Token = Token(0);
|
|
<a href=#203 id=203 data-nosnippet>203</a> //! poll.registry().register(&mut listener, SERVER, Interest::READABLE)?;
|
|
<a href=#204 id=204 data-nosnippet>204</a> //! # Ok(())
|
|
<a href=#205 id=205 data-nosnippet>205</a> //! # }
|
|
<a href=#206 id=206 data-nosnippet>206</a> //! ```
|
|
<a href=#207 id=207 data-nosnippet>207</a> //!
|
|
<a href=#208 id=208 data-nosnippet>208</a> //! Multiple event sources can be [registered] (concurrently), so we can
|
|
<a href=#209 id=209 data-nosnippet>209</a> //! monitor multiple sources at a time.
|
|
<a href=#210 id=210 data-nosnippet>210</a> //!
|
|
<a href=#211 id=211 data-nosnippet>211</a> //! [registered]: ../struct.Registry.html#method.register
|
|
<a href=#212 id=212 data-nosnippet>212</a> //!
|
|
<a href=#213 id=213 data-nosnippet>213</a> //! ## 3. Creating the event loop
|
|
<a href=#214 id=214 data-nosnippet>214</a> //!
|
|
<a href=#215 id=215 data-nosnippet>215</a> //! After we've created a [`Poll`] instance and registered one or more
|
|
<a href=#216 id=216 data-nosnippet>216</a> //! [event sources] with it, we can [poll] it for events. Polling for events
|
|
<a href=#217 id=217 data-nosnippet>217</a> //! is simple, we need a container to store the events: [`Events`] and need
|
|
<a href=#218 id=218 data-nosnippet>218</a> //! to do something based on the polled events (this part is up to you, we
|
|
<a href=#219 id=219 data-nosnippet>219</a> //! can't do it all!). If we do this in a loop we've got ourselves an event
|
|
<a href=#220 id=220 data-nosnippet>220</a> //! loop.
|
|
<a href=#221 id=221 data-nosnippet>221</a> //!
|
|
<a href=#222 id=222 data-nosnippet>222</a> //! The example below shows the event loop in action, completing our small
|
|
<a href=#223 id=223 data-nosnippet>223</a> //! TCP server.
|
|
<a href=#224 id=224 data-nosnippet>224</a> //!
|
|
<a href=#225 id=225 data-nosnippet>225</a> //! [poll]: ../struct.Poll.html#method.poll
|
|
<a href=#226 id=226 data-nosnippet>226</a> //! [event sources]: ../event/trait.Source.html
|
|
<a href=#227 id=227 data-nosnippet>227</a> //!
|
|
<a href=#228 id=228 data-nosnippet>228</a> </span><span class="attr">#![cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)]
|
|
<a href=#229 id=229 data-nosnippet>229</a> #![cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)]
|
|
<a href=#230 id=230 data-nosnippet>230</a> </span><span class="doccomment">//! # use std::io;
|
|
<a href=#231 id=231 data-nosnippet>231</a> //! # use std::time::Duration;
|
|
<a href=#232 id=232 data-nosnippet>232</a> //! # use mio::net::TcpListener;
|
|
<a href=#233 id=233 data-nosnippet>233</a> //! # use mio::{Poll, Token, Interest, Events};
|
|
<a href=#234 id=234 data-nosnippet>234</a> //! # fn main() -> io::Result<()> {
|
|
<a href=#235 id=235 data-nosnippet>235</a> //! # let mut poll = Poll::new()?;
|
|
<a href=#236 id=236 data-nosnippet>236</a> //! # let mut events = Events::with_capacity(128);
|
|
<a href=#237 id=237 data-nosnippet>237</a> //! # let address = "127.0.0.1:0".parse().unwrap();
|
|
<a href=#238 id=238 data-nosnippet>238</a> //! # let mut listener = TcpListener::bind(address)?;
|
|
<a href=#239 id=239 data-nosnippet>239</a> //! # const SERVER: Token = Token(0);
|
|
<a href=#240 id=240 data-nosnippet>240</a> //! # poll.registry().register(&mut listener, SERVER, Interest::READABLE)?;
|
|
<a href=#241 id=241 data-nosnippet>241</a> //! // Start our event loop.
|
|
<a href=#242 id=242 data-nosnippet>242</a> //! loop {
|
|
<a href=#243 id=243 data-nosnippet>243</a> //! // Poll the OS for events, waiting at most 100 milliseconds.
|
|
<a href=#244 id=244 data-nosnippet>244</a> //! poll.poll(&mut events, Some(Duration::from_millis(100)))?;
|
|
<a href=#245 id=245 data-nosnippet>245</a> //!
|
|
<a href=#246 id=246 data-nosnippet>246</a> //! // Process each event.
|
|
<a href=#247 id=247 data-nosnippet>247</a> //! for event in events.iter() {
|
|
<a href=#248 id=248 data-nosnippet>248</a> //! // We can use the token we previously provided to `register` to
|
|
<a href=#249 id=249 data-nosnippet>249</a> //! // determine for which type the event is.
|
|
<a href=#250 id=250 data-nosnippet>250</a> //! match event.token() {
|
|
<a href=#251 id=251 data-nosnippet>251</a> //! SERVER => loop {
|
|
<a href=#252 id=252 data-nosnippet>252</a> //! // One or more connections are ready, so we'll attempt to
|
|
<a href=#253 id=253 data-nosnippet>253</a> //! // accept them (in a loop).
|
|
<a href=#254 id=254 data-nosnippet>254</a> //! match listener.accept() {
|
|
<a href=#255 id=255 data-nosnippet>255</a> //! Ok((connection, address)) => {
|
|
<a href=#256 id=256 data-nosnippet>256</a> //! println!("Got a connection from: {}", address);
|
|
<a href=#257 id=257 data-nosnippet>257</a> //! # drop(connection);
|
|
<a href=#258 id=258 data-nosnippet>258</a> //! },
|
|
<a href=#259 id=259 data-nosnippet>259</a> //! // A "would block error" is returned if the operation
|
|
<a href=#260 id=260 data-nosnippet>260</a> //! // is not ready, so we'll stop trying to accept
|
|
<a href=#261 id=261 data-nosnippet>261</a> //! // connections.
|
|
<a href=#262 id=262 data-nosnippet>262</a> //! Err(ref err) if would_block(err) => break,
|
|
<a href=#263 id=263 data-nosnippet>263</a> //! Err(err) => return Err(err),
|
|
<a href=#264 id=264 data-nosnippet>264</a> //! }
|
|
<a href=#265 id=265 data-nosnippet>265</a> //! }
|
|
<a href=#266 id=266 data-nosnippet>266</a> //! # _ => unreachable!(),
|
|
<a href=#267 id=267 data-nosnippet>267</a> //! }
|
|
<a href=#268 id=268 data-nosnippet>268</a> //! }
|
|
<a href=#269 id=269 data-nosnippet>269</a> //! # return Ok(());
|
|
<a href=#270 id=270 data-nosnippet>270</a> //! }
|
|
<a href=#271 id=271 data-nosnippet>271</a> //!
|
|
<a href=#272 id=272 data-nosnippet>272</a> //! fn would_block(err: &io::Error) -> bool {
|
|
<a href=#273 id=273 data-nosnippet>273</a> //! err.kind() == io::ErrorKind::WouldBlock
|
|
<a href=#274 id=274 data-nosnippet>274</a> //! }
|
|
<a href=#275 id=275 data-nosnippet>275</a> //! # }
|
|
<a href=#276 id=276 data-nosnippet>276</a> //! ```
|
|
<a href=#277 id=277 data-nosnippet>277</a></span>}
|
|
</code></pre></div></section></main></body></html> |