blob: 958e12ffee2b285b1f6a30450d023fcc63df2b63 [file] [log] [blame]
<!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/proto/h2/ping.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ping.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>
<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>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
</pre><pre class="rust"><code><span class="doccomment">/// HTTP2 Ping usage
///
/// hyper uses HTTP2 pings for two purposes:
///
/// 1. Adaptive flow control using BDP
/// 2. Connection keep-alive
///
/// Both cases are optional.
///
/// # BDP Algorithm
///
/// 1. When receiving a DATA frame, if a BDP ping isn&#39;t outstanding:
/// 1a. Record current time.
/// 1b. Send a BDP ping.
/// 2. Increment the number of received bytes.
/// 3. When the BDP ping ack is received:
/// 3a. Record duration from sent time.
/// 3b. Merge RTT with a running average.
/// 3c. Calculate bdp as bytes/rtt.
/// 3d. If bdp is over 2/3 max, set new max to bdp and update windows.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">use </span>std::fmt;
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">use </span>std::future::Future;
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">use </span>std::pin::Pin;
<span class="kw">use </span>std::sync::{Arc, Mutex};
<span class="kw">use </span>std::task::{<span class="self">self</span>, Poll};
<span class="kw">use </span>std::time::Duration;
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;runtime&quot;</span>))]
</span><span class="kw">use </span>std::time::Instant;
<span class="kw">use </span>h2::{Ping, PingPong};
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">use </span>tokio::time::{Instant, Sleep};
<span class="kw">use </span>tracing::{debug, trace};
<span class="kw">type </span>WindowSize = u32;
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>disabled() -&gt; Recorder {
Recorder { shared: <span class="prelude-val">None </span>}
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>channel(ping_pong: PingPong, config: Config) -&gt; (Recorder, Ponger) {
<span class="macro">debug_assert!</span>(
config.is_enabled(),
<span class="string">&quot;ping channel requires bdp or keep-alive config&quot;</span>,
);
<span class="kw">let </span>bdp = config.bdp_initial_window.map(|wnd| Bdp {
bdp: wnd,
max_bandwidth: <span class="number">0.0</span>,
rtt: <span class="number">0.0</span>,
ping_delay: Duration::from_millis(<span class="number">100</span>),
stable_count: <span class="number">0</span>,
});
<span class="kw">let </span>(bytes, next_bdp_at) = <span class="kw">if </span>bdp.is_some() {
(<span class="prelude-val">Some</span>(<span class="number">0</span>), <span class="prelude-val">Some</span>(Instant::now()))
} <span class="kw">else </span>{
(<span class="prelude-val">None</span>, <span class="prelude-val">None</span>)
};
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">let </span>keep_alive = config.keep_alive_interval.map(|interval| KeepAlive {
interval,
timeout: config.keep_alive_timeout,
while_idle: config.keep_alive_while_idle,
timer: Box::pin(tokio::time::sleep(interval)),
state: KeepAliveState::Init,
});
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">let </span>last_read_at = keep_alive.as_ref().map(|<span class="kw">_</span>| Instant::now());
<span class="kw">let </span>shared = Arc::new(Mutex::new(Shared {
bytes,
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>last_read_at,
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>is_keep_alive_timed_out: <span class="bool-val">false</span>,
ping_pong,
ping_sent_at: <span class="prelude-val">None</span>,
next_bdp_at,
}));
(
Recorder {
shared: <span class="prelude-val">Some</span>(shared.clone()),
},
Ponger {
bdp,
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>keep_alive,
shared,
},
)
}
<span class="attribute">#[derive(Clone)]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>Config {
<span class="kw">pub</span>(<span class="kw">super</span>) bdp_initial_window: <span class="prelude-ty">Option</span>&lt;WindowSize&gt;,
<span class="doccomment">/// If no frames are received in this amount of time, a PING frame is sent.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">super</span>) keep_alive_interval: <span class="prelude-ty">Option</span>&lt;Duration&gt;,
<span class="doccomment">/// After sending a keepalive PING, the connection will be closed if
/// a pong is not received in this amount of time.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">super</span>) keep_alive_timeout: Duration,
<span class="doccomment">/// If true, sends pings even when there are no active streams.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">super</span>) keep_alive_while_idle: bool,
}
<span class="attribute">#[derive(Clone)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Recorder {
shared: <span class="prelude-ty">Option</span>&lt;Arc&lt;Mutex&lt;Shared&gt;&gt;&gt;,
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>Ponger {
bdp: <span class="prelude-ty">Option</span>&lt;Bdp&gt;,
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>keep_alive: <span class="prelude-ty">Option</span>&lt;KeepAlive&gt;,
shared: Arc&lt;Mutex&lt;Shared&gt;&gt;,
}
<span class="kw">struct </span>Shared {
ping_pong: PingPong,
ping_sent_at: <span class="prelude-ty">Option</span>&lt;Instant&gt;,
<span class="comment">// bdp
</span><span class="doccomment">/// If `Some`, bdp is enabled, and this tracks how many bytes have been
/// read during the current sample.
</span>bytes: <span class="prelude-ty">Option</span>&lt;usize&gt;,
<span class="doccomment">/// We delay a variable amount of time between BDP pings. This allows us
/// to send less pings as the bandwidth stabilizes.
</span>next_bdp_at: <span class="prelude-ty">Option</span>&lt;Instant&gt;,
<span class="comment">// keep-alive
</span><span class="doccomment">/// If `Some`, keep-alive is enabled, and the Instant is how long ago
/// the connection read the last frame.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>last_read_at: <span class="prelude-ty">Option</span>&lt;Instant&gt;,
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>is_keep_alive_timed_out: bool,
}
<span class="kw">struct </span>Bdp {
<span class="doccomment">/// Current BDP in bytes
</span>bdp: u32,
<span class="doccomment">/// Largest bandwidth we&#39;ve seen so far.
</span>max_bandwidth: f64,
<span class="doccomment">/// Round trip time in seconds
</span>rtt: f64,
<span class="doccomment">/// Delay the next ping by this amount.
///
/// This will change depending on how stable the current bandwidth is.
</span>ping_delay: Duration,
<span class="doccomment">/// The count of ping round trips where BDP has stayed the same.
</span>stable_count: u32,
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">struct </span>KeepAlive {
<span class="doccomment">/// If no frames are received in this amount of time, a PING frame is sent.
</span>interval: Duration,
<span class="doccomment">/// After sending a keepalive PING, the connection will be closed if
/// a pong is not received in this amount of time.
</span>timeout: Duration,
<span class="doccomment">/// If true, sends pings even when there are no active streams.
</span>while_idle: bool,
state: KeepAliveState,
timer: Pin&lt;Box&lt;Sleep&gt;&gt;,
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">enum </span>KeepAliveState {
Init,
Scheduled,
PingSent,
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">enum </span>Ponged {
SizeUpdate(WindowSize),
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>KeepAliveTimedOut,
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
#[derive(Debug)]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>KeepAliveTimedOut;
<span class="comment">// ===== impl Config =====
</span><span class="kw">impl </span>Config {
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>is_enabled(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>{
<span class="self">self</span>.bdp_initial_window.is_some() || <span class="self">self</span>.keep_alive_interval.is_some()
}
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;runtime&quot;</span>))]
</span>{
<span class="self">self</span>.bdp_initial_window.is_some()
}
}
}
<span class="comment">// ===== impl Recorder =====
</span><span class="kw">impl </span>Recorder {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>record_data(<span class="kw-2">&amp;</span><span class="self">self</span>, len: usize) {
<span class="kw">let </span>shared = <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>shared) = <span class="self">self</span>.shared {
shared
} <span class="kw">else </span>{
<span class="kw">return</span>;
};
<span class="kw">let </span><span class="kw-2">mut </span>locked = shared.lock().unwrap();
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>locked.update_last_read_at();
<span class="comment">// are we ready to send another bdp ping?
// if not, we don&#39;t need to record bytes either
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>next_bdp_at) = locked.next_bdp_at {
<span class="kw">if </span>Instant::now() &lt; <span class="kw-2">*</span>next_bdp_at {
<span class="kw">return</span>;
} <span class="kw">else </span>{
locked.next_bdp_at = <span class="prelude-val">None</span>;
}
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>bytes) = locked.bytes {
<span class="kw-2">*</span>bytes += len;
} <span class="kw">else </span>{
<span class="comment">// no need to send bdp ping if bdp is disabled
</span><span class="kw">return</span>;
}
<span class="kw">if </span>!locked.is_ping_sent() {
locked.send_ping();
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>record_non_data(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>{
<span class="kw">let </span>shared = <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>shared) = <span class="self">self</span>.shared {
shared
} <span class="kw">else </span>{
<span class="kw">return</span>;
};
<span class="kw">let </span><span class="kw-2">mut </span>locked = shared.lock().unwrap();
locked.update_last_read_at();
}
}
<span class="doccomment">/// If the incoming stream is already closed, convert self into
/// a disabled reporter.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;client&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>for_stream(<span class="self">self</span>, stream: <span class="kw-2">&amp;</span>h2::RecvStream) -&gt; <span class="self">Self </span>{
<span class="kw">if </span>stream.is_end_stream() {
disabled()
} <span class="kw">else </span>{
<span class="self">self
</span>}
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>ensure_not_timed_out(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>{
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>shared) = <span class="self">self</span>.shared {
<span class="kw">let </span>locked = shared.lock().unwrap();
<span class="kw">if </span>locked.is_keep_alive_timed_out {
<span class="kw">return </span><span class="prelude-val">Err</span>(KeepAliveTimedOut.crate_error());
}
}
}
<span class="comment">// else
</span><span class="prelude-val">Ok</span>(())
}
}
<span class="comment">// ===== impl Ponger =====
</span><span class="kw">impl </span>Ponger {
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>poll(<span class="kw-2">&amp;mut </span><span class="self">self</span>, cx: <span class="kw-2">&amp;mut </span>task::Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;Ponged&gt; {
<span class="kw">let </span>now = Instant::now();
<span class="kw">let </span><span class="kw-2">mut </span>locked = <span class="self">self</span>.shared.lock().unwrap();
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">let </span>is_idle = <span class="self">self</span>.is_idle();
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>{
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>ka) = <span class="self">self</span>.keep_alive {
ka.schedule(is_idle, <span class="kw-2">&amp;</span>locked);
ka.maybe_ping(cx, <span class="kw-2">&amp;mut </span>locked);
}
}
<span class="kw">if </span>!locked.is_ping_sent() {
<span class="comment">// XXX: this doesn&#39;t register a waker...?
</span><span class="kw">return </span>Poll::Pending;
}
<span class="kw">match </span>locked.ping_pong.poll_pong(cx) {
Poll::Ready(<span class="prelude-val">Ok</span>(_pong)) =&gt; {
<span class="kw">let </span>start = locked
.ping_sent_at
.expect(<span class="string">&quot;pong received implies ping_sent_at&quot;</span>);
locked.ping_sent_at = <span class="prelude-val">None</span>;
<span class="kw">let </span>rtt = now - start;
<span class="macro">trace!</span>(<span class="string">&quot;recv pong&quot;</span>);
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>{
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>ka) = <span class="self">self</span>.keep_alive {
locked.update_last_read_at();
ka.schedule(is_idle, <span class="kw-2">&amp;</span>locked);
}
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>bdp) = <span class="self">self</span>.bdp {
<span class="kw">let </span>bytes = locked.bytes.expect(<span class="string">&quot;bdp enabled implies bytes&quot;</span>);
locked.bytes = <span class="prelude-val">Some</span>(<span class="number">0</span>); <span class="comment">// reset
</span><span class="macro">trace!</span>(<span class="string">&quot;received BDP ack; bytes = {}, rtt = {:?}&quot;</span>, bytes, rtt);
<span class="kw">let </span>update = bdp.calculate(bytes, rtt);
locked.next_bdp_at = <span class="prelude-val">Some</span>(now + bdp.ping_delay);
<span class="kw">if let </span><span class="prelude-val">Some</span>(update) = update {
<span class="kw">return </span>Poll::Ready(Ponged::SizeUpdate(update))
}
}
}
Poll::Ready(<span class="prelude-val">Err</span>(e)) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;pong error: {}&quot;</span>, e);
}
Poll::Pending =&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span>{
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>ka) = <span class="self">self</span>.keep_alive {
<span class="kw">if let </span><span class="prelude-val">Err</span>(KeepAliveTimedOut) = ka.maybe_timeout(cx) {
<span class="self">self</span>.keep_alive = <span class="prelude-val">None</span>;
locked.is_keep_alive_timed_out = <span class="bool-val">true</span>;
<span class="kw">return </span>Poll::Ready(Ponged::KeepAliveTimedOut);
}
}
}
}
}
<span class="comment">// XXX: this doesn&#39;t register a waker...?
</span>Poll::Pending
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">fn </span>is_idle(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
Arc::strong_count(<span class="kw-2">&amp;</span><span class="self">self</span>.shared) &lt;= <span class="number">2
</span>}
}
<span class="comment">// ===== impl Shared =====
</span><span class="kw">impl </span>Shared {
<span class="kw">fn </span>send_ping(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">match </span><span class="self">self</span>.ping_pong.send_ping(Ping::opaque()) {
<span class="prelude-val">Ok</span>(()) =&gt; {
<span class="self">self</span>.ping_sent_at = <span class="prelude-val">Some</span>(Instant::now());
<span class="macro">trace!</span>(<span class="string">&quot;sent ping&quot;</span>);
}
<span class="prelude-val">Err</span>(err) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;error sending ping: {}&quot;</span>, err);
}
}
}
<span class="kw">fn </span>is_ping_sent(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.ping_sent_at.is_some()
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">fn </span>update_last_read_at(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">if </span><span class="self">self</span>.last_read_at.is_some() {
<span class="self">self</span>.last_read_at = <span class="prelude-val">Some</span>(Instant::now());
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">fn </span>last_read_at(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Instant {
<span class="self">self</span>.last_read_at.expect(<span class="string">&quot;keep_alive expects last_read_at&quot;</span>)
}
}
<span class="comment">// ===== impl Bdp =====
</span><span class="doccomment">/// Any higher than this likely will be hitting the TCP flow control.
</span><span class="kw">const </span>BDP_LIMIT: usize = <span class="number">1024 </span>* <span class="number">1024 </span>* <span class="number">16</span>;
<span class="kw">impl </span>Bdp {
<span class="kw">fn </span>calculate(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bytes: usize, rtt: Duration) -&gt; <span class="prelude-ty">Option</span>&lt;WindowSize&gt; {
<span class="comment">// No need to do any math if we&#39;re at the limit.
</span><span class="kw">if </span><span class="self">self</span>.bdp <span class="kw">as </span>usize == BDP_LIMIT {
<span class="self">self</span>.stabilize_delay();
<span class="kw">return </span><span class="prelude-val">None</span>;
}
<span class="comment">// average the rtt
</span><span class="kw">let </span>rtt = seconds(rtt);
<span class="kw">if </span><span class="self">self</span>.rtt == <span class="number">0.0 </span>{
<span class="comment">// First sample means rtt is first rtt.
</span><span class="self">self</span>.rtt = rtt;
} <span class="kw">else </span>{
<span class="comment">// Weigh this rtt as 1/8 for a moving average.
</span><span class="self">self</span>.rtt += (rtt - <span class="self">self</span>.rtt) * <span class="number">0.125</span>;
}
<span class="comment">// calculate the current bandwidth
</span><span class="kw">let </span>bw = (bytes <span class="kw">as </span>f64) / (<span class="self">self</span>.rtt * <span class="number">1.5</span>);
<span class="macro">trace!</span>(<span class="string">&quot;current bandwidth = {:.1}B/s&quot;</span>, bw);
<span class="kw">if </span>bw &lt; <span class="self">self</span>.max_bandwidth {
<span class="comment">// not a faster bandwidth, so don&#39;t update
</span><span class="self">self</span>.stabilize_delay();
<span class="kw">return </span><span class="prelude-val">None</span>;
} <span class="kw">else </span>{
<span class="self">self</span>.max_bandwidth = bw;
}
<span class="comment">// if the current `bytes` sample is at least 2/3 the previous
// bdp, increase to double the current sample.
</span><span class="kw">if </span>bytes &gt;= <span class="self">self</span>.bdp <span class="kw">as </span>usize * <span class="number">2 </span>/ <span class="number">3 </span>{
<span class="self">self</span>.bdp = (bytes * <span class="number">2</span>).min(BDP_LIMIT) <span class="kw">as </span>WindowSize;
<span class="macro">trace!</span>(<span class="string">&quot;BDP increased to {}&quot;</span>, <span class="self">self</span>.bdp);
<span class="self">self</span>.stable_count = <span class="number">0</span>;
<span class="self">self</span>.ping_delay /= <span class="number">2</span>;
<span class="prelude-val">Some</span>(<span class="self">self</span>.bdp)
} <span class="kw">else </span>{
<span class="self">self</span>.stabilize_delay();
<span class="prelude-val">None
</span>}
}
<span class="kw">fn </span>stabilize_delay(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">if </span><span class="self">self</span>.ping_delay &lt; Duration::from_secs(<span class="number">10</span>) {
<span class="self">self</span>.stable_count += <span class="number">1</span>;
<span class="kw">if </span><span class="self">self</span>.stable_count &gt;= <span class="number">2 </span>{
<span class="self">self</span>.ping_delay <span class="kw-2">*</span>= <span class="number">4</span>;
<span class="self">self</span>.stable_count = <span class="number">0</span>;
}
}
}
}
<span class="kw">fn </span>seconds(dur: Duration) -&gt; f64 {
<span class="kw">const </span>NANOS_PER_SEC: f64 = <span class="number">1_000_000_000.0</span>;
<span class="kw">let </span>secs = dur.as_secs() <span class="kw">as </span>f64;
secs + (dur.subsec_nanos() <span class="kw">as </span>f64) / NANOS_PER_SEC
}
<span class="comment">// ===== impl KeepAlive =====
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">impl </span>KeepAlive {
<span class="kw">fn </span>schedule(<span class="kw-2">&amp;mut </span><span class="self">self</span>, is_idle: bool, shared: <span class="kw-2">&amp;</span>Shared) {
<span class="kw">match </span><span class="self">self</span>.state {
KeepAliveState::Init =&gt; {
<span class="kw">if </span>!<span class="self">self</span>.while_idle &amp;&amp; is_idle {
<span class="kw">return</span>;
}
<span class="self">self</span>.state = KeepAliveState::Scheduled;
<span class="kw">let </span>interval = shared.last_read_at() + <span class="self">self</span>.interval;
<span class="self">self</span>.timer.as_mut().reset(interval);
}
KeepAliveState::PingSent =&gt; {
<span class="kw">if </span>shared.is_ping_sent() {
<span class="kw">return</span>;
}
<span class="self">self</span>.state = KeepAliveState::Scheduled;
<span class="kw">let </span>interval = shared.last_read_at() + <span class="self">self</span>.interval;
<span class="self">self</span>.timer.as_mut().reset(interval);
}
KeepAliveState::Scheduled =&gt; (),
}
}
<span class="kw">fn </span>maybe_ping(<span class="kw-2">&amp;mut </span><span class="self">self</span>, cx: <span class="kw-2">&amp;mut </span>task::Context&lt;<span class="lifetime">&#39;_</span>&gt;, shared: <span class="kw-2">&amp;mut </span>Shared) {
<span class="kw">match </span><span class="self">self</span>.state {
KeepAliveState::Scheduled =&gt; {
<span class="kw">if </span>Pin::new(<span class="kw-2">&amp;mut </span><span class="self">self</span>.timer).poll(cx).is_pending() {
<span class="kw">return</span>;
}
<span class="comment">// check if we&#39;ve received a frame while we were scheduled
</span><span class="kw">if </span>shared.last_read_at() + <span class="self">self</span>.interval &gt; <span class="self">self</span>.timer.deadline() {
<span class="self">self</span>.state = KeepAliveState::Init;
cx.waker().wake_by_ref(); <span class="comment">// schedule us again
</span><span class="kw">return</span>;
}
<span class="macro">trace!</span>(<span class="string">&quot;keep-alive interval ({:?}) reached&quot;</span>, <span class="self">self</span>.interval);
shared.send_ping();
<span class="self">self</span>.state = KeepAliveState::PingSent;
<span class="kw">let </span>timeout = Instant::now() + <span class="self">self</span>.timeout;
<span class="self">self</span>.timer.as_mut().reset(timeout);
}
KeepAliveState::Init | KeepAliveState::PingSent =&gt; (),
}
}
<span class="kw">fn </span>maybe_timeout(<span class="kw-2">&amp;mut </span><span class="self">self</span>, cx: <span class="kw-2">&amp;mut </span>task::Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), KeepAliveTimedOut&gt; {
<span class="kw">match </span><span class="self">self</span>.state {
KeepAliveState::PingSent =&gt; {
<span class="kw">if </span>Pin::new(<span class="kw-2">&amp;mut </span><span class="self">self</span>.timer).poll(cx).is_pending() {
<span class="kw">return </span><span class="prelude-val">Ok</span>(());
}
<span class="macro">trace!</span>(<span class="string">&quot;keep-alive timeout ({:?}) reached&quot;</span>, <span class="self">self</span>.timeout);
<span class="prelude-val">Err</span>(KeepAliveTimedOut)
}
KeepAliveState::Init | KeepAliveState::Scheduled =&gt; <span class="prelude-val">Ok</span>(()),
}
}
}
<span class="comment">// ===== impl KeepAliveTimedOut =====
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">impl </span>KeepAliveTimedOut {
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>crate_error(<span class="self">self</span>) -&gt; <span class="kw">crate</span>::Error {
<span class="kw">crate</span>::Error::new(<span class="kw">crate</span>::error::Kind::Http2).with(<span class="self">self</span>)
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">impl </span>fmt::Display <span class="kw">for </span>KeepAliveTimedOut {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
f.write_str(<span class="string">&quot;keep-alive timed out&quot;</span>)
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;runtime&quot;</span>)]
</span><span class="kw">impl </span>std::error::Error <span class="kw">for </span>KeepAliveTimedOut {
<span class="kw">fn </span>source(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>(<span class="kw">dyn </span>std::error::Error + <span class="lifetime">&#39;static</span>)&gt; {
<span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="kw">crate</span>::error::TimedOut)
}
}
</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>