api-docs/crates-app/src/mio/net/tcp/listener.rs.html - incubator-teaclave-website - Git at Google

 <!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/net/tcp/listener.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>listener.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>
 <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>
 <span id="142">142</span>
 <span id="143">143</span>
 <span id="144">144</span>
 <span id="145">145</span>
 <span id="146">146</span>
 <span id="147">147</span>
 <span id="148">148</span>
 <span id="149">149</span>
 <span id="150">150</span>
 <span id="151">151</span>
 <span id="152">152</span>
 <span id="153">153</span>
 <span id="154">154</span>
 <span id="155">155</span>
 <span id="156">156</span>
 <span id="157">157</span>
 <span id="158">158</span>
 <span id="159">159</span>
 <span id="160">160</span>
 <span id="161">161</span>
 <span id="162">162</span>
 <span id="163">163</span>
 <span id="164">164</span>
 <span id="165">165</span>
 <span id="166">166</span>
 <span id="167">167</span>
 <span id="168">168</span>
 <span id="169">169</span>
 <span id="170">170</span>
 <span id="171">171</span>
 <span id="172">172</span>
 <span id="173">173</span>
 <span id="174">174</span>
 <span id="175">175</span>
 <span id="176">176</span>
 <span id="177">177</span>
 <span id="178">178</span>
 <span id="179">179</span>
 <span id="180">180</span>
 <span id="181">181</span>
 <span id="182">182</span>
 <span id="183">183</span>
 <span id="184">184</span>
 <span id="185">185</span>
 <span id="186">186</span>
 <span id="187">187</span>
 <span id="188">188</span>
 <span id="189">189</span>
 <span id="190">190</span>
 <span id="191">191</span>
 <span id="192">192</span>
 <span id="193">193</span>
 <span id="194">194</span>
 <span id="195">195</span>
 <span id="196">196</span>
 <span id="197">197</span>
 <span id="198">198</span>
 <span id="199">199</span>
 <span id="200">200</span>
 <span id="201">201</span>
 <span id="202">202</span>
 <span id="203">203</span>
 <span id="204">204</span>
 <span id="205">205</span>
 <span id="206">206</span>
 <span id="207">207</span>
 <span id="208">208</span>
 <span id="209">209</span>
 <span id="210">210</span>
 <span id="211">211</span>
 <span id="212">212</span>
 <span id="213">213</span>
 <span id="214">214</span>
 <span id="215">215</span>
 <span id="216">216</span>
 <span id="217">217</span>
 <span id="218">218</span>
 <span id="219">219</span>
 <span id="220">220</span>
 <span id="221">221</span>
 <span id="222">222</span>
 <span id="223">223</span>
 <span id="224">224</span>
 <span id="225">225</span>
 <span id="226">226</span>
 <span id="227">227</span>
 <span id="228">228</span>
 <span id="229">229</span>
 <span id="230">230</span>
 <span id="231">231</span>
 <span id="232">232</span>
 <span id="233">233</span>
 <span id="234">234</span>
 <span id="235">235</span>
 <span id="236">236</span>
 <span id="237">237</span>
 <span id="238">238</span>
 <span id="239">239</span>
 <span id="240">240</span>
 <span id="241">241</span>
 <span id="242">242</span>
 <span id="243">243</span>
 <span id="244">244</span>
 <span id="245">245</span>
 <span id="246">246</span>
 <span id="247">247</span>
 <span id="248">248</span>
 </pre><pre class="rust"><code><span class="kw">use </span>std::net::{<span class="self">self</span>, SocketAddr};
 <span class="attribute">#[cfg(unix)]
 </span><span class="kw">use </span>std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
 <span class="attribute">#[cfg(target_os = <span class="string">&quot;wasi&quot;</span>)]
 </span><span class="kw">use </span>std::os::wasi::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
 <span class="attribute">#[cfg(windows)]
 </span><span class="kw">use </span>std::os::windows::io::{AsRawSocket, FromRawSocket, IntoRawSocket, RawSocket};
 <span class="kw">use </span>std::{fmt, io};

 <span class="kw">use </span><span class="kw">crate</span>::io_source::IoSource;
 <span class="kw">use </span><span class="kw">crate</span>::net::TcpStream;
 <span class="attribute">#[cfg(unix)]
 </span><span class="kw">use </span><span class="kw">crate</span>::sys::tcp::set_reuseaddr;
 <span class="attribute">#[cfg(not(target_os = <span class="string">&quot;wasi&quot;</span>))]
 </span><span class="kw">use </span><span class="kw">crate</span>::sys::tcp::{bind, listen, new_for_addr};
 <span class="kw">use crate</span>::{event, sys, Interest, Registry, Token};

 <span class="doccomment">/// A structure representing a socket server
 ///
 /// # Examples
 ///
 </span><span class="attribute">#[cfg_attr(feature = <span class="string">&quot;os-poll&quot;</span>, doc = <span class="string">&quot;```&quot;</span>)]
 #[cfg_attr(not(feature = <span class="string">&quot;os-poll&quot;</span>), doc = <span class="string">&quot;```ignore&quot;</span>)]
 </span><span class="doccomment">/// # use std::error::Error;
 /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
 /// use mio::{Events, Interest, Poll, Token};
 /// use mio::net::TcpListener;
 /// use std::time::Duration;
 ///
 /// let mut listener = TcpListener::bind(&quot;127.0.0.1:34255&quot;.parse()?)?;
 ///
 /// let mut poll = Poll::new()?;
 /// let mut events = Events::with_capacity(128);
 ///
 /// // Register the socket with `Poll`
 /// poll.registry().register(&amp;mut listener, Token(0), Interest::READABLE)?;
 ///
 /// poll.poll(&amp;mut events, Some(Duration::from_millis(100)))?;
 ///
 /// // There may be a socket ready to be accepted
 /// #     Ok(())
 /// # }
 /// ```
 </span><span class="kw">pub struct </span>TcpListener {
     inner: IoSource&lt;net::TcpListener&gt;,
 }

 <span class="kw">impl </span>TcpListener {
     <span class="doccomment">/// Convenience method to bind a new TCP listener to the specified address
     /// to receive new connections.
     ///
     /// This function will take the following steps:
     ///
     /// 1. Create a new TCP socket.
     /// 2. Set the `SO_REUSEADDR` option on the socket on Unix.
     /// 3. Bind the socket to the specified address.
     /// 4. Calls `listen` on the socket to prepare it to receive new connections.
     </span><span class="attribute">#[cfg(not(target_os = <span class="string">&quot;wasi&quot;</span>))]
     </span><span class="kw">pub fn </span>bind(addr: SocketAddr) -&gt; io::Result&lt;TcpListener&gt; {
         <span class="kw">let </span>socket = new_for_addr(addr)<span class="question-mark">?</span>;
         <span class="attribute">#[cfg(unix)]
         </span><span class="kw">let </span>listener = <span class="kw">unsafe </span>{ TcpListener::from_raw_fd(socket) };
         <span class="attribute">#[cfg(windows)]
         </span><span class="kw">let </span>listener = <span class="kw">unsafe </span>{ TcpListener::from_raw_socket(socket <span class="kw">as _</span>) };

         <span class="comment">// On platforms with Berkeley-derived sockets, this allows to quickly
         // rebind a socket, without needing to wait for the OS to clean up the
         // previous one.
         //
         // On Windows, this allows rebinding sockets which are actively in use,
         // which allows “socket hijacking”, so we explicitly don&#39;t set it here.
         // https://docs.microsoft.com/en-us/windows/win32/winsock/using-so-reuseaddr-and-so-exclusiveaddruse
         </span><span class="attribute">#[cfg(not(windows))]
         </span>set_reuseaddr(<span class="kw-2">&amp;</span>listener.inner, <span class="bool-val">true</span>)<span class="question-mark">?</span>;

         bind(<span class="kw-2">&amp;</span>listener.inner, addr)<span class="question-mark">?</span>;
         listen(<span class="kw-2">&amp;</span>listener.inner, <span class="number">1024</span>)<span class="question-mark">?</span>;
         <span class="prelude-val">Ok</span>(listener)
     }

     <span class="doccomment">/// Creates a new `TcpListener` from a standard `net::TcpListener`.
     ///
     /// This function is intended to be used to wrap a TCP listener from the
     /// standard library in the Mio equivalent. The conversion assumes nothing
     /// about the underlying listener; ; it is left up to the user to set it
     /// in non-blocking mode.
     </span><span class="kw">pub fn </span>from_std(listener: net::TcpListener) -&gt; TcpListener {
         TcpListener {
             inner: IoSource::new(listener),
         }
     }

     <span class="doccomment">/// Accepts a new `TcpStream`.
     ///
     /// This may return an `Err(e)` where `e.kind()` is
     /// `io::ErrorKind::WouldBlock`. This means a stream may be ready at a later
     /// point and one should wait for an event before calling `accept` again.
     ///
     /// If an accepted stream is returned, the remote address of the peer is
     /// returned along with it.
     </span><span class="kw">pub fn </span>accept(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;(TcpStream, SocketAddr)&gt; {
         <span class="self">self</span>.inner.do_io(|inner| {
             sys::tcp::accept(inner).map(|(stream, addr)| (TcpStream::from_std(stream), addr))
         })
     }

     <span class="doccomment">/// Returns the local socket address of this listener.
     </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;SocketAddr&gt; {
         <span class="self">self</span>.inner.local_addr()
     }

     <span class="doccomment">/// Sets the value for the `IP_TTL` option on this socket.
     ///
     /// This value sets the time-to-live field that is used in every packet sent
     /// from this socket.
     </span><span class="kw">pub fn </span>set_ttl(<span class="kw-2">&amp;</span><span class="self">self</span>, ttl: u32) -&gt; io::Result&lt;()&gt; {
         <span class="self">self</span>.inner.set_ttl(ttl)
     }

     <span class="doccomment">/// Gets the value of the `IP_TTL` option for this socket.
     ///
     /// For more information about this option, see [`set_ttl`][link].
     ///
     /// [link]: #method.set_ttl
     </span><span class="kw">pub fn </span>ttl(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;u32&gt; {
         <span class="self">self</span>.inner.ttl()
     }

     <span class="doccomment">/// Get the value of the `SO_ERROR` option on this socket.
     ///
     /// This will retrieve the stored error in the underlying socket, clearing
     /// the field in the process. This can be useful for checking errors between
     /// calls.
     </span><span class="kw">pub fn </span>take_error(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;<span class="prelude-ty">Option</span>&lt;io::Error&gt;&gt; {
         <span class="self">self</span>.inner.take_error()
     }
 }

 <span class="kw">impl </span>event::Source <span class="kw">for </span>TcpListener {
     <span class="kw">fn </span>register(
         <span class="kw-2">&amp;mut </span><span class="self">self</span>,
         registry: <span class="kw-2">&amp;</span>Registry,
         token: Token,
         interests: Interest,
     ) -&gt; io::Result&lt;()&gt; {
         <span class="self">self</span>.inner.register(registry, token, interests)
     }

     <span class="kw">fn </span>reregister(
         <span class="kw-2">&amp;mut </span><span class="self">self</span>,
         registry: <span class="kw-2">&amp;</span>Registry,
         token: Token,
         interests: Interest,
     ) -&gt; io::Result&lt;()&gt; {
         <span class="self">self</span>.inner.reregister(registry, token, interests)
     }

     <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
         <span class="self">self</span>.inner.deregister(registry)
     }
 }

 <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>TcpListener {
     <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
         <span class="self">self</span>.inner.fmt(f)
     }
 }

 <span class="attribute">#[cfg(unix)]
 </span><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>TcpListener {
     <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -&gt; RawFd {
         <span class="self">self</span>.inner.into_inner().into_raw_fd()
     }
 }

 <span class="attribute">#[cfg(unix)]
 </span><span class="kw">impl </span>AsRawFd <span class="kw">for </span>TcpListener {
     <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
         <span class="self">self</span>.inner.as_raw_fd()
     }
 }

 <span class="attribute">#[cfg(unix)]
 </span><span class="kw">impl </span>FromRawFd <span class="kw">for </span>TcpListener {
     <span class="doccomment">/// Converts a `RawFd` to a `TcpListener`.
     ///
     /// # Notes
     ///
     /// The caller is responsible for ensuring that the socket is in
     /// non-blocking mode.
     </span><span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -&gt; TcpListener {
         TcpListener::from_std(FromRawFd::from_raw_fd(fd))
     }
 }

 <span class="attribute">#[cfg(windows)]
 </span><span class="kw">impl </span>IntoRawSocket <span class="kw">for </span>TcpListener {
     <span class="kw">fn </span>into_raw_socket(<span class="self">self</span>) -&gt; RawSocket {
         <span class="self">self</span>.inner.into_inner().into_raw_socket()
     }
 }

 <span class="attribute">#[cfg(windows)]
 </span><span class="kw">impl </span>AsRawSocket <span class="kw">for </span>TcpListener {
     <span class="kw">fn </span>as_raw_socket(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawSocket {
         <span class="self">self</span>.inner.as_raw_socket()
     }
 }

 <span class="attribute">#[cfg(windows)]
 </span><span class="kw">impl </span>FromRawSocket <span class="kw">for </span>TcpListener {
     <span class="doccomment">/// Converts a `RawSocket` to a `TcpListener`.
     ///
     /// # Notes
     ///
     /// The caller is responsible for ensuring that the socket is in
     /// non-blocking mode.
     </span><span class="kw">unsafe fn </span>from_raw_socket(socket: RawSocket) -&gt; TcpListener {
         TcpListener::from_std(FromRawSocket::from_raw_socket(socket))
     }
 }

 <span class="attribute">#[cfg(target_os = <span class="string">&quot;wasi&quot;</span>)]
 </span><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>TcpListener {
     <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -&gt; RawFd {
         <span class="self">self</span>.inner.into_inner().into_raw_fd()
     }
 }

 <span class="attribute">#[cfg(target_os = <span class="string">&quot;wasi&quot;</span>)]
 </span><span class="kw">impl </span>AsRawFd <span class="kw">for </span>TcpListener {
     <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
         <span class="self">self</span>.inner.as_raw_fd()
     }
 }

 <span class="attribute">#[cfg(target_os = <span class="string">&quot;wasi&quot;</span>)]
 </span><span class="kw">impl </span>FromRawFd <span class="kw">for </span>TcpListener {
     <span class="doccomment">/// Converts a `RawFd` to a `TcpListener`.
     ///
     /// # Notes
     ///
     /// The caller is responsible for ensuring that the socket is in
     /// non-blocking mode.
     </span><span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -&gt; TcpListener {
         TcpListener::from_std(FromRawFd::from_raw_fd(fd))
     }
 }
 </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>