blob: a510c53234b00d6c28d8e4506a484e26c994261d [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/h2-0.3.19/src/proto/streams/send.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>send.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="../../../../h2/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="../../../../h2/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>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
</pre><pre class="rust"><code><span class="kw">use super</span>::{
store, Buffer, Codec, Config, Counts, Frame, Prioritize, Prioritized, Store, Stream, StreamId,
StreamIdOverflow, WindowSize,
};
<span class="kw">use </span><span class="kw">crate</span>::codec::UserError;
<span class="kw">use </span><span class="kw">crate</span>::frame::{<span class="self">self</span>, Reason};
<span class="kw">use </span><span class="kw">crate</span>::proto::{Error, Initiator};
<span class="kw">use </span>bytes::Buf;
<span class="kw">use </span>tokio::io::AsyncWrite;
<span class="kw">use </span>std::cmp::Ordering;
<span class="kw">use </span>std::io;
<span class="kw">use </span>std::task::{Context, Poll, Waker};
<span class="doccomment">/// Manages state transitions related to outbound frames.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>Send {
<span class="doccomment">/// Stream identifier to use for next initialized stream.
</span>next_stream_id: <span class="prelude-ty">Result</span>&lt;StreamId, StreamIdOverflow&gt;,
<span class="doccomment">/// Any streams with a higher ID are ignored.
///
/// This starts as MAX, but is lowered when a GOAWAY is received.
///
/// &gt; After sending a GOAWAY frame, the sender can discard frames for
/// &gt; streams initiated by the receiver with identifiers higher than
/// &gt; the identified last stream.
</span>max_stream_id: StreamId,
<span class="doccomment">/// Initial window size of locally initiated streams
</span>init_window_sz: WindowSize,
<span class="doccomment">/// Prioritization layer
</span>prioritize: Prioritize,
is_push_enabled: bool,
<span class="doccomment">/// If extended connect protocol is enabled.
</span>is_extended_connect_protocol_enabled: bool,
}
<span class="doccomment">/// A value to detect which public API has called `poll_reset`.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>PollReset {
AwaitingHeaders,
Streaming,
}
<span class="kw">impl </span>Send {
<span class="doccomment">/// Create a new `Send`
</span><span class="kw">pub fn </span>new(config: <span class="kw-2">&amp;</span>Config) -&gt; <span class="self">Self </span>{
Send {
init_window_sz: config.remote_init_window_sz,
max_stream_id: StreamId::MAX,
next_stream_id: <span class="prelude-val">Ok</span>(config.local_next_stream_id),
prioritize: Prioritize::new(config),
is_push_enabled: <span class="bool-val">true</span>,
is_extended_connect_protocol_enabled: <span class="bool-val">false</span>,
}
}
<span class="doccomment">/// Returns the initial send window size
</span><span class="kw">pub fn </span>init_window_sz(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; WindowSize {
<span class="self">self</span>.init_window_sz
}
<span class="kw">pub fn </span>open(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;StreamId, UserError&gt; {
<span class="kw">let </span>stream_id = <span class="self">self</span>.ensure_next_stream_id()<span class="question-mark">?</span>;
<span class="self">self</span>.next_stream_id = stream_id.next_id();
<span class="prelude-val">Ok</span>(stream_id)
}
<span class="kw">pub fn </span>reserve_local(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;StreamId, UserError&gt; {
<span class="kw">let </span>stream_id = <span class="self">self</span>.ensure_next_stream_id()<span class="question-mark">?</span>;
<span class="self">self</span>.next_stream_id = stream_id.next_id();
<span class="prelude-val">Ok</span>(stream_id)
}
<span class="kw">fn </span>check_headers(fields: <span class="kw-2">&amp;</span>http::HeaderMap) -&gt; <span class="prelude-ty">Result</span>&lt;(), UserError&gt; {
<span class="comment">// 8.1.2.2. Connection-Specific Header Fields
</span><span class="kw">if </span>fields.contains_key(http::header::CONNECTION)
|| fields.contains_key(http::header::TRANSFER_ENCODING)
|| fields.contains_key(http::header::UPGRADE)
|| fields.contains_key(<span class="string">&quot;keep-alive&quot;</span>)
|| fields.contains_key(<span class="string">&quot;proxy-connection&quot;</span>)
{
<span class="macro">tracing::debug!</span>(<span class="string">&quot;illegal connection-specific headers found&quot;</span>);
<span class="kw">return </span><span class="prelude-val">Err</span>(UserError::MalformedHeaders);
} <span class="kw">else if let </span><span class="prelude-val">Some</span>(te) = fields.get(http::header::TE) {
<span class="kw">if </span>te != <span class="string">&quot;trailers&quot; </span>{
<span class="macro">tracing::debug!</span>(<span class="string">&quot;illegal connection-specific headers found&quot;</span>);
<span class="kw">return </span><span class="prelude-val">Err</span>(UserError::MalformedHeaders);
}
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub fn </span>send_push_promise&lt;B&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
frame: frame::PushPromise,
buffer: <span class="kw-2">&amp;mut </span>Buffer&lt;Frame&lt;B&gt;&gt;,
stream: <span class="kw-2">&amp;mut </span>store::Ptr,
task: <span class="kw-2">&amp;mut </span><span class="prelude-ty">Option</span>&lt;Waker&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), UserError&gt; {
<span class="kw">if </span>!<span class="self">self</span>.is_push_enabled {
<span class="kw">return </span><span class="prelude-val">Err</span>(UserError::PeerDisabledServerPush);
}
<span class="macro">tracing::trace!</span>(
<span class="string">&quot;send_push_promise; frame={:?}; init_window={:?}&quot;</span>,
frame,
<span class="self">self</span>.init_window_sz
);
<span class="self">Self</span>::check_headers(frame.fields())<span class="question-mark">?</span>;
<span class="comment">// Queue the frame for sending
</span><span class="self">self</span>.prioritize
.queue_frame(frame.into(), buffer, stream, task);
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub fn </span>send_headers&lt;B&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
frame: frame::Headers,
buffer: <span class="kw-2">&amp;mut </span>Buffer&lt;Frame&lt;B&gt;&gt;,
stream: <span class="kw-2">&amp;mut </span>store::Ptr,
counts: <span class="kw-2">&amp;mut </span>Counts,
task: <span class="kw-2">&amp;mut </span><span class="prelude-ty">Option</span>&lt;Waker&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), UserError&gt; {
<span class="macro">tracing::trace!</span>(
<span class="string">&quot;send_headers; frame={:?}; init_window={:?}&quot;</span>,
frame,
<span class="self">self</span>.init_window_sz
);
<span class="self">Self</span>::check_headers(frame.fields())<span class="question-mark">?</span>;
<span class="kw">let </span>end_stream = frame.is_end_stream();
<span class="comment">// Update the state
</span>stream.state.send_open(end_stream)<span class="question-mark">?</span>;
<span class="kw">if </span>counts.peer().is_local_init(frame.stream_id()) {
<span class="comment">// If we&#39;re waiting on a PushPromise anyway
// handle potentially queueing the stream at that point
</span><span class="kw">if </span>!stream.is_pending_push {
<span class="kw">if </span>counts.can_inc_num_send_streams() {
counts.inc_num_send_streams(stream);
} <span class="kw">else </span>{
<span class="self">self</span>.prioritize.queue_open(stream);
}
}
}
<span class="comment">// Queue the frame for sending
</span><span class="self">self</span>.prioritize
.queue_frame(frame.into(), buffer, stream, task);
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Send an explicit RST_STREAM frame
</span><span class="kw">pub fn </span>send_reset&lt;B&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
reason: Reason,
initiator: Initiator,
buffer: <span class="kw-2">&amp;mut </span>Buffer&lt;Frame&lt;B&gt;&gt;,
stream: <span class="kw-2">&amp;mut </span>store::Ptr,
counts: <span class="kw-2">&amp;mut </span>Counts,
task: <span class="kw-2">&amp;mut </span><span class="prelude-ty">Option</span>&lt;Waker&gt;,
) {
<span class="kw">let </span>is_reset = stream.state.is_reset();
<span class="kw">let </span>is_closed = stream.state.is_closed();
<span class="kw">let </span>is_empty = stream.pending_send.is_empty();
<span class="kw">let </span>stream_id = stream.id;
<span class="macro">tracing::trace!</span>(
<span class="string">&quot;send_reset(..., reason={:?}, initiator={:?}, stream={:?}, ..., \
is_reset={:?}; is_closed={:?}; pending_send.is_empty={:?}; \
state={:?} \
&quot;</span>,
reason,
initiator,
stream_id,
is_reset,
is_closed,
is_empty,
stream.state
);
<span class="kw">if </span>is_reset {
<span class="comment">// Don&#39;t double reset
</span><span class="macro">tracing::trace!</span>(
<span class="string">&quot; -&gt; not sending RST_STREAM ({:?} is already reset)&quot;</span>,
stream_id
);
<span class="kw">return</span>;
}
<span class="comment">// Transition the state to reset no matter what.
</span>stream.state.set_reset(stream_id, reason, initiator);
<span class="comment">// If closed AND the send queue is flushed, then the stream cannot be
// reset explicitly, either. Implicit resets can still be queued.
</span><span class="kw">if </span>is_closed &amp;&amp; is_empty {
<span class="macro">tracing::trace!</span>(
<span class="string">&quot; -&gt; not sending explicit RST_STREAM ({:?} was closed \
and send queue was flushed)&quot;</span>,
stream_id
);
<span class="kw">return</span>;
}
<span class="comment">// Clear all pending outbound frames.
// Note that we don&#39;t call `self.recv_err` because we want to enqueue
// the reset frame before transitioning the stream inside
// `reclaim_all_capacity`.
</span><span class="self">self</span>.prioritize.clear_queue(buffer, stream);
<span class="kw">let </span>frame = frame::Reset::new(stream.id, reason);
<span class="macro">tracing::trace!</span>(<span class="string">&quot;send_reset -- queueing; frame={:?}&quot;</span>, frame);
<span class="self">self</span>.prioritize
.queue_frame(frame.into(), buffer, stream, task);
<span class="self">self</span>.prioritize.reclaim_all_capacity(stream, counts);
}
<span class="kw">pub fn </span>schedule_implicit_reset(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
stream: <span class="kw-2">&amp;mut </span>store::Ptr,
reason: Reason,
counts: <span class="kw-2">&amp;mut </span>Counts,
task: <span class="kw-2">&amp;mut </span><span class="prelude-ty">Option</span>&lt;Waker&gt;,
) {
<span class="kw">if </span>stream.state.is_closed() {
<span class="comment">// Stream is already closed, nothing more to do
</span><span class="kw">return</span>;
}
stream.state.set_scheduled_reset(reason);
<span class="self">self</span>.prioritize.reclaim_reserved_capacity(stream, counts);
<span class="self">self</span>.prioritize.schedule_send(stream, task);
}
<span class="kw">pub fn </span>send_data&lt;B&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
frame: frame::Data&lt;B&gt;,
buffer: <span class="kw-2">&amp;mut </span>Buffer&lt;Frame&lt;B&gt;&gt;,
stream: <span class="kw-2">&amp;mut </span>store::Ptr,
counts: <span class="kw-2">&amp;mut </span>Counts,
task: <span class="kw-2">&amp;mut </span><span class="prelude-ty">Option</span>&lt;Waker&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), UserError&gt;
<span class="kw">where
</span>B: Buf,
{
<span class="self">self</span>.prioritize
.send_data(frame, buffer, stream, counts, task)
}
<span class="kw">pub fn </span>send_trailers&lt;B&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
frame: frame::Headers,
buffer: <span class="kw-2">&amp;mut </span>Buffer&lt;Frame&lt;B&gt;&gt;,
stream: <span class="kw-2">&amp;mut </span>store::Ptr,
counts: <span class="kw-2">&amp;mut </span>Counts,
task: <span class="kw-2">&amp;mut </span><span class="prelude-ty">Option</span>&lt;Waker&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), UserError&gt; {
<span class="comment">// TODO: Should this logic be moved into state.rs?
</span><span class="kw">if </span>!stream.state.is_send_streaming() {
<span class="kw">return </span><span class="prelude-val">Err</span>(UserError::UnexpectedFrameType);
}
stream.state.send_close();
<span class="macro">tracing::trace!</span>(<span class="string">&quot;send_trailers -- queuing; frame={:?}&quot;</span>, frame);
<span class="self">self</span>.prioritize
.queue_frame(frame.into(), buffer, stream, task);
<span class="comment">// Release any excess capacity
</span><span class="self">self</span>.prioritize.reserve_capacity(<span class="number">0</span>, stream, counts);
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub fn </span>poll_complete&lt;T, B&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
cx: <span class="kw-2">&amp;mut </span>Context,
buffer: <span class="kw-2">&amp;mut </span>Buffer&lt;Frame&lt;B&gt;&gt;,
store: <span class="kw-2">&amp;mut </span>Store,
counts: <span class="kw-2">&amp;mut </span>Counts,
dst: <span class="kw-2">&amp;mut </span>Codec&lt;T, Prioritized&lt;B&gt;&gt;,
) -&gt; Poll&lt;io::Result&lt;()&gt;&gt;
<span class="kw">where
</span>T: AsyncWrite + Unpin,
B: Buf,
{
<span class="self">self</span>.prioritize
.poll_complete(cx, buffer, store, counts, dst)
}
<span class="doccomment">/// Request capacity to send data
</span><span class="kw">pub fn </span>reserve_capacity(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
capacity: WindowSize,
stream: <span class="kw-2">&amp;mut </span>store::Ptr,
counts: <span class="kw-2">&amp;mut </span>Counts,
) {
<span class="self">self</span>.prioritize.reserve_capacity(capacity, stream, counts)
}
<span class="kw">pub fn </span>poll_capacity(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
cx: <span class="kw-2">&amp;</span>Context,
stream: <span class="kw-2">&amp;mut </span>store::Ptr,
) -&gt; Poll&lt;<span class="prelude-ty">Option</span>&lt;<span class="prelude-ty">Result</span>&lt;WindowSize, UserError&gt;&gt;&gt; {
<span class="kw">if </span>!stream.state.is_send_streaming() {
<span class="kw">return </span>Poll::Ready(<span class="prelude-val">None</span>);
}
<span class="kw">if </span>!stream.send_capacity_inc {
stream.wait_send(cx);
<span class="kw">return </span>Poll::Pending;
}
stream.send_capacity_inc = <span class="bool-val">false</span>;
Poll::Ready(<span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(<span class="self">self</span>.capacity(stream))))
}
<span class="doccomment">/// Current available stream send capacity
</span><span class="kw">pub fn </span>capacity(<span class="kw-2">&amp;</span><span class="self">self</span>, stream: <span class="kw-2">&amp;mut </span>store::Ptr) -&gt; WindowSize {
stream.capacity(<span class="self">self</span>.prioritize.max_buffer_size())
}
<span class="kw">pub fn </span>poll_reset(
<span class="kw-2">&amp;</span><span class="self">self</span>,
cx: <span class="kw-2">&amp;</span>Context,
stream: <span class="kw-2">&amp;mut </span>Stream,
mode: PollReset,
) -&gt; Poll&lt;<span class="prelude-ty">Result</span>&lt;Reason, <span class="kw">crate</span>::Error&gt;&gt; {
<span class="kw">match </span>stream.state.ensure_reason(mode)<span class="question-mark">? </span>{
<span class="prelude-val">Some</span>(reason) =&gt; Poll::Ready(<span class="prelude-val">Ok</span>(reason)),
<span class="prelude-val">None </span>=&gt; {
stream.wait_send(cx);
Poll::Pending
}
}
}
<span class="kw">pub fn </span>recv_connection_window_update(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
frame: frame::WindowUpdate,
store: <span class="kw-2">&amp;mut </span>Store,
counts: <span class="kw-2">&amp;mut </span>Counts,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), Reason&gt; {
<span class="self">self</span>.prioritize
.recv_connection_window_update(frame.size_increment(), store, counts)
}
<span class="kw">pub fn </span>recv_stream_window_update&lt;B&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
sz: WindowSize,
buffer: <span class="kw-2">&amp;mut </span>Buffer&lt;Frame&lt;B&gt;&gt;,
stream: <span class="kw-2">&amp;mut </span>store::Ptr,
counts: <span class="kw-2">&amp;mut </span>Counts,
task: <span class="kw-2">&amp;mut </span><span class="prelude-ty">Option</span>&lt;Waker&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), Reason&gt; {
<span class="kw">if let </span><span class="prelude-val">Err</span>(e) = <span class="self">self</span>.prioritize.recv_stream_window_update(sz, stream) {
<span class="macro">tracing::debug!</span>(<span class="string">&quot;recv_stream_window_update !!; err={:?}&quot;</span>, e);
<span class="self">self</span>.send_reset(
Reason::FLOW_CONTROL_ERROR,
Initiator::Library,
buffer,
stream,
counts,
task,
);
<span class="kw">return </span><span class="prelude-val">Err</span>(e);
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>recv_go_away(<span class="kw-2">&amp;mut </span><span class="self">self</span>, last_stream_id: StreamId) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="kw">if </span>last_stream_id &gt; <span class="self">self</span>.max_stream_id {
<span class="comment">// The remote endpoint sent a `GOAWAY` frame indicating a stream
// that we never sent, or that we have already terminated on account
// of previous `GOAWAY` frame. In either case, that is illegal.
// (When sending multiple `GOAWAY`s, &quot;Endpoints MUST NOT increase
// the value they send in the last stream identifier, since the
// peers might already have retried unprocessed requests on another
// connection.&quot;)
</span><span class="macro">proto_err!</span>(conn:
<span class="string">&quot;recv_go_away: last_stream_id ({:?}) &gt; max_stream_id ({:?})&quot;</span>,
last_stream_id, <span class="self">self</span>.max_stream_id,
);
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::library_go_away(Reason::PROTOCOL_ERROR));
}
<span class="self">self</span>.max_stream_id = last_stream_id;
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub fn </span>handle_error&lt;B&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
buffer: <span class="kw-2">&amp;mut </span>Buffer&lt;Frame&lt;B&gt;&gt;,
stream: <span class="kw-2">&amp;mut </span>store::Ptr,
counts: <span class="kw-2">&amp;mut </span>Counts,
) {
<span class="comment">// Clear all pending outbound frames
</span><span class="self">self</span>.prioritize.clear_queue(buffer, stream);
<span class="self">self</span>.prioritize.reclaim_all_capacity(stream, counts);
}
<span class="kw">pub fn </span>apply_remote_settings&lt;B&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
settings: <span class="kw-2">&amp;</span>frame::Settings,
buffer: <span class="kw-2">&amp;mut </span>Buffer&lt;Frame&lt;B&gt;&gt;,
store: <span class="kw-2">&amp;mut </span>Store,
counts: <span class="kw-2">&amp;mut </span>Counts,
task: <span class="kw-2">&amp;mut </span><span class="prelude-ty">Option</span>&lt;Waker&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(val) = settings.is_extended_connect_protocol_enabled() {
<span class="self">self</span>.is_extended_connect_protocol_enabled = val;
}
<span class="comment">// Applies an update to the remote endpoint&#39;s initial window size.
//
// Per RFC 7540 §6.9.2:
//
// In addition to changing the flow-control window for streams that are
// not yet active, a SETTINGS frame can alter the initial flow-control
// window size for streams with active flow-control windows (that is,
// streams in the &quot;open&quot; or &quot;half-closed (remote)&quot; state). When the
// value of SETTINGS_INITIAL_WINDOW_SIZE changes, a receiver MUST adjust
// the size of all stream flow-control windows that it maintains by the
// difference between the new value and the old value.
//
// A change to `SETTINGS_INITIAL_WINDOW_SIZE` can cause the available
// space in a flow-control window to become negative. A sender MUST
// track the negative flow-control window and MUST NOT send new
// flow-controlled frames until it receives WINDOW_UPDATE frames that
// cause the flow-control window to become positive.
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(val) = settings.initial_window_size() {
<span class="kw">let </span>old_val = <span class="self">self</span>.init_window_sz;
<span class="self">self</span>.init_window_sz = val;
<span class="kw">match </span>val.cmp(<span class="kw-2">&amp;</span>old_val) {
Ordering::Less =&gt; {
<span class="comment">// We must decrease the (remote) window on every open stream.
</span><span class="kw">let </span>dec = old_val - val;
<span class="macro">tracing::trace!</span>(<span class="string">&quot;decrementing all windows; dec={}&quot;</span>, dec);
<span class="kw">let </span><span class="kw-2">mut </span>total_reclaimed = <span class="number">0</span>;
store.for_each(|<span class="kw-2">mut </span>stream| {
<span class="kw">let </span>stream = <span class="kw-2">&amp;mut *</span>stream;
stream.send_flow.dec_send_window(dec);
<span class="comment">// It&#39;s possible that decreasing the window causes
// `window_size` (the stream-specific window) to fall below
// `available` (the portion of the connection-level window
// that we have allocated to the stream).
// In this case, we should take that excess allocation away
// and reassign it to other streams.
</span><span class="kw">let </span>window_size = stream.send_flow.window_size();
<span class="kw">let </span>available = stream.send_flow.available().as_size();
<span class="kw">let </span>reclaimed = <span class="kw">if </span>available &gt; window_size {
<span class="comment">// Drop down to `window_size`.
</span><span class="kw">let </span>reclaim = available - window_size;
stream.send_flow.claim_capacity(reclaim);
total_reclaimed += reclaim;
reclaim
} <span class="kw">else </span>{
<span class="number">0
</span>};
<span class="macro">tracing::trace!</span>(
<span class="string">&quot;decremented stream window; id={:?}; decr={}; reclaimed={}; flow={:?}&quot;</span>,
stream.id,
dec,
reclaimed,
stream.send_flow
);
<span class="comment">// TODO: Should this notify the producer when the capacity
// of a stream is reduced? Maybe it should if the capacity
// is reduced to zero, allowing the producer to stop work.
</span>});
<span class="self">self</span>.prioritize
.assign_connection_capacity(total_reclaimed, store, counts);
}
Ordering::Greater =&gt; {
<span class="kw">let </span>inc = val - old_val;
store.try_for_each(|<span class="kw-2">mut </span>stream| {
<span class="self">self</span>.recv_stream_window_update(inc, buffer, <span class="kw-2">&amp;mut </span>stream, counts, task)
.map_err(Error::library_go_away)
})<span class="question-mark">?</span>;
}
Ordering::Equal =&gt; (),
}
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(val) = settings.is_push_enabled() {
<span class="self">self</span>.is_push_enabled = val
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub fn </span>clear_queues(<span class="kw-2">&amp;mut </span><span class="self">self</span>, store: <span class="kw-2">&amp;mut </span>Store, counts: <span class="kw-2">&amp;mut </span>Counts) {
<span class="self">self</span>.prioritize.clear_pending_capacity(store, counts);
<span class="self">self</span>.prioritize.clear_pending_send(store, counts);
<span class="self">self</span>.prioritize.clear_pending_open(store, counts);
}
<span class="kw">pub fn </span>ensure_not_idle(<span class="kw-2">&amp;</span><span class="self">self</span>, id: StreamId) -&gt; <span class="prelude-ty">Result</span>&lt;(), Reason&gt; {
<span class="kw">if let </span><span class="prelude-val">Ok</span>(next) = <span class="self">self</span>.next_stream_id {
<span class="kw">if </span>id &gt;= next {
<span class="kw">return </span><span class="prelude-val">Err</span>(Reason::PROTOCOL_ERROR);
}
}
<span class="comment">// if next_stream_id is overflowed, that&#39;s ok.
</span><span class="prelude-val">Ok</span>(())
}
<span class="kw">pub fn </span>ensure_next_stream_id(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;StreamId, UserError&gt; {
<span class="self">self</span>.next_stream_id
.map_err(|<span class="kw">_</span>| UserError::OverflowedStreamId)
}
<span class="kw">pub fn </span>may_have_created_stream(<span class="kw-2">&amp;</span><span class="self">self</span>, id: StreamId) -&gt; bool {
<span class="kw">if let </span><span class="prelude-val">Ok</span>(next_id) = <span class="self">self</span>.next_stream_id {
<span class="comment">// Peer::is_local_init should have been called beforehand
</span><span class="macro">debug_assert_eq!</span>(id.is_server_initiated(), next_id.is_server_initiated(),);
id &lt; next_id
} <span class="kw">else </span>{
<span class="bool-val">true
</span>}
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>maybe_reset_next_stream_id(<span class="kw-2">&amp;mut </span><span class="self">self</span>, id: StreamId) {
<span class="kw">if let </span><span class="prelude-val">Ok</span>(next_id) = <span class="self">self</span>.next_stream_id {
<span class="comment">// Peer::is_local_init should have been called beforehand
</span><span class="macro">debug_assert_eq!</span>(id.is_server_initiated(), next_id.is_server_initiated());
<span class="kw">if </span>id &gt;= next_id {
<span class="self">self</span>.next_stream_id = id.next_id();
}
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>is_extended_connect_protocol_enabled(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.is_extended_connect_protocol_enabled
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="h2" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>