| <!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/hyper-0.14.26/src/server/tcp.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>tcp.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="../../../hyper/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="../../../hyper/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> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::net::{SocketAddr, TcpListener <span class="kw">as </span>StdTcpListener}; |
| <span class="kw">use </span>std::time::Duration; |
| <span class="kw">use </span>socket2::TcpKeepalive; |
| |
| <span class="kw">use </span>tokio::net::TcpListener; |
| <span class="kw">use </span>tokio::time::Sleep; |
| <span class="kw">use </span>tracing::{debug, error, trace}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::common::{task, Future, Pin, Poll}; |
| |
| <span class="attribute">#[allow(unreachable_pub)] </span><span class="comment">// https://github.com/rust-lang/rust/issues/57411 |
| </span><span class="kw">pub use </span><span class="self">self</span>::addr_stream::AddrStream; |
| <span class="kw">use </span><span class="kw">super</span>::accept::Accept; |
| |
| <span class="attribute">#[derive(Default, Debug, Clone, Copy)] |
| </span><span class="kw">struct </span>TcpKeepaliveConfig { |
| time: <span class="prelude-ty">Option</span><Duration>, |
| interval: <span class="prelude-ty">Option</span><Duration>, |
| retries: <span class="prelude-ty">Option</span><u32>, |
| } |
| |
| <span class="kw">impl </span>TcpKeepaliveConfig { |
| <span class="doccomment">/// Converts into a `socket2::TcpKeealive` if there is any keep alive configuration. |
| </span><span class="kw">fn </span>into_socket2(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><TcpKeepalive> { |
| <span class="kw">let </span><span class="kw-2">mut </span>dirty = <span class="bool-val">false</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>ka = TcpKeepalive::new(); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(time) = <span class="self">self</span>.time { |
| ka = ka.with_time(time); |
| dirty = <span class="bool-val">true |
| </span>} |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(interval) = <span class="self">self</span>.interval { |
| ka = <span class="self">Self</span>::ka_with_interval(ka, interval, <span class="kw-2">&mut </span>dirty) |
| }; |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(retries) = <span class="self">self</span>.retries { |
| ka = <span class="self">Self</span>::ka_with_retries(ka, retries, <span class="kw-2">&mut </span>dirty) |
| }; |
| <span class="kw">if </span>dirty { |
| <span class="prelude-val">Some</span>(ka) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>} |
| } |
| |
| <span class="attribute">#[cfg(any( |
| target_os = <span class="string">"android"</span>, |
| target_os = <span class="string">"dragonfly"</span>, |
| target_os = <span class="string">"freebsd"</span>, |
| target_os = <span class="string">"fuchsia"</span>, |
| target_os = <span class="string">"illumos"</span>, |
| target_os = <span class="string">"linux"</span>, |
| target_os = <span class="string">"netbsd"</span>, |
| target_vendor = <span class="string">"apple"</span>, |
| windows, |
| ))] |
| </span><span class="kw">fn </span>ka_with_interval(ka: TcpKeepalive, interval: Duration, dirty: <span class="kw-2">&mut </span>bool) -> TcpKeepalive { |
| <span class="kw-2">*</span>dirty = <span class="bool-val">true</span>; |
| ka.with_interval(interval) |
| } |
| |
| <span class="attribute">#[cfg(not(any( |
| target_os = <span class="string">"android"</span>, |
| target_os = <span class="string">"dragonfly"</span>, |
| target_os = <span class="string">"freebsd"</span>, |
| target_os = <span class="string">"fuchsia"</span>, |
| target_os = <span class="string">"illumos"</span>, |
| target_os = <span class="string">"linux"</span>, |
| target_os = <span class="string">"netbsd"</span>, |
| target_vendor = <span class="string">"apple"</span>, |
| windows, |
| )))] |
| </span><span class="kw">fn </span>ka_with_interval(ka: TcpKeepalive, <span class="kw">_</span>: Duration, <span class="kw">_</span>: <span class="kw-2">&mut </span>bool) -> TcpKeepalive { |
| ka <span class="comment">// no-op as keepalive interval is not supported on this platform |
| </span>} |
| |
| <span class="attribute">#[cfg(any( |
| target_os = <span class="string">"android"</span>, |
| target_os = <span class="string">"dragonfly"</span>, |
| target_os = <span class="string">"freebsd"</span>, |
| target_os = <span class="string">"fuchsia"</span>, |
| target_os = <span class="string">"illumos"</span>, |
| target_os = <span class="string">"linux"</span>, |
| target_os = <span class="string">"netbsd"</span>, |
| target_vendor = <span class="string">"apple"</span>, |
| ))] |
| </span><span class="kw">fn </span>ka_with_retries(ka: TcpKeepalive, retries: u32, dirty: <span class="kw-2">&mut </span>bool) -> TcpKeepalive { |
| <span class="kw-2">*</span>dirty = <span class="bool-val">true</span>; |
| ka.with_retries(retries) |
| } |
| |
| <span class="attribute">#[cfg(not(any( |
| target_os = <span class="string">"android"</span>, |
| target_os = <span class="string">"dragonfly"</span>, |
| target_os = <span class="string">"freebsd"</span>, |
| target_os = <span class="string">"fuchsia"</span>, |
| target_os = <span class="string">"illumos"</span>, |
| target_os = <span class="string">"linux"</span>, |
| target_os = <span class="string">"netbsd"</span>, |
| target_vendor = <span class="string">"apple"</span>, |
| )))] |
| </span><span class="kw">fn </span>ka_with_retries(ka: TcpKeepalive, <span class="kw">_</span>: u32, <span class="kw">_</span>: <span class="kw-2">&mut </span>bool) -> TcpKeepalive { |
| ka <span class="comment">// no-op as keepalive retries is not supported on this platform |
| </span>} |
| } |
| |
| <span class="doccomment">/// A stream of connections from binding to an address. |
| </span><span class="attribute">#[must_use = <span class="string">"streams do nothing unless polled"</span>] |
| </span><span class="kw">pub struct </span>AddrIncoming { |
| addr: SocketAddr, |
| listener: TcpListener, |
| sleep_on_errors: bool, |
| tcp_keepalive_config: TcpKeepaliveConfig, |
| tcp_nodelay: bool, |
| timeout: <span class="prelude-ty">Option</span><Pin<Box<Sleep>>>, |
| } |
| |
| <span class="kw">impl </span>AddrIncoming { |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(addr: <span class="kw-2">&</span>SocketAddr) -> <span class="kw">crate</span>::Result<<span class="self">Self</span>> { |
| <span class="kw">let </span>std_listener = StdTcpListener::bind(addr).map_err(<span class="kw">crate</span>::Error::new_listen)<span class="question-mark">?</span>; |
| |
| AddrIncoming::from_std(std_listener) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>from_std(std_listener: StdTcpListener) -> <span class="kw">crate</span>::Result<<span class="self">Self</span>> { |
| <span class="comment">// TcpListener::from_std doesn't set O_NONBLOCK |
| </span>std_listener |
| .set_nonblocking(<span class="bool-val">true</span>) |
| .map_err(<span class="kw">crate</span>::Error::new_listen)<span class="question-mark">?</span>; |
| <span class="kw">let </span>listener = TcpListener::from_std(std_listener).map_err(<span class="kw">crate</span>::Error::new_listen)<span class="question-mark">?</span>; |
| AddrIncoming::from_listener(listener) |
| } |
| |
| <span class="doccomment">/// Creates a new `AddrIncoming` binding to provided socket address. |
| </span><span class="kw">pub fn </span>bind(addr: <span class="kw-2">&</span>SocketAddr) -> <span class="kw">crate</span>::Result<<span class="self">Self</span>> { |
| AddrIncoming::new(addr) |
| } |
| |
| <span class="doccomment">/// Creates a new `AddrIncoming` from an existing `tokio::net::TcpListener`. |
| </span><span class="kw">pub fn </span>from_listener(listener: TcpListener) -> <span class="kw">crate</span>::Result<<span class="self">Self</span>> { |
| <span class="kw">let </span>addr = listener.local_addr().map_err(<span class="kw">crate</span>::Error::new_listen)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(AddrIncoming { |
| listener, |
| addr, |
| sleep_on_errors: <span class="bool-val">true</span>, |
| tcp_keepalive_config: TcpKeepaliveConfig::default(), |
| tcp_nodelay: <span class="bool-val">false</span>, |
| timeout: <span class="prelude-val">None</span>, |
| }) |
| } |
| |
| <span class="doccomment">/// Get the local address bound to this listener. |
| </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&</span><span class="self">self</span>) -> SocketAddr { |
| <span class="self">self</span>.addr |
| } |
| |
| <span class="doccomment">/// Set the duration to remain idle before sending TCP keepalive probes. |
| /// |
| /// If `None` is specified, keepalive is disabled. |
| </span><span class="kw">pub fn </span>set_keepalive(<span class="kw-2">&mut </span><span class="self">self</span>, time: <span class="prelude-ty">Option</span><Duration>) -> <span class="kw-2">&mut </span><span class="self">Self </span>{ |
| <span class="self">self</span>.tcp_keepalive_config.time = time; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Set the duration between two successive TCP keepalive retransmissions, |
| /// if acknowledgement to the previous keepalive transmission is not received. |
| </span><span class="kw">pub fn </span>set_keepalive_interval(<span class="kw-2">&mut </span><span class="self">self</span>, interval: <span class="prelude-ty">Option</span><Duration>) -> <span class="kw-2">&mut </span><span class="self">Self </span>{ |
| <span class="self">self</span>.tcp_keepalive_config.interval = interval; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Set the number of retransmissions to be carried out before declaring that remote end is not available. |
| </span><span class="kw">pub fn </span>set_keepalive_retries(<span class="kw-2">&mut </span><span class="self">self</span>, retries: <span class="prelude-ty">Option</span><u32>) -> <span class="kw-2">&mut </span><span class="self">Self </span>{ |
| <span class="self">self</span>.tcp_keepalive_config.retries = retries; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Set the value of `TCP_NODELAY` option for accepted connections. |
| </span><span class="kw">pub fn </span>set_nodelay(<span class="kw-2">&mut </span><span class="self">self</span>, enabled: bool) -> <span class="kw-2">&mut </span><span class="self">Self </span>{ |
| <span class="self">self</span>.tcp_nodelay = enabled; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Set whether to sleep on accept errors. |
| /// |
| /// A possible scenario is that the process has hit the max open files |
| /// allowed, and so trying to accept a new connection will fail with |
| /// `EMFILE`. In some cases, it's preferable to just wait for some time, if |
| /// the application will likely close some files (or connections), and try |
| /// to accept the connection again. If this option is `true`, the error |
| /// will be logged at the `error` level, since it is still a big deal, |
| /// and then the listener will sleep for 1 second. |
| /// |
| /// In other cases, hitting the max open files should be treat similarly |
| /// to being out-of-memory, and simply error (and shutdown). Setting |
| /// this option to `false` will allow that. |
| /// |
| /// Default is `true`. |
| </span><span class="kw">pub fn </span>set_sleep_on_errors(<span class="kw-2">&mut </span><span class="self">self</span>, val: bool) { |
| <span class="self">self</span>.sleep_on_errors = val; |
| } |
| |
| <span class="kw">fn </span>poll_next_(<span class="kw-2">&mut </span><span class="self">self</span>, cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<AddrStream>> { |
| <span class="comment">// Check if a previous timeout is active that was set by IO errors. |
| </span><span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>to) = <span class="self">self</span>.timeout { |
| <span class="macro">ready!</span>(Pin::new(to).poll(cx)); |
| } |
| <span class="self">self</span>.timeout = <span class="prelude-val">None</span>; |
| |
| <span class="kw">loop </span>{ |
| <span class="kw">match </span><span class="macro">ready!</span>(<span class="self">self</span>.listener.poll_accept(cx)) { |
| <span class="prelude-val">Ok</span>((socket, remote_addr)) => { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(tcp_keepalive) = <span class="kw-2">&</span><span class="self">self</span>.tcp_keepalive_config.into_socket2() { |
| <span class="kw">let </span>sock_ref = socket2::SockRef::from(<span class="kw-2">&</span>socket); |
| <span class="kw">if let </span><span class="prelude-val">Err</span>(e) = sock_ref.set_tcp_keepalive(tcp_keepalive) { |
| <span class="macro">trace!</span>(<span class="string">"error trying to set TCP keepalive: {}"</span>, e); |
| } |
| } |
| <span class="kw">if let </span><span class="prelude-val">Err</span>(e) = socket.set_nodelay(<span class="self">self</span>.tcp_nodelay) { |
| <span class="macro">trace!</span>(<span class="string">"error trying to set TCP nodelay: {}"</span>, e); |
| } |
| <span class="kw">let </span>local_addr = socket.local_addr()<span class="question-mark">?</span>; |
| <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Ok</span>(AddrStream::new(socket, remote_addr, local_addr))); |
| } |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="comment">// Connection errors can be ignored directly, continue by |
| // accepting the next request. |
| </span><span class="kw">if </span>is_connection_error(<span class="kw-2">&</span>e) { |
| <span class="macro">debug!</span>(<span class="string">"accepted connection already errored: {}"</span>, e); |
| <span class="kw">continue</span>; |
| } |
| |
| <span class="kw">if </span><span class="self">self</span>.sleep_on_errors { |
| <span class="macro">error!</span>(<span class="string">"accept error: {}"</span>, e); |
| |
| <span class="comment">// Sleep 1s. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>timeout = Box::pin(tokio::time::sleep(Duration::from_secs(<span class="number">1</span>))); |
| |
| <span class="kw">match </span>timeout.as_mut().poll(cx) { |
| Poll::Ready(()) => { |
| <span class="comment">// Wow, it's been a second already? Ok then... |
| </span><span class="kw">continue</span>; |
| } |
| Poll::Pending => { |
| <span class="self">self</span>.timeout = <span class="prelude-val">Some</span>(timeout); |
| <span class="kw">return </span>Poll::Pending; |
| } |
| } |
| } <span class="kw">else </span>{ |
| <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Err</span>(e)); |
| } |
| } |
| } |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Accept <span class="kw">for </span>AddrIncoming { |
| <span class="kw">type </span>Conn = AddrStream; |
| <span class="kw">type </span>Error = io::Error; |
| |
| <span class="kw">fn </span>poll_accept( |
| <span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>, |
| ) -> Poll<<span class="prelude-ty">Option</span><<span class="prelude-ty">Result</span><<span class="self">Self</span>::Conn, <span class="self">Self</span>::Error>>> { |
| <span class="kw">let </span>result = <span class="macro">ready!</span>(<span class="self">self</span>.poll_next_(cx)); |
| Poll::Ready(<span class="prelude-val">Some</span>(result)) |
| } |
| } |
| |
| <span class="doccomment">/// This function defines errors that are per-connection. Which basically |
| /// means that if we get this error from `accept()` system call it means |
| /// next connection might be ready to be accepted. |
| /// |
| /// All other errors will incur a timeout before next `accept()` is performed. |
| /// The timeout is useful to handle resource exhaustion errors like ENFILE |
| /// and EMFILE. Otherwise, could enter into tight loop. |
| </span><span class="kw">fn </span>is_connection_error(e: <span class="kw-2">&</span>io::Error) -> bool { |
| <span class="macro">matches!</span>( |
| e.kind(), |
| io::ErrorKind::ConnectionRefused |
| | io::ErrorKind::ConnectionAborted |
| | io::ErrorKind::ConnectionReset |
| ) |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>AddrIncoming { |
| <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 { |
| f.debug_struct(<span class="string">"AddrIncoming"</span>) |
| .field(<span class="string">"addr"</span>, <span class="kw-2">&</span><span class="self">self</span>.addr) |
| .field(<span class="string">"sleep_on_errors"</span>, <span class="kw-2">&</span><span class="self">self</span>.sleep_on_errors) |
| .field(<span class="string">"tcp_keepalive_config"</span>, <span class="kw-2">&</span><span class="self">self</span>.tcp_keepalive_config) |
| .field(<span class="string">"tcp_nodelay"</span>, <span class="kw-2">&</span><span class="self">self</span>.tcp_nodelay) |
| .finish() |
| } |
| } |
| |
| <span class="kw">mod </span>addr_stream { |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::net::SocketAddr; |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">use </span>std::os::unix::io::{AsRawFd, RawFd}; |
| <span class="kw">use </span>tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; |
| <span class="kw">use </span>tokio::net::TcpStream; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::common::{task, Pin, Poll}; |
| |
| <span class="macro">pin_project_lite::pin_project! </span>{ |
| <span class="doccomment">/// A transport returned yieled by `AddrIncoming`. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>AddrStream { |
| <span class="attribute">#[pin] |
| </span>inner: TcpStream, |
| <span class="kw">pub</span>(<span class="kw">super</span>) remote_addr: SocketAddr, |
| <span class="kw">pub</span>(<span class="kw">super</span>) local_addr: SocketAddr |
| } |
| } |
| |
| <span class="kw">impl </span>AddrStream { |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new( |
| tcp: TcpStream, |
| remote_addr: SocketAddr, |
| local_addr: SocketAddr, |
| ) -> AddrStream { |
| AddrStream { |
| inner: tcp, |
| remote_addr, |
| local_addr, |
| } |
| } |
| |
| <span class="doccomment">/// Returns the remote (peer) address of this connection. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>remote_addr(<span class="kw-2">&</span><span class="self">self</span>) -> SocketAddr { |
| <span class="self">self</span>.remote_addr |
| } |
| |
| <span class="doccomment">/// Returns the local address of this connection. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&</span><span class="self">self</span>) -> SocketAddr { |
| <span class="self">self</span>.local_addr |
| } |
| |
| <span class="doccomment">/// Consumes the AddrStream and returns the underlying IO object |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -> TcpStream { |
| <span class="self">self</span>.inner |
| } |
| |
| <span class="doccomment">/// Attempt to receive data on the socket, without removing that data |
| /// from the queue, registering the current task for wakeup if data is |
| /// not yet available. |
| </span><span class="kw">pub fn </span>poll_peek( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>, |
| buf: <span class="kw-2">&mut </span>tokio::io::ReadBuf<<span class="lifetime">'_</span>>, |
| ) -> Poll<io::Result<usize>> { |
| <span class="self">self</span>.inner.poll_peek(cx, buf) |
| } |
| } |
| |
| <span class="kw">impl </span>AsyncRead <span class="kw">for </span>AddrStream { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>poll_read( |
| <span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>, |
| buf: <span class="kw-2">&mut </span>ReadBuf<<span class="lifetime">'_</span>>, |
| ) -> Poll<io::Result<()>> { |
| <span class="self">self</span>.project().inner.poll_read(cx, buf) |
| } |
| } |
| |
| <span class="kw">impl </span>AsyncWrite <span class="kw">for </span>AddrStream { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>poll_write( |
| <span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>, |
| buf: <span class="kw-2">&</span>[u8], |
| ) -> Poll<io::Result<usize>> { |
| <span class="self">self</span>.project().inner.poll_write(cx, buf) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>poll_write_vectored( |
| <span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>, |
| bufs: <span class="kw-2">&</span>[io::IoSlice<<span class="lifetime">'_</span>>], |
| ) -> Poll<io::Result<usize>> { |
| <span class="self">self</span>.project().inner.poll_write_vectored(cx, bufs) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>poll_flush(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, _cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<()>> { |
| <span class="comment">// TCP flush is a noop |
| </span>Poll::Ready(<span class="prelude-val">Ok</span>(())) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>poll_shutdown(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<()>> { |
| <span class="self">self</span>.project().inner.poll_shutdown(cx) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>is_write_vectored(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="comment">// Note that since `self.inner` is a `TcpStream`, this could |
| // *probably* be hard-coded to return `true`...but it seems more |
| // correct to ask it anyway (maybe we're on some platform without |
| // scatter-gather IO?) |
| </span><span class="self">self</span>.inner.is_write_vectored() |
| } |
| } |
| |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">impl </span>AsRawFd <span class="kw">for </span>AddrStream { |
| <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&</span><span class="self">self</span>) -> RawFd { |
| <span class="self">self</span>.inner.as_raw_fd() |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>std::time::Duration; |
| <span class="kw">use </span><span class="kw">crate</span>::server::tcp::TcpKeepaliveConfig; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>no_tcp_keepalive_config() { |
| <span class="macro">assert!</span>(TcpKeepaliveConfig::default().into_socket2().is_none()); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>tcp_keepalive_time_config() { |
| <span class="kw">let </span><span class="kw-2">mut </span>kac = TcpKeepaliveConfig::default(); |
| kac.time = <span class="prelude-val">Some</span>(Duration::from_secs(<span class="number">60</span>)); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(tcp_keepalive) = kac.into_socket2() { |
| <span class="macro">assert!</span>(<span class="macro">format!</span>(<span class="string">"{tcp_keepalive:?}"</span>).contains(<span class="string">"time: Some(60s)"</span>)); |
| } <span class="kw">else </span>{ |
| <span class="macro">panic!</span>(<span class="string">"test failed"</span>); |
| } |
| } |
| |
| <span class="attribute">#[cfg(any( |
| target_os = <span class="string">"android"</span>, |
| target_os = <span class="string">"dragonfly"</span>, |
| target_os = <span class="string">"freebsd"</span>, |
| target_os = <span class="string">"fuchsia"</span>, |
| target_os = <span class="string">"illumos"</span>, |
| target_os = <span class="string">"linux"</span>, |
| target_os = <span class="string">"netbsd"</span>, |
| target_vendor = <span class="string">"apple"</span>, |
| windows, |
| ))] |
| #[test] |
| </span><span class="kw">fn </span>tcp_keepalive_interval_config() { |
| <span class="kw">let </span><span class="kw-2">mut </span>kac = TcpKeepaliveConfig::default(); |
| kac.interval = <span class="prelude-val">Some</span>(Duration::from_secs(<span class="number">1</span>)); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(tcp_keepalive) = kac.into_socket2() { |
| <span class="macro">assert!</span>(<span class="macro">format!</span>(<span class="string">"{tcp_keepalive:?}"</span>).contains(<span class="string">"interval: Some(1s)"</span>)); |
| } <span class="kw">else </span>{ |
| <span class="macro">panic!</span>(<span class="string">"test failed"</span>); |
| } |
| } |
| |
| <span class="attribute">#[cfg(any( |
| target_os = <span class="string">"android"</span>, |
| target_os = <span class="string">"dragonfly"</span>, |
| target_os = <span class="string">"freebsd"</span>, |
| target_os = <span class="string">"fuchsia"</span>, |
| target_os = <span class="string">"illumos"</span>, |
| target_os = <span class="string">"linux"</span>, |
| target_os = <span class="string">"netbsd"</span>, |
| target_vendor = <span class="string">"apple"</span>, |
| ))] |
| #[test] |
| </span><span class="kw">fn </span>tcp_keepalive_retries_config() { |
| <span class="kw">let </span><span class="kw-2">mut </span>kac = TcpKeepaliveConfig::default(); |
| kac.retries = <span class="prelude-val">Some</span>(<span class="number">3</span>); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(tcp_keepalive) = kac.into_socket2() { |
| <span class="macro">assert!</span>(<span class="macro">format!</span>(<span class="string">"{tcp_keepalive:?}"</span>).contains(<span class="string">"retries: Some(3)"</span>)); |
| } <span class="kw">else </span>{ |
| <span class="macro">panic!</span>(<span class="string">"test failed"</span>); |
| } |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="hyper" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
