| <!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/tokio-1.28.2/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="../../../../tokio/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="../../../../tokio/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> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::io::{Interest, PollEvented}; |
| <span class="kw">use </span><span class="kw">crate</span>::net::tcp::TcpStream; |
| |
| <span class="macro">cfg_not_wasi! </span>{ |
| <span class="kw">use </span><span class="kw">crate</span>::net::{to_socket_addrs, ToSocketAddrs}; |
| } |
| |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::net::{<span class="self">self</span>, SocketAddr}; |
| <span class="kw">use </span>std::task::{Context, Poll}; |
| |
| <span class="macro">cfg_net! </span>{ |
| <span class="doccomment">/// A TCP socket server, listening for connections. |
| /// |
| /// You can accept a new connection by using the [`accept`](`TcpListener::accept`) |
| /// method. |
| /// |
| /// A `TcpListener` can be turned into a `Stream` with [`TcpListenerStream`]. |
| /// |
| /// [`TcpListenerStream`]: https://docs.rs/tokio-stream/0.1/tokio_stream/wrappers/struct.TcpListenerStream.html |
| /// |
| /// # Errors |
| /// |
| /// Note that accepting a connection can lead to various errors and not all |
| /// of them are necessarily fatal ‒ for example having too many open file |
| /// descriptors or the other side closing the connection while it waits in |
| /// an accept queue. These would terminate the stream if not handled in any |
| /// way. |
| /// |
| /// # Examples |
| /// |
| /// Using `accept`: |
| /// ```no_run |
| /// use tokio::net::TcpListener; |
| /// |
| /// use std::io; |
| /// |
| /// async fn process_socket<T>(socket: T) { |
| /// # drop(socket); |
| /// // do work with socket here |
| /// } |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let listener = TcpListener::bind("127.0.0.1:8080").await?; |
| /// |
| /// loop { |
| /// let (socket, _) = listener.accept().await?; |
| /// process_socket(socket).await; |
| /// } |
| /// } |
| /// ``` |
| </span><span class="kw">pub struct </span>TcpListener { |
| io: PollEvented<mio::net::TcpListener>, |
| } |
| } |
| |
| <span class="kw">impl </span>TcpListener { |
| <span class="macro">cfg_not_wasi! </span>{ |
| <span class="doccomment">/// Creates a new TcpListener, which will be bound to the specified address. |
| /// |
| /// The returned listener is ready for accepting connections. |
| /// |
| /// Binding with a port number of 0 will request that the OS assigns a port |
| /// to this listener. The port allocated can be queried via the `local_addr` |
| /// method. |
| /// |
| /// The address type can be any implementor of the [`ToSocketAddrs`] trait. |
| /// If `addr` yields multiple addresses, bind will be attempted with each of |
| /// the addresses until one succeeds and returns the listener. If none of |
| /// the addresses succeed in creating a listener, the error returned from |
| /// the last attempt (the last address) is returned. |
| /// |
| /// This function sets the `SO_REUSEADDR` option on the socket. |
| /// |
| /// To configure the socket before binding, you can use the [`TcpSocket`] |
| /// type. |
| /// |
| /// [`ToSocketAddrs`]: trait@crate::net::ToSocketAddrs |
| /// [`TcpSocket`]: struct@crate::net::TcpSocket |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::net::TcpListener; |
| /// |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let listener = TcpListener::bind("127.0.0.1:2345").await?; |
| /// |
| /// // use the listener |
| /// |
| /// # let _ = listener; |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub async fn </span>bind<A: ToSocketAddrs>(addr: A) -> io::Result<TcpListener> { |
| <span class="kw">let </span>addrs = to_socket_addrs(addr).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>last_err = <span class="prelude-val">None</span>; |
| |
| <span class="kw">for </span>addr <span class="kw">in </span>addrs { |
| <span class="kw">match </span>TcpListener::bind_addr(addr) { |
| <span class="prelude-val">Ok</span>(listener) => <span class="kw">return </span><span class="prelude-val">Ok</span>(listener), |
| <span class="prelude-val">Err</span>(e) => last_err = <span class="prelude-val">Some</span>(e), |
| } |
| } |
| |
| <span class="prelude-val">Err</span>(last_err.unwrap_or_else(|| { |
| io::Error::new( |
| io::ErrorKind::InvalidInput, |
| <span class="string">"could not resolve to any address"</span>, |
| ) |
| })) |
| } |
| |
| <span class="kw">fn </span>bind_addr(addr: SocketAddr) -> io::Result<TcpListener> { |
| <span class="kw">let </span>listener = mio::net::TcpListener::bind(addr)<span class="question-mark">?</span>; |
| TcpListener::new(listener) |
| } |
| } |
| |
| <span class="doccomment">/// Accepts a new incoming connection from this listener. |
| /// |
| /// This function will yield once a new TCP connection is established. When |
| /// established, the corresponding [`TcpStream`] and the remote peer's |
| /// address will be returned. |
| /// |
| /// # Cancel safety |
| /// |
| /// This method is cancel safe. If the method is used as the event in a |
| /// [`tokio::select!`](crate::select) statement and some other branch |
| /// completes first, then it is guaranteed that no new connections were |
| /// accepted by this method. |
| /// |
| /// [`TcpStream`]: struct@crate::net::TcpStream |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::net::TcpListener; |
| /// |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let listener = TcpListener::bind("127.0.0.1:8080").await?; |
| /// |
| /// match listener.accept().await { |
| /// Ok((_socket, addr)) => println!("new client: {:?}", addr), |
| /// Err(e) => println!("couldn't get client: {:?}", e), |
| /// } |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub async fn </span>accept(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<(TcpStream, SocketAddr)> { |
| <span class="kw">let </span>(mio, addr) = <span class="self">self |
| </span>.io |
| .registration() |
| .async_io(Interest::READABLE, || <span class="self">self</span>.io.accept()) |
| .<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>stream = TcpStream::new(mio)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>((stream, addr)) |
| } |
| |
| <span class="doccomment">/// Polls to accept a new incoming connection to this listener. |
| /// |
| /// If there is no connection to accept, `Poll::Pending` is returned and the |
| /// current task will be notified by a waker. Note that on multiple calls |
| /// to `poll_accept`, only the `Waker` from the `Context` passed to the most |
| /// recent call is scheduled to receive a wakeup. |
| </span><span class="kw">pub fn </span>poll_accept(<span class="kw-2">&</span><span class="self">self</span>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<(TcpStream, SocketAddr)>> { |
| <span class="kw">loop </span>{ |
| <span class="kw">let </span>ev = <span class="macro">ready!</span>(<span class="self">self</span>.io.registration().poll_read_ready(cx))<span class="question-mark">?</span>; |
| |
| <span class="kw">match </span><span class="self">self</span>.io.accept() { |
| <span class="prelude-val">Ok</span>((io, addr)) => { |
| <span class="kw">let </span>io = TcpStream::new(io)<span class="question-mark">?</span>; |
| <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Ok</span>((io, addr))); |
| } |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock => { |
| <span class="self">self</span>.io.registration().clear_readiness(ev); |
| } |
| <span class="prelude-val">Err</span>(e) => <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Err</span>(e)), |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Creates new `TcpListener` from a `std::net::TcpListener`. |
| /// |
| /// This function is intended to be used to wrap a TCP listener from the |
| /// standard library in the Tokio equivalent. |
| /// |
| /// This API is typically paired with the `socket2` crate and the `Socket` |
| /// type to build up and customize a listener before it's shipped off to the |
| /// backing event loop. This allows configuration of options like |
| /// `SO_REUSEPORT`, binding to multiple addresses, etc. |
| /// |
| /// # Notes |
| /// |
| /// The caller is responsible for ensuring that the listener is in |
| /// non-blocking mode. Otherwise all I/O operations on the listener |
| /// will block the thread, which will cause unexpected behavior. |
| /// Non-blocking mode can be set using [`set_nonblocking`]. |
| /// |
| /// [`set_nonblocking`]: std::net::TcpListener::set_nonblocking |
| /// |
| /// # Examples |
| /// |
| /// ```rust,no_run |
| /// use std::error::Error; |
| /// use tokio::net::TcpListener; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> Result<(), Box<dyn Error>> { |
| /// let std_listener = std::net::TcpListener::bind("127.0.0.1:0")?; |
| /// std_listener.set_nonblocking(true)?; |
| /// let listener = TcpListener::from_std(std_listener)?; |
| /// Ok(()) |
| /// } |
| /// ``` |
| /// |
| /// # Panics |
| /// |
| /// This function panics if it is not called from within a runtime with |
| /// IO enabled. |
| /// |
| /// The runtime is usually set implicitly when this function is called |
| /// from a future driven by a tokio runtime, otherwise runtime can be set |
| /// explicitly with [`Runtime::enter`](crate::runtime::Runtime::enter) function. |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>from_std(listener: net::TcpListener) -> io::Result<TcpListener> { |
| <span class="kw">let </span>io = mio::net::TcpListener::from_std(listener); |
| <span class="kw">let </span>io = PollEvented::new(io)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(TcpListener { io }) |
| } |
| |
| <span class="doccomment">/// Turns a [`tokio::net::TcpListener`] into a [`std::net::TcpListener`]. |
| /// |
| /// The returned [`std::net::TcpListener`] will have nonblocking mode set as |
| /// `true`. Use [`set_nonblocking`] to change the blocking mode if needed. |
| /// |
| /// # Examples |
| /// |
| /// ```rust,no_run |
| /// use std::error::Error; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> Result<(), Box<dyn Error>> { |
| /// let tokio_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; |
| /// let std_listener = tokio_listener.into_std()?; |
| /// std_listener.set_nonblocking(false)?; |
| /// Ok(()) |
| /// } |
| /// ``` |
| /// |
| /// [`tokio::net::TcpListener`]: TcpListener |
| /// [`std::net::TcpListener`]: std::net::TcpListener |
| /// [`set_nonblocking`]: fn@std::net::TcpListener::set_nonblocking |
| </span><span class="kw">pub fn </span>into_std(<span class="self">self</span>) -> io::Result<std::net::TcpListener> { |
| <span class="attribute">#[cfg(unix)] |
| </span>{ |
| <span class="kw">use </span>std::os::unix::io::{FromRawFd, IntoRawFd}; |
| <span class="self">self</span>.io |
| .into_inner() |
| .map(|io| io.into_raw_fd()) |
| .map(|raw_fd| <span class="kw">unsafe </span>{ std::net::TcpListener::from_raw_fd(raw_fd) }) |
| } |
| |
| <span class="attribute">#[cfg(windows)] |
| </span>{ |
| <span class="kw">use </span>std::os::windows::io::{FromRawSocket, IntoRawSocket}; |
| <span class="self">self</span>.io |
| .into_inner() |
| .map(|io| io.into_raw_socket()) |
| .map(|raw_socket| <span class="kw">unsafe </span>{ std::net::TcpListener::from_raw_socket(raw_socket) }) |
| } |
| |
| <span class="attribute">#[cfg(tokio_wasi)] |
| </span>{ |
| <span class="kw">use </span>std::os::wasi::io::{FromRawFd, IntoRawFd}; |
| <span class="self">self</span>.io |
| .into_inner() |
| .map(|io| io.into_raw_fd()) |
| .map(|raw_fd| <span class="kw">unsafe </span>{ std::net::TcpListener::from_raw_fd(raw_fd) }) |
| } |
| } |
| |
| <span class="macro">cfg_not_wasi! </span>{ |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(listener: mio::net::TcpListener) -> io::Result<TcpListener> { |
| <span class="kw">let </span>io = PollEvented::new(listener)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(TcpListener { io }) |
| } |
| } |
| |
| <span class="doccomment">/// Returns the local address that this listener is bound to. |
| /// |
| /// This can be useful, for example, when binding to port 0 to figure out |
| /// which port was actually bound. |
| /// |
| /// # Examples |
| /// |
| /// ```rust,no_run |
| /// use tokio::net::TcpListener; |
| /// |
| /// use std::io; |
| /// use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4}; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let listener = TcpListener::bind("127.0.0.1:8080").await?; |
| /// |
| /// assert_eq!(listener.local_addr()?, |
| /// SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080))); |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<SocketAddr> { |
| <span class="self">self</span>.io.local_addr() |
| } |
| |
| <span class="doccomment">/// Gets the value of the `IP_TTL` option for this socket. |
| /// |
| /// For more information about this option, see [`set_ttl`]. |
| /// |
| /// [`set_ttl`]: method@Self::set_ttl |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::net::TcpListener; |
| /// |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let listener = TcpListener::bind("127.0.0.1:0").await?; |
| /// |
| /// listener.set_ttl(100).expect("could not set TTL"); |
| /// assert_eq!(listener.ttl()?, 100); |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>ttl(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<u32> { |
| <span class="self">self</span>.io.ttl() |
| } |
| |
| <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. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::net::TcpListener; |
| /// |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let listener = TcpListener::bind("127.0.0.1:0").await?; |
| /// |
| /// listener.set_ttl(100).expect("could not set TTL"); |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>set_ttl(<span class="kw-2">&</span><span class="self">self</span>, ttl: u32) -> io::Result<()> { |
| <span class="self">self</span>.io.set_ttl(ttl) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<net::TcpListener> <span class="kw">for </span>TcpListener { |
| <span class="kw">type </span>Error = io::Error; |
| |
| <span class="doccomment">/// Consumes stream, returning the tokio I/O object. |
| /// |
| /// This is equivalent to |
| /// [`TcpListener::from_std(stream)`](TcpListener::from_std). |
| </span><span class="kw">fn </span>try_from(stream: net::TcpListener) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Error> { |
| <span class="self">Self</span>::from_std(stream) |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>TcpListener { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="self">self</span>.io.fmt(f) |
| } |
| } |
| |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">mod </span>sys { |
| <span class="kw">use </span><span class="kw">super</span>::TcpListener; |
| <span class="kw">use </span>std::os::unix::prelude::<span class="kw-2">*</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">&</span><span class="self">self</span>) -> RawFd { |
| <span class="self">self</span>.io.as_raw_fd() |
| } |
| } |
| |
| <span class="attribute">#[cfg(not(tokio_no_as_fd))] |
| </span><span class="kw">impl </span>AsFd <span class="kw">for </span>TcpListener { |
| <span class="kw">fn </span>as_fd(<span class="kw-2">&</span><span class="self">self</span>) -> BorrowedFd<<span class="lifetime">'_</span>> { |
| <span class="kw">unsafe </span>{ BorrowedFd::borrow_raw(<span class="self">self</span>.as_raw_fd()) } |
| } |
| } |
| } |
| |
| <span class="macro">cfg_unstable! </span>{ |
| <span class="attribute">#[cfg(tokio_wasi)] |
| </span><span class="kw">mod </span>sys { |
| <span class="kw">use </span><span class="kw">super</span>::TcpListener; |
| <span class="kw">use </span>std::os::wasi::prelude::<span class="kw-2">*</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">&</span><span class="self">self</span>) -> RawFd { |
| <span class="self">self</span>.io.as_raw_fd() |
| } |
| } |
| |
| <span class="attribute">#[cfg(not(tokio_no_as_fd))] |
| </span><span class="kw">impl </span>AsFd <span class="kw">for </span>TcpListener { |
| <span class="kw">fn </span>as_fd(<span class="kw-2">&</span><span class="self">self</span>) -> BorrowedFd<<span class="lifetime">'_</span>> { |
| <span class="kw">unsafe </span>{ BorrowedFd::borrow_raw(<span class="self">self</span>.as_raw_fd()) } |
| } |
| } |
| } |
| } |
| |
| <span class="macro">cfg_windows! </span>{ |
| <span class="kw">use </span><span class="kw">crate</span>::os::windows::io::{AsRawSocket, RawSocket}; |
| <span class="attribute">#[cfg(not(tokio_no_as_fd))] |
| </span><span class="kw">use </span><span class="kw">crate</span>::os::windows::io::{AsSocket, BorrowedSocket}; |
| |
| <span class="kw">impl </span>AsRawSocket <span class="kw">for </span>TcpListener { |
| <span class="kw">fn </span>as_raw_socket(<span class="kw-2">&</span><span class="self">self</span>) -> RawSocket { |
| <span class="self">self</span>.io.as_raw_socket() |
| } |
| } |
| |
| <span class="attribute">#[cfg(not(tokio_no_as_fd))] |
| </span><span class="kw">impl </span>AsSocket <span class="kw">for </span>TcpListener { |
| <span class="kw">fn </span>as_socket(<span class="kw-2">&</span><span class="self">self</span>) -> BorrowedSocket<<span class="lifetime">'_</span>> { |
| <span class="kw">unsafe </span>{ BorrowedSocket::borrow_raw(<span class="self">self</span>.as_raw_socket()) } |
| } |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
