| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/net/tcp/socket.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>socket.rs - source</title><link rel="stylesheet" type="text/css" href="../../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../../storage.js"></script><script src="../../../../crates.js"></script><noscript><link rel="stylesheet" href="../../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../../favicon.svg"> |
| <link rel="alternate icon" type="image/png" href="../../../../favicon-16x16.png"> |
| <link rel="alternate icon" type="image/png" href="../../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../../../mio/index.html'><div class='logo-container rust-logo'><img src='../../../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button> |
| <a id="settings-menu" href="../../../../settings.html"><img src="../../../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span> |
| <span id="2"> 2</span> |
| <span id="3"> 3</span> |
| <span id="4"> 4</span> |
| <span id="5"> 5</span> |
| <span id="6"> 6</span> |
| <span id="7"> 7</span> |
| <span id="8"> 8</span> |
| <span id="9"> 9</span> |
| <span id="10"> 10</span> |
| <span id="11"> 11</span> |
| <span id="12"> 12</span> |
| <span id="13"> 13</span> |
| <span id="14"> 14</span> |
| <span id="15"> 15</span> |
| <span id="16"> 16</span> |
| <span id="17"> 17</span> |
| <span id="18"> 18</span> |
| <span id="19"> 19</span> |
| <span id="20"> 20</span> |
| <span id="21"> 21</span> |
| <span id="22"> 22</span> |
| <span id="23"> 23</span> |
| <span id="24"> 24</span> |
| <span id="25"> 25</span> |
| <span id="26"> 26</span> |
| <span id="27"> 27</span> |
| <span id="28"> 28</span> |
| <span id="29"> 29</span> |
| <span id="30"> 30</span> |
| <span id="31"> 31</span> |
| <span id="32"> 32</span> |
| <span id="33"> 33</span> |
| <span id="34"> 34</span> |
| <span id="35"> 35</span> |
| <span id="36"> 36</span> |
| <span id="37"> 37</span> |
| <span id="38"> 38</span> |
| <span id="39"> 39</span> |
| <span id="40"> 40</span> |
| <span id="41"> 41</span> |
| <span id="42"> 42</span> |
| <span id="43"> 43</span> |
| <span id="44"> 44</span> |
| <span id="45"> 45</span> |
| <span id="46"> 46</span> |
| <span id="47"> 47</span> |
| <span id="48"> 48</span> |
| <span id="49"> 49</span> |
| <span id="50"> 50</span> |
| <span id="51"> 51</span> |
| <span id="52"> 52</span> |
| <span id="53"> 53</span> |
| <span id="54"> 54</span> |
| <span id="55"> 55</span> |
| <span id="56"> 56</span> |
| <span id="57"> 57</span> |
| <span id="58"> 58</span> |
| <span id="59"> 59</span> |
| <span id="60"> 60</span> |
| <span id="61"> 61</span> |
| <span id="62"> 62</span> |
| <span id="63"> 63</span> |
| <span id="64"> 64</span> |
| <span id="65"> 65</span> |
| <span id="66"> 66</span> |
| <span id="67"> 67</span> |
| <span id="68"> 68</span> |
| <span id="69"> 69</span> |
| <span id="70"> 70</span> |
| <span id="71"> 71</span> |
| <span id="72"> 72</span> |
| <span id="73"> 73</span> |
| <span id="74"> 74</span> |
| <span id="75"> 75</span> |
| <span id="76"> 76</span> |
| <span id="77"> 77</span> |
| <span id="78"> 78</span> |
| <span id="79"> 79</span> |
| <span id="80"> 80</span> |
| <span id="81"> 81</span> |
| <span id="82"> 82</span> |
| <span id="83"> 83</span> |
| <span id="84"> 84</span> |
| <span id="85"> 85</span> |
| <span id="86"> 86</span> |
| <span id="87"> 87</span> |
| <span id="88"> 88</span> |
| <span id="89"> 89</span> |
| <span id="90"> 90</span> |
| <span id="91"> 91</span> |
| <span id="92"> 92</span> |
| <span id="93"> 93</span> |
| <span id="94"> 94</span> |
| <span id="95"> 95</span> |
| <span id="96"> 96</span> |
| <span id="97"> 97</span> |
| <span id="98"> 98</span> |
| <span id="99"> 99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <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> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| </pre><div class="example-wrap"><pre class="rust "> |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">net</span>::<span class="ident">SocketAddr</span>; |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span> |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">io</span>::{<span class="ident">AsRawFd</span>, <span class="ident">FromRawFd</span>, <span class="ident">IntoRawFd</span>, <span class="ident">RawFd</span>}; |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span> |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">windows</span>::<span class="ident">io</span>::{<span class="ident">AsRawSocket</span>, <span class="ident">FromRawSocket</span>, <span class="ident">IntoRawSocket</span>, <span class="ident">RawSocket</span>}; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::<span class="ident">Duration</span>; |
| |
| <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">net</span>::{<span class="ident">TcpListener</span>, <span class="ident">TcpStream</span>}; |
| <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">sys</span>; |
| |
| <span class="doccomment">/// A non-blocking TCP socket used to configure a stream or listener.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The `TcpSocket` type wraps the operating-system's socket handle. This type</span> |
| <span class="doccomment">/// is used to configure the socket before establishing a connection or start</span> |
| <span class="doccomment">/// listening for inbound connections.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The socket will be closed when the value is dropped.</span> |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">TcpSocket</span> { |
| <span class="ident">sys</span>: <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">TcpSocket</span>, |
| } |
| |
| <span class="doccomment">/// Configures a socket's TCP keepalive parameters.</span> |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Default</span>, <span class="ident">Clone</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">TcpKeepalive</span> { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">time</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>, |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>( |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"windows"</span>, |
| ))]</span> |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">interval</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>, |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>( |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>, |
| ))]</span> |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">retries</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span>, |
| } |
| |
| <span class="kw">impl</span> <span class="ident">TcpSocket</span> { |
| <span class="doccomment">/// Create a new IPv4 TCP socket.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This calls `socket(2)`.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new_v4</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">TcpSocket</span><span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">new_v4_socket</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">sys</span><span class="op">|</span> <span class="ident">TcpSocket</span> { <span class="ident">sys</span> }) |
| } |
| |
| <span class="doccomment">/// Create a new IPv6 TCP socket.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This calls `socket(2)`.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new_v6</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">TcpSocket</span><span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">new_v6_socket</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">sys</span><span class="op">|</span> <span class="ident">TcpSocket</span> { <span class="ident">sys</span> }) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">new_for_addr</span>(<span class="ident">addr</span>: <span class="ident">SocketAddr</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">TcpSocket</span><span class="op">></span> { |
| <span class="kw">if</span> <span class="ident">addr</span>.<span class="ident">is_ipv4</span>() { |
| <span class="ident">TcpSocket</span>::<span class="ident">new_v4</span>() |
| } <span class="kw">else</span> { |
| <span class="ident">TcpSocket</span>::<span class="ident">new_v6</span>() |
| } |
| } |
| |
| <span class="doccomment">/// Bind `addr` to the TCP socket.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">bind</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">addr</span>: <span class="ident">SocketAddr</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">bind</span>(<span class="self">self</span>.<span class="ident">sys</span>, <span class="ident">addr</span>) |
| } |
| |
| <span class="doccomment">/// Connect the socket to `addr`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This consumes the socket and performs the connect operation. Once the</span> |
| <span class="doccomment">/// connection completes, the socket is now a non-blocking `TcpStream` and</span> |
| <span class="doccomment">/// can be used as such.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">connect</span>(<span class="self">self</span>, <span class="ident">addr</span>: <span class="ident">SocketAddr</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">TcpStream</span><span class="op">></span> { |
| <span class="kw">let</span> <span class="ident">stream</span> <span class="op">=</span> <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">connect</span>(<span class="self">self</span>.<span class="ident">sys</span>, <span class="ident">addr</span>)<span class="question-mark">?</span>; |
| |
| <span class="comment">// Don't close the socket</span> |
| <span class="ident">mem</span>::<span class="ident">forget</span>(<span class="self">self</span>); |
| <span class="prelude-val">Ok</span>(<span class="ident">TcpStream</span>::<span class="ident">from_std</span>(<span class="ident">stream</span>)) |
| } |
| |
| <span class="doccomment">/// Listen for inbound connections, converting the socket to a</span> |
| <span class="doccomment">/// `TcpListener`.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">listen</span>(<span class="self">self</span>, <span class="ident">backlog</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">TcpListener</span><span class="op">></span> { |
| <span class="kw">let</span> <span class="ident">listener</span> <span class="op">=</span> <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">listen</span>(<span class="self">self</span>.<span class="ident">sys</span>, <span class="ident">backlog</span>)<span class="question-mark">?</span>; |
| |
| <span class="comment">// Don't close the socket</span> |
| <span class="ident">mem</span>::<span class="ident">forget</span>(<span class="self">self</span>); |
| <span class="prelude-val">Ok</span>(<span class="ident">TcpListener</span>::<span class="ident">from_std</span>(<span class="ident">listener</span>)) |
| } |
| |
| <span class="doccomment">/// Sets the value of `SO_REUSEADDR` on this socket.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_reuseaddr</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">reuseaddr</span>: <span class="ident">bool</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">set_reuseaddr</span>(<span class="self">self</span>.<span class="ident">sys</span>, <span class="ident">reuseaddr</span>) |
| } |
| |
| <span class="doccomment">/// Get the value of `SO_REUSEADDR` set on this socket.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_reuseaddr</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">bool</span><span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">get_reuseaddr</span>(<span class="self">self</span>.<span class="ident">sys</span>) |
| } |
| |
| <span class="doccomment">/// Sets the value of `SO_REUSEPORT` on this socket.</span> |
| <span class="doccomment">/// Only supported available in unix</span> |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">unix</span>, <span class="ident">not</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"solaris"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"illumos"</span>))))]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_reuseport</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">reuseport</span>: <span class="ident">bool</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">set_reuseport</span>(<span class="self">self</span>.<span class="ident">sys</span>, <span class="ident">reuseport</span>) |
| } |
| |
| <span class="doccomment">/// Get the value of `SO_REUSEPORT` set on this socket.</span> |
| <span class="doccomment">/// Only supported available in unix</span> |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">unix</span>, <span class="ident">not</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"solaris"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"illumos"</span>))))]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_reuseport</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">bool</span><span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">get_reuseport</span>(<span class="self">self</span>.<span class="ident">sys</span>) |
| } |
| |
| <span class="doccomment">/// Sets the value of `SO_LINGER` on this socket.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_linger</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">dur</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">set_linger</span>(<span class="self">self</span>.<span class="ident">sys</span>, <span class="ident">dur</span>) |
| } |
| |
| <span class="doccomment">/// Gets the value of `SO_LINGER` on this socket</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_linger</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span><span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">get_linger</span>(<span class="self">self</span>.<span class="ident">sys</span>) |
| } |
| |
| <span class="doccomment">/// Sets the value of `SO_RCVBUF` on this socket.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_recv_buffer_size</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">size</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">set_recv_buffer_size</span>(<span class="self">self</span>.<span class="ident">sys</span>, <span class="ident">size</span>) |
| } |
| |
| <span class="doccomment">/// Get the value of `SO_RCVBUF` set on this socket.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Note that if [`set_recv_buffer_size`] has been called on this socket</span> |
| <span class="doccomment">/// previously, the value returned by this function may not be the same as</span> |
| <span class="doccomment">/// the argument provided to `set_recv_buffer_size`. This is for the</span> |
| <span class="doccomment">/// following reasons:</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// * Most operating systems have minimum and maximum allowed sizes for the</span> |
| <span class="doccomment">/// receive buffer, and will clamp the provided value if it is below the</span> |
| <span class="doccomment">/// minimum or above the maximum. The minimum and maximum buffer sizes are</span> |
| <span class="doccomment">/// OS-dependent.</span> |
| <span class="doccomment">/// * Linux will double the buffer size to account for internal bookkeeping</span> |
| <span class="doccomment">/// data, and returns the doubled value from `getsockopt(2)`. As per `man</span> |
| <span class="doccomment">/// 7 socket`:</span> |
| <span class="doccomment">/// > Sets or gets the maximum socket receive buffer in bytes. The</span> |
| <span class="doccomment">/// > kernel doubles this value (to allow space for bookkeeping</span> |
| <span class="doccomment">/// > overhead) when it is set using `setsockopt(2)`, and this doubled</span> |
| <span class="doccomment">/// > value is returned by `getsockopt(2)`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`set_recv_buffer_size`]: #method.set_recv_buffer_size</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_recv_buffer_size</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">get_recv_buffer_size</span>(<span class="self">self</span>.<span class="ident">sys</span>) |
| } |
| |
| <span class="doccomment">/// Sets the value of `SO_SNDBUF` on this socket.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_send_buffer_size</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">size</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">set_send_buffer_size</span>(<span class="self">self</span>.<span class="ident">sys</span>, <span class="ident">size</span>) |
| } |
| |
| <span class="doccomment">/// Get the value of `SO_SNDBUF` set on this socket.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Note that if [`set_send_buffer_size`] has been called on this socket</span> |
| <span class="doccomment">/// previously, the value returned by this function may not be the same as</span> |
| <span class="doccomment">/// the argument provided to `set_send_buffer_size`. This is for the</span> |
| <span class="doccomment">/// following reasons:</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// * Most operating systems have minimum and maximum allowed sizes for the</span> |
| <span class="doccomment">/// receive buffer, and will clamp the provided value if it is below the</span> |
| <span class="doccomment">/// minimum or above the maximum. The minimum and maximum buffer sizes are</span> |
| <span class="doccomment">/// OS-dependent.</span> |
| <span class="doccomment">/// * Linux will double the buffer size to account for internal bookkeeping</span> |
| <span class="doccomment">/// data, and returns the doubled value from `getsockopt(2)`. As per `man</span> |
| <span class="doccomment">/// 7 socket`:</span> |
| <span class="doccomment">/// > Sets or gets the maximum socket send buffer in bytes. The</span> |
| <span class="doccomment">/// > kernel doubles this value (to allow space for bookkeeping</span> |
| <span class="doccomment">/// > overhead) when it is set using `setsockopt(2)`, and this doubled</span> |
| <span class="doccomment">/// > value is returned by `getsockopt(2)`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`set_send_buffer_size`]: #method.set_send_buffer_size</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_send_buffer_size</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">get_send_buffer_size</span>(<span class="self">self</span>.<span class="ident">sys</span>) |
| } |
| |
| <span class="doccomment">/// Sets whether keepalive messages are enabled to be sent on this socket.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This will set the `SO_KEEPALIVE` option on this socket.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_keepalive</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">keepalive</span>: <span class="ident">bool</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">set_keepalive</span>(<span class="self">self</span>.<span class="ident">sys</span>, <span class="ident">keepalive</span>) |
| } |
| |
| <span class="doccomment">/// Returns whether or not TCP keepalive probes will be sent by this socket.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_keepalive</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">bool</span><span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">get_keepalive</span>(<span class="self">self</span>.<span class="ident">sys</span>) |
| } |
| |
| <span class="doccomment">/// Sets parameters configuring TCP keepalive probes for this socket.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The supported parameters depend on the operating system, and are</span> |
| <span class="doccomment">/// configured using the [`TcpKeepalive`] struct. At a minimum, all systems</span> |
| <span class="doccomment">/// support configuring the [keepalive time]: the time after which the OS</span> |
| <span class="doccomment">/// will start sending keepalive messages on an idle connection.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Notes</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// * This will enable TCP keepalive on this socket, if it is not already</span> |
| <span class="doccomment">/// enabled.</span> |
| <span class="doccomment">/// * On some platforms, such as Windows, any keepalive parameters *not*</span> |
| <span class="doccomment">/// configured by the `TcpKeepalive` struct passed to this function may be</span> |
| <span class="doccomment">/// overwritten with their default values. Therefore, this function should</span> |
| <span class="doccomment">/// either only be called once per socket, or the same parameters should</span> |
| <span class="doccomment">/// be passed every time it is called.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Examples</span> |
| <span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"os-poll"</span>, <span class="ident">doc</span> <span class="op">=</span> <span class="string">"```"</span>)]</span> |
| <span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"os-poll"</span>), <span class="ident">doc</span> <span class="op">=</span> <span class="string">"```ignore"</span>)]</span> |
| <span class="doccomment">/// use mio::net::{TcpSocket, TcpKeepalive};</span> |
| <span class="doccomment">/// use std::time::Duration;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # fn main() -> Result<(), std::io::Error> {</span> |
| <span class="doccomment">/// let socket = TcpSocket::new_v6()?;</span> |
| <span class="doccomment">/// let keepalive = TcpKeepalive::default()</span> |
| <span class="doccomment">/// .with_time(Duration::from_secs(4));</span> |
| <span class="doccomment">/// // Depending on the target operating system, we may also be able to</span> |
| <span class="doccomment">/// // configure the keepalive probe interval and/or the number of retries</span> |
| <span class="doccomment">/// // here as well.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// socket.set_keepalive_params(keepalive)?;</span> |
| <span class="doccomment">/// # Ok(()) }</span> |
| <span class="doccomment">/// ```</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`TcpKeepalive`]: ../struct.TcpKeepalive.html</span> |
| <span class="doccomment">/// [keepalive time]: ../struct.TcpKeepalive.html#method.with_time</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_keepalive_params</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">keepalive</span>: <span class="ident">TcpKeepalive</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| <span class="self">self</span>.<span class="ident">set_keepalive</span>(<span class="bool-val">true</span>)<span class="question-mark">?</span>; |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">set_keepalive_params</span>(<span class="self">self</span>.<span class="ident">sys</span>, <span class="ident">keepalive</span>) |
| } |
| |
| <span class="doccomment">/// Returns the amount of time after which TCP keepalive probes will be sent</span> |
| <span class="doccomment">/// on idle connections.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If `None`, then keepalive messages are disabled.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This returns the value of `SO_KEEPALIVE` + `IPPROTO_TCP` on OpenBSD,</span> |
| <span class="doccomment">/// NetBSD, and Haiku, `TCP_KEEPALIVE` on macOS and iOS, and `TCP_KEEPIDLE`</span> |
| <span class="doccomment">/// on all other Unix operating systems. On Windows, it is not possible to</span> |
| <span class="doccomment">/// access the value of TCP keepalive parameters after they have been set.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Some platforms specify this value in seconds, so sub-second</span> |
| <span class="doccomment">/// specifications may be omitted.</span> |
| <span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">docsrs</span>, <span class="ident">doc</span>(<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"windows"</span>))))]</span> |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"windows"</span>))]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_keepalive_time</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span><span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">get_keepalive_time</span>(<span class="self">self</span>.<span class="ident">sys</span>) |
| } |
| |
| <span class="doccomment">/// Returns the time interval between TCP keepalive probes, if TCP keepalive is</span> |
| <span class="doccomment">/// enabled on this socket.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If `None`, then keepalive messages are disabled.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This returns the value of `TCP_KEEPINTVL` on supported Unix operating</span> |
| <span class="doccomment">/// systems. On Windows, it is not possible to access the value of TCP</span> |
| <span class="doccomment">/// keepalive parameters after they have been set..</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Some platforms specify this value in seconds, so sub-second</span> |
| <span class="doccomment">/// specifications may be omitted.</span> |
| <span class="attribute">#[<span class="ident">cfg_attr</span>( |
| <span class="ident">docsrs</span>, |
| <span class="ident">doc</span>(<span class="ident">cfg</span>(<span class="ident">any</span>( |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>, |
| ))) |
| )]</span> |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>( |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>, |
| ))]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_keepalive_interval</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span><span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">get_keepalive_interval</span>(<span class="self">self</span>.<span class="ident">sys</span>) |
| } |
| |
| <span class="doccomment">/// Returns the maximum number of TCP keepalive probes that will be sent before</span> |
| <span class="doccomment">/// dropping a connection, if TCP keepalive is enabled on this socket.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If `None`, then keepalive messages are disabled.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This returns the value of `TCP_KEEPCNT` on Unix operating systems that</span> |
| <span class="doccomment">/// support this option. On Windows, it is not possible to access the value</span> |
| <span class="doccomment">/// of TCP keepalive parameters after they have been set.</span> |
| <span class="attribute">#[<span class="ident">cfg_attr</span>( |
| <span class="ident">docsrs</span>, |
| <span class="ident">doc</span>(<span class="ident">cfg</span>(<span class="ident">any</span>( |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>, |
| ))) |
| )]</span> |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>( |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>, |
| ))]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_keepalive_retries</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span><span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">get_keepalive_retries</span>(<span class="self">self</span>.<span class="ident">sys</span>) |
| } |
| |
| <span class="doccomment">/// Returns the local address of this socket</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Will return `Err` result in windows if called before calling `bind`</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_localaddr</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">SocketAddr</span><span class="op">></span> { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">get_localaddr</span>(<span class="self">self</span>.<span class="ident">sys</span>) |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">TcpSocket</span> { |
| <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) { |
| <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">close</span>(<span class="self">self</span>.<span class="ident">sys</span>); |
| } |
| } |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span> |
| <span class="kw">impl</span> <span class="ident">IntoRawFd</span> <span class="kw">for</span> <span class="ident">TcpSocket</span> { |
| <span class="kw">fn</span> <span class="ident">into_raw_fd</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">RawFd</span> { |
| <span class="kw">let</span> <span class="ident">ret</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">sys</span>; |
| <span class="comment">// Avoid closing the socket</span> |
| <span class="ident">mem</span>::<span class="ident">forget</span>(<span class="self">self</span>); |
| <span class="ident">ret</span> |
| } |
| } |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span> |
| <span class="kw">impl</span> <span class="ident">AsRawFd</span> <span class="kw">for</span> <span class="ident">TcpSocket</span> { |
| <span class="kw">fn</span> <span class="ident">as_raw_fd</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">RawFd</span> { |
| <span class="self">self</span>.<span class="ident">sys</span> |
| } |
| } |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span> |
| <span class="kw">impl</span> <span class="ident">FromRawFd</span> <span class="kw">for</span> <span class="ident">TcpSocket</span> { |
| <span class="doccomment">/// Converts a `RawFd` to a `TcpSocket`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Notes</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The caller is responsible for ensuring that the socket is in</span> |
| <span class="doccomment">/// non-blocking mode.</span> |
| <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_raw_fd</span>(<span class="ident">fd</span>: <span class="ident">RawFd</span>) <span class="op">-</span><span class="op">></span> <span class="ident">TcpSocket</span> { |
| <span class="ident">TcpSocket</span> { <span class="ident">sys</span>: <span class="ident">fd</span> } |
| } |
| } |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span> |
| <span class="kw">impl</span> <span class="ident">IntoRawSocket</span> <span class="kw">for</span> <span class="ident">TcpSocket</span> { |
| <span class="kw">fn</span> <span class="ident">into_raw_socket</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">RawSocket</span> { |
| <span class="comment">// The winapi crate defines `SOCKET` as `usize`. The Rust std</span> |
| <span class="comment">// conditionally defines `RawSocket` as a fixed size unsigned integer</span> |
| <span class="comment">// matching the pointer width. These end up being the same type but we</span> |
| <span class="comment">// must cast between them.</span> |
| <span class="kw">let</span> <span class="ident">ret</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">sys</span> <span class="kw">as</span> <span class="ident">RawSocket</span>; |
| |
| <span class="comment">// Avoid closing the socket</span> |
| <span class="ident">mem</span>::<span class="ident">forget</span>(<span class="self">self</span>); |
| |
| <span class="ident">ret</span> |
| } |
| } |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span> |
| <span class="kw">impl</span> <span class="ident">AsRawSocket</span> <span class="kw">for</span> <span class="ident">TcpSocket</span> { |
| <span class="kw">fn</span> <span class="ident">as_raw_socket</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">RawSocket</span> { |
| <span class="self">self</span>.<span class="ident">sys</span> <span class="kw">as</span> <span class="ident">RawSocket</span> |
| } |
| } |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span> |
| <span class="kw">impl</span> <span class="ident">FromRawSocket</span> <span class="kw">for</span> <span class="ident">TcpSocket</span> { |
| <span class="doccomment">/// Converts a `RawSocket` to a `TcpSocket`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Notes</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The caller is responsible for ensuring that the socket is in</span> |
| <span class="doccomment">/// non-blocking mode.</span> |
| <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_raw_socket</span>(<span class="ident">socket</span>: <span class="ident">RawSocket</span>) <span class="op">-</span><span class="op">></span> <span class="ident">TcpSocket</span> { |
| <span class="ident">TcpSocket</span> { |
| <span class="ident">sys</span>: <span class="ident">socket</span> <span class="kw">as</span> <span class="ident">sys</span>::<span class="ident">tcp</span>::<span class="ident">TcpSocket</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">TcpKeepalive</span> { |
| <span class="comment">// Sets the amount of time after which TCP keepalive probes will be sent</span> |
| <span class="doccomment">/// on idle connections.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This will set the value of `SO_KEEPALIVE` + `IPPROTO_TCP` on OpenBSD,</span> |
| <span class="doccomment">/// NetBSD, and Haiku, `TCP_KEEPALIVE` on macOS and iOS, and `TCP_KEEPIDLE`</span> |
| <span class="doccomment">/// on all other Unix operating systems. On Windows, this sets the value of</span> |
| <span class="doccomment">/// the `tcp_keepalive` struct's `keepalivetime` field.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Some platforms specify this value in seconds, so sub-second</span> |
| <span class="doccomment">/// specifications may be omitted.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_time</span>(<span class="self">self</span>, <span class="ident">time</span>: <span class="ident">Duration</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> { |
| <span class="self">Self</span> { |
| <span class="ident">time</span>: <span class="prelude-val">Some</span>(<span class="ident">time</span>), |
| ..<span class="self">self</span> |
| } |
| } |
| |
| <span class="doccomment">/// Sets the time interval between TCP keepalive probes.</span> |
| <span class="doccomment">/// This sets the value of `TCP_KEEPINTVL` on supported Unix operating</span> |
| <span class="doccomment">/// systems. On Windows, this sets the value of the `tcp_keepalive` struct's</span> |
| <span class="doccomment">/// `keepaliveinterval` field.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Some platforms specify this value in seconds, so sub-second</span> |
| <span class="doccomment">/// specifications may be omitted.</span> |
| <span class="attribute">#[<span class="ident">cfg_attr</span>( |
| <span class="ident">docsrs</span>, |
| <span class="ident">doc</span>(<span class="ident">cfg</span>(<span class="ident">any</span>( |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"windows"</span> |
| ))) |
| )]</span> |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>( |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"windows"</span> |
| ))]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_interval</span>(<span class="self">self</span>, <span class="ident">interval</span>: <span class="ident">Duration</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> { |
| <span class="self">Self</span> { |
| <span class="ident">interval</span>: <span class="prelude-val">Some</span>(<span class="ident">interval</span>), |
| ..<span class="self">self</span> |
| } |
| } |
| |
| <span class="doccomment">/// Sets the maximum number of TCP keepalive probes that will be sent before</span> |
| <span class="doccomment">/// dropping a connection, if TCP keepalive is enabled on this socket.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This will set the value of `TCP_KEEPCNT` on Unix operating systems that</span> |
| <span class="doccomment">/// support this option.</span> |
| <span class="attribute">#[<span class="ident">cfg_attr</span>( |
| <span class="ident">docsrs</span>, |
| <span class="ident">doc</span>(<span class="ident">cfg</span>(<span class="ident">any</span>( |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>, |
| ))) |
| )]</span> |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>( |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>, |
| ))]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_retries</span>(<span class="self">self</span>, <span class="ident">retries</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> { |
| <span class="self">Self</span> { |
| <span class="ident">retries</span>: <span class="prelude-val">Some</span>(<span class="ident">retries</span>), |
| ..<span class="self">self</span> |
| } |
| } |
| |
| <span class="doccomment">/// Returns a new, empty set of TCP keepalive parameters.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> { |
| <span class="self">Self</span>::<span class="ident">default</span>() |
| } |
| } |
| </pre></div> |
| </section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="mio" data-search-js="../../../../search-index.js"></div> |
| <script src="../../../../main.js"></script><script src="../../../../source-script.js"></script><script src="../../../../source-files.js"></script></body></html> |
