<!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 to the Rust file `/home/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/solicit-0.4.4/src/client/async.rs`."> <meta name="keywords" content="rust, rustlang, rust-lang"> <title>async.rs.html -- source</title> <link rel="stylesheet" type="text/css" href="../../../rustdoc.css"> <link rel="stylesheet" type="text/css" href="../../../main.css"> </head> <body class="rustdoc"> <!--[if lte IE 8]> <div class="warning"> This old browser is unsupported and will most likely display funky things. </div> <![endif]--> <nav class="sidebar"> </nav> <nav class="sub"> <form class="search-form js-only"> <div class="search-container"> <input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"> </div> </form> </nav> <section id='main' class="content source"><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> <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> <span id="565">565</span> <span id="566">566</span> <span id="567">567</span> <span id="568">568</span> <span id="569">569</span> <span id="570">570</span> <span id="571">571</span> <span id="572">572</span> <span id="573">573</span> <span id="574">574</span> <span id="575">575</span> <span id="576">576</span> <span id="577">577</span> <span id="578">578</span> <span id="579">579</span> <span id="580">580</span> <span id="581">581</span> <span id="582">582</span> <span id="583">583</span> <span id="584">584</span> <span id="585">585</span> <span id="586">586</span> <span id="587">587</span> <span id="588">588</span> <span id="589">589</span> <span id="590">590</span> <span id="591">591</span> <span id="592">592</span> <span id="593">593</span> <span id="594">594</span> <span id="595">595</span> <span id="596">596</span> <span id="597">597</span> <span id="598">598</span> <span id="599">599</span> <span id="600">600</span> <span id="601">601</span> <span id="602">602</span> <span id="603">603</span> <span id="604">604</span> <span id="605">605</span> <span id="606">606</span> <span id="607">607</span> <span id="608">608</span> <span id="609">609</span> <span id="610">610</span> <span id="611">611</span> <span id="612">612</span> <span id="613">613</span> <span id="614">614</span> <span id="615">615</span> <span id="616">616</span> <span id="617">617</span> <span id="618">618</span> <span id="619">619</span> <span id="620">620</span> <span id="621">621</span> <span id="622">622</span> <span id="623">623</span> <span id="624">624</span> <span id="625">625</span> <span id="626">626</span> <span id="627">627</span> <span id="628">628</span> <span id="629">629</span> <span id="630">630</span> <span id="631">631</span> <span id="632">632</span> <span id="633">633</span> <span id="634">634</span> <span id="635">635</span> <span id="636">636</span> <span id="637">637</span> <span id="638">638</span> <span id="639">639</span> <span id="640">640</span> <span id="641">641</span> <span id="642">642</span> <span id="643">643</span> <span id="644">644</span> <span id="645">645</span> <span id="646">646</span> <span id="647">647</span> <span id="648">648</span> <span id="649">649</span> <span id="650">650</span> <span id="651">651</span> <span id="652">652</span> <span id="653">653</span> <span id="654">654</span> <span id="655">655</span> <span id="656">656</span> <span id="657">657</span> <span id="658">658</span> <span id="659">659</span> <span id="660">660</span> <span id="661">661</span> <span id="662">662</span> <span id="663">663</span> <span id="664">664</span> <span id="665">665</span> <span id="666">666</span> <span id="667">667</span> <span id="668">668</span> <span id="669">669</span> <span id="670">670</span> <span id="671">671</span> <span id="672">672</span> <span id="673">673</span> <span id="674">674</span> <span id="675">675</span> <span id="676">676</span> <span id="677">677</span> <span id="678">678</span> <span id="679">679</span> <span id="680">680</span> <span id="681">681</span> <span id="682">682</span> <span id="683">683</span> <span id="684">684</span> <span id="685">685</span> <span id="686">686</span> <span id="687">687</span> <span id="688">688</span> <span id="689">689</span> <span id="690">690</span> <span id="691">691</span> <span id="692">692</span> <span id="693">693</span> <span id="694">694</span> <span id="695">695</span> <span id="696">696</span> <span id="697">697</span> <span id="698">698</span> <span id="699">699</span> <span id="700">700</span> <span id="701">701</span> <span id="702">702</span> <span id="703">703</span> <span id="704">704</span> <span id="705">705</span> <span id="706">706</span> <span id="707">707</span> <span id="708">708</span> <span id="709">709</span> <span id="710">710</span> <span id="711">711</span> <span id="712">712</span> <span id="713">713</span> <span id="714">714</span> <span id="715">715</span> <span id="716">716</span> <span id="717">717</span> </pre><pre class='rust '> <span class='doccomment'>//! Contains an implementation of an asynchronous client.</span> <span class='doccomment'>//!</span> <span class='doccomment'>//! It allows users to make requests to the same underlying connection from</span> <span class='doccomment'>//! different threads concurrently, as well as to receive the response</span> <span class='doccomment'>//! asynchronously.</span> <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashMap</span>; <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>sync</span>::<span class='ident'>mpsc</span>::{<span class='ident'>Sender</span>, <span class='ident'>Receiver</span>}; <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>sync</span>::<span class='ident'>mpsc</span>; <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>thread</span>; <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>io</span>; <span class='kw'>use</span> <span class='ident'>http</span>::{<span class='ident'>StreamId</span>, <span class='ident'>HttpError</span>, <span class='ident'>Response</span>, <span class='ident'>Header</span>, <span class='ident'>HttpResult</span>}; <span class='kw'>use</span> <span class='ident'>http</span>::<span class='ident'>frame</span>::<span class='ident'>RawFrame</span>; <span class='kw'>use</span> <span class='ident'>http</span>::<span class='ident'>transport</span>::<span class='ident'>TransportStream</span>; <span class='kw'>use</span> <span class='ident'>http</span>::<span class='ident'>connection</span>::{<span class='ident'>SendFrame</span>, <span class='ident'>ReceiveFrame</span>, <span class='ident'>HttpFrame</span>, <span class='ident'>HttpConnection</span>}; <span class='kw'>use</span> <span class='ident'>http</span>::<span class='ident'>session</span>::{<span class='ident'>SessionState</span>, <span class='ident'>DefaultSessionState</span>, <span class='ident'>DefaultStream</span>, <span class='ident'>Stream</span>}; <span class='kw'>use</span> <span class='ident'>http</span>::<span class='ident'>client</span>::{<span class='ident'>ClientConnection</span>, <span class='ident'>HttpConnect</span>, <span class='ident'>ClientStream</span>, <span class='ident'>RequestStream</span>}; <span class='doccomment'>/// A struct representing an asynchronously dispatched request. It is used</span> <span class='doccomment'>/// internally be the `ClientService` and `Client` structs.</span> <span class='kw'>struct</span> <span class='ident'>AsyncRequest</span> { <span class='doccomment'>/// The method of the request</span> <span class='kw'>pub</span> <span class='ident'>method</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>, <span class='doccomment'>/// The path being requested</span> <span class='kw'>pub</span> <span class='ident'>path</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>, <span class='doccomment'>/// Extra headers that should be included in the request. Does *not*</span> <span class='doccomment'>/// include meta-headers.</span> <span class='kw'>pub</span> <span class='ident'>headers</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>Header</span><span class='op'>></span>, <span class='doccomment'>/// The body of the request, if any.</span> <span class='kw'>pub</span> <span class='ident'>body</span>: <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>>></span>, <span class='doccomment'>/// The sender side of a channel where the response to this request should</span> <span class='doccomment'>/// be delivered.</span> <span class='ident'>tx</span>: <span class='ident'>Sender</span><span class='op'><</span><span class='ident'>Response</span><span class='op'>></span>, } <span class='doccomment'>/// A struct that buffers `RawFrame`s in an internal `mpsc` channel and sends them using the</span> <span class='doccomment'>/// wrapped `SendFrame` instance when the `send_next` method is called.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// Additionally, it provides a `ChannelFrameSenderHandle` instance that implements the `SendFrame`</span> <span class='doccomment'>/// trait and as such can be passed to the `HttpConnection`. This handler simply queues the frame</span> <span class='doccomment'>/// into the internal channel, without ever blocking.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// As such, this is a convenience struct that makes it possible to provide non-blocking writes</span> <span class='doccomment'>/// from within `HttpConnection`s, while handling the actual writes using a `SendFrame`</span> <span class='doccomment'>/// implementation that will block until the frame is sent on a separate thread.</span> <span class='kw'>struct</span> <span class='ident'>ChannelFrameSender</span><span class='op'><</span><span class='ident'>S</span><span class='op'>></span> <span class='kw'>where</span> <span class='ident'>S</span>: <span class='ident'>SendFrame</span> { <span class='doccomment'>/// The receiving end of the channel. Buffers the frames that are to be sent.</span> <span class='ident'>rx</span>: <span class='ident'>Receiver</span><span class='op'><</span><span class='ident'>RawFrame</span><span class='op'>></span>, <span class='doccomment'>/// The `SendFrame` instance that will perform the actual writes from within the `send_next`</span> <span class='doccomment'>/// method.</span> <span class='ident'>inner</span>: <span class='ident'>S</span>, } <span class='kw'>impl</span><span class='op'><</span><span class='ident'>S</span><span class='op'>></span> <span class='ident'>ChannelFrameSender</span><span class='op'><</span><span class='ident'>S</span><span class='op'>></span> <span class='kw'>where</span> <span class='ident'>S</span>: <span class='ident'>SendFrame</span> { <span class='doccomment'>/// Creates a new `ChannelFrameSender` that will use the provided `SendFrame` instance within</span> <span class='doccomment'>/// the `send_next` method in order to perform the final send to the remote peer.</span> <span class='doccomment'>/// The `ChannelFrameSenderHandle` that is returned can be used to queue frames for sending</span> <span class='doccomment'>/// from within `HttpConnection`s, as it implements the `SendFrame` trait.</span> <span class='kw'>fn</span> <span class='ident'>new</span>(<span class='ident'>inner</span>: <span class='ident'>S</span>) <span class='op'>-></span> (<span class='ident'>ChannelFrameSender</span><span class='op'><</span><span class='ident'>S</span><span class='op'>></span>, <span class='ident'>ChannelFrameSenderHandle</span>) { <span class='kw'>let</span> (<span class='ident'>send</span>, <span class='ident'>recv</span>) <span class='op'>=</span> <span class='ident'>mpsc</span>::<span class='ident'>channel</span>(); <span class='kw'>let</span> <span class='ident'>handle</span> <span class='op'>=</span> <span class='ident'>ChannelFrameSenderHandle</span> { <span class='ident'>tx</span>: <span class='ident'>send</span> }; <span class='kw'>let</span> <span class='ident'>sender</span> <span class='op'>=</span> <span class='ident'>ChannelFrameSender</span> { <span class='ident'>rx</span>: <span class='ident'>recv</span>, <span class='ident'>inner</span>: <span class='ident'>inner</span>, }; (<span class='ident'>sender</span>, <span class='ident'>handle</span>) } <span class='doccomment'>/// Performs the send of the next frame that is buffered in the internal channel of the struct.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// If there is no frame in the channel, it will block until there is one there.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// If the channel becomes disconnected from all senders, indicating that all handles to the</span> <span class='doccomment'>/// sender have been dropped, the mehod will return an error.</span> <span class='kw'>fn</span> <span class='ident'>send_next</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>HttpResult</span><span class='op'><</span>()<span class='op'>></span> { <span class='kw'>let</span> <span class='ident'>frame</span> <span class='op'>=</span> <span class='macro'>try</span><span class='macro'>!</span>( <span class='self'>self</span>.<span class='ident'>rx</span>.<span class='ident'>recv</span>() .<span class='ident'>map_err</span>(<span class='op'>|</span>_<span class='op'>|</span> { <span class='ident'>io</span>::<span class='ident'>Error</span>::<span class='ident'>new</span>(<span class='ident'>io</span>::<span class='ident'>ErrorKind</span>::<span class='ident'>Other</span>, <span class='string'>"Unable to send frame"</span>) }) ); <span class='macro'>debug</span><span class='macro'>!</span>(<span class='string'>"Performing the actual send frame IO"</span>); <span class='self'>self</span>.<span class='ident'>inner</span>.<span class='ident'>send_raw_frame</span>(<span class='ident'>frame</span>) } } <span class='doccomment'>/// A handle to the `ChannelFrameSender` and an implementation of the `SendFrame` trait. It simply</span> <span class='doccomment'>/// queues the given frames into the send queue of the `ChannelFrameSender` without ever blocking.</span> <span class='doccomment'>/// (Except possibly to allocate some memory, as per the `mpsc::channel` specification.)</span> <span class='kw'>struct</span> <span class='ident'>ChannelFrameSenderHandle</span> { <span class='doccomment'>/// The sender side of the channel that buffers the frames to be written. Allows the handle to</span> <span class='doccomment'>/// queue the frame for future writing without blocking on the IO.</span> <span class='ident'>tx</span>: <span class='ident'>Sender</span><span class='op'><</span><span class='ident'>RawFrame</span><span class='op'>></span>, } <span class='kw'>impl</span> <span class='ident'>SendFrame</span> <span class='kw'>for</span> <span class='ident'>ChannelFrameSenderHandle</span> { <span class='kw'>fn</span> <span class='ident'>send_raw_frame</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>frame</span>: <span class='ident'>RawFrame</span>) <span class='op'>-></span> <span class='ident'>HttpResult</span><span class='op'><</span>()<span class='op'>></span> { <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>tx</span>.<span class='ident'>send</span>(<span class='ident'>frame</span>) .<span class='ident'>map_err</span>(<span class='op'>|</span>_<span class='op'>|</span> { <span class='ident'>io</span>::<span class='ident'>Error</span>::<span class='ident'>new</span>(<span class='ident'>io</span>::<span class='ident'>ErrorKind</span>::<span class='ident'>Other</span>, <span class='string'>"Unable to send frame"</span>) })); <span class='macro'>debug</span><span class='macro'>!</span>(<span class='string'>"Queued the frame for sending..."</span>); <span class='prelude-val'>Ok</span>(()) } } <span class='doccomment'>/// A struct that buffers `HttpFrame`s read by the wrapped `ReceiveFrame` instance in an internal</span> <span class='doccomment'>/// `mpsc` channel. The reads from the wrapped `ReceiveFrame` instance are triggered by calls to</span> <span class='doccomment'>/// the `read_next` method.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// Additionally, it provides a `ChannelFrameReceiverHandle` instance that implements the</span> <span class='doccomment'>/// `ReceiveFrame` trait, such that it pops the next available frame from the internal channel.</span> <span class='doccomment'>/// If there are no available frames, it will block, so care must be taken to trigger the</span> <span class='doccomment'>/// connection's frame handling only when there are buffered frames, if it is not to block.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// As such, this is a convenience struct that makes it possible to provide non-blocking reads</span> <span class='doccomment'>/// from within `HttpConnection`s, while handling the actual reads using a `ReceiveFrame`</span> <span class='doccomment'>/// implementation that can block. (Predicated on triggering a single frame handle operation on</span> <span class='doccomment'>/// the connection for each successfully executed `read_next`.)</span> <span class='kw'>struct</span> <span class='ident'>ChannelFrameReceiver</span><span class='op'><</span><span class='ident'>R</span><span class='op'>></span> <span class='kw'>where</span> <span class='ident'>R</span>: <span class='ident'>ReceiveFrame</span> { <span class='doccomment'>/// The sender side of the channel. Buffers the frames read by the wrapped `ReceiveFrame`</span> <span class='doccomment'>/// instance for future consumation by the associated `ChannelFrameReceiverHandle`.</span> <span class='ident'>tx</span>: <span class='ident'>Sender</span><span class='op'><</span><span class='ident'>HttpFrame</span><span class='op'>></span>, <span class='doccomment'>/// The `ReceiveFrame` instance that performs the actual reading of the frame, used from within</span> <span class='doccomment'>/// the `read_next` method.</span> <span class='ident'>inner</span>: <span class='ident'>R</span>, } <span class='kw'>impl</span><span class='op'><</span><span class='ident'>R</span><span class='op'>></span> <span class='ident'>ChannelFrameReceiver</span><span class='op'><</span><span class='ident'>R</span><span class='op'>></span> <span class='kw'>where</span> <span class='ident'>R</span>: <span class='ident'>ReceiveFrame</span> { <span class='doccomment'>/// Creates a new `ChannelFrameReceiver`, as well as the associated</span> <span class='doccomment'>/// `ChannelFrameReceiverHandle`.</span> <span class='kw'>fn</span> <span class='ident'>new</span>(<span class='ident'>inner</span>: <span class='ident'>R</span>) <span class='op'>-></span> (<span class='ident'>ChannelFrameReceiver</span><span class='op'><</span><span class='ident'>R</span><span class='op'>></span>, <span class='ident'>ChannelFrameReceiverHandle</span>) { <span class='kw'>let</span> (<span class='ident'>send</span>, <span class='ident'>recv</span>) <span class='op'>=</span> <span class='ident'>mpsc</span>::<span class='ident'>channel</span>(); <span class='kw'>let</span> <span class='ident'>handle</span> <span class='op'>=</span> <span class='ident'>ChannelFrameReceiverHandle</span> { <span class='ident'>rx</span>: <span class='ident'>recv</span> }; <span class='kw'>let</span> <span class='ident'>receiver</span> <span class='op'>=</span> <span class='ident'>ChannelFrameReceiver</span> { <span class='ident'>tx</span>: <span class='ident'>send</span>, <span class='ident'>inner</span>: <span class='ident'>inner</span>, }; (<span class='ident'>receiver</span>, <span class='ident'>handle</span>) } <span class='doccomment'>/// Performs a `recv_frame` operation on the wrapped `ReceiveFrame` instance, possibly blocking</span> <span class='doccomment'>/// the thread in the process, depending on the implementation of the trait. Once a frame is</span> <span class='doccomment'>/// returned, it will buffer it within the internal channel.</span> <span class='kw'>fn</span> <span class='ident'>read_next</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>HttpResult</span><span class='op'><</span>()<span class='op'>></span> { <span class='kw'>let</span> <span class='ident'>frame</span> <span class='op'>=</span> <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>inner</span>.<span class='ident'>recv_frame</span>()); <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>tx</span>.<span class='ident'>send</span>(<span class='ident'>frame</span>) .<span class='ident'>map_err</span>(<span class='op'>|</span>_<span class='op'>|</span> { <span class='ident'>io</span>::<span class='ident'>Error</span>::<span class='ident'>new</span>(<span class='ident'>io</span>::<span class='ident'>ErrorKind</span>::<span class='ident'>Other</span>, <span class='string'>"Unable to read frame"</span>) })); <span class='prelude-val'>Ok</span>(()) } } <span class='doccomment'>/// A handle to the `ChannelFrameReceiver` and an implementation of the `ReceiveFrame` trait.</span> <span class='doccomment'>/// It simply pops the next frame from the internal channel that buffers the frames read by the</span> <span class='doccomment'>/// `ReceiveFrame` instance wrapped by the associated `ChannelFrameReceiver`. If there are no</span> <span class='doccomment'>/// frames currently buffered, it blocks until there is one. Therefore, the `handle_next_frame`</span> <span class='doccomment'>/// method of the `HttpConnection` that relies on the IO provided by this `ReceiveFrame`</span> <span class='doccomment'>/// implementation should be triggered only when sure that there are buffered frames, if blocking</span> <span class='doccomment'>/// handles are to be avoided.</span> <span class='kw'>struct</span> <span class='ident'>ChannelFrameReceiverHandle</span> { <span class='doccomment'>/// The receiver end of the channel that buffers the received frames.</span> <span class='ident'>rx</span>: <span class='ident'>Receiver</span><span class='op'><</span><span class='ident'>HttpFrame</span><span class='op'>></span>, } <span class='kw'>impl</span> <span class='ident'>ReceiveFrame</span> <span class='kw'>for</span> <span class='ident'>ChannelFrameReceiverHandle</span> { <span class='kw'>fn</span> <span class='ident'>recv_frame</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>HttpResult</span><span class='op'><</span><span class='ident'>HttpFrame</span><span class='op'>></span> { <span class='self'>self</span>.<span class='ident'>rx</span>.<span class='ident'>recv</span>() .<span class='ident'>map_err</span>(<span class='op'>|</span>_<span class='op'>|</span> { <span class='ident'>HttpError</span>::<span class='ident'>from</span>(<span class='ident'>io</span>::<span class='ident'>Error</span>::<span class='ident'>new</span>(<span class='ident'>io</span>::<span class='ident'>ErrorKind</span>::<span class='ident'>Other</span>, <span class='string'>"Unable to read frame"</span>)) }) } } <span class='doccomment'>/// An enum that represents errors that can be raised by the operation of a</span> <span class='doccomment'>/// `ClientService`.</span> <span class='kw'>enum</span> <span class='ident'>ClientServiceErr</span> { <span class='doccomment'>/// Corresponds to the case where the service has finished its operation.</span> <span class='ident'>Done</span>, <span class='doccomment'>/// Corresponds to the case where the service is unable to continue due to</span> <span class='doccomment'>/// an error that occurred on the underlying HTTP/2 connection.</span> <span class='ident'>Http</span>(<span class='ident'>HttpError</span>), } <span class='kw'>impl</span> <span class='ident'>From</span><span class='op'><</span><span class='ident'>HttpError</span><span class='op'>></span> <span class='kw'>for</span> <span class='ident'>ClientServiceErr</span> { <span class='kw'>fn</span> <span class='ident'>from</span>(<span class='ident'>err</span>: <span class='ident'>HttpError</span>) <span class='op'>-></span> <span class='ident'>ClientServiceErr</span> { <span class='ident'>ClientServiceErr</span>::<span class='ident'>Http</span>(<span class='ident'>err</span>) } } <span class='doccomment'>/// An enum representing the types of work that the `ClientService` can perform from within its</span> <span class='doccomment'>/// `run_once` method.</span> <span class='kw'>enum</span> <span class='ident'>WorkItem</span> { <span class='doccomment'>/// Queue a new request to the HTTP/2 connection.</span> <span class='ident'>Request</span>(<span class='ident'>AsyncRequest</span>), <span class='doccomment'>/// Trigger a new `handle_next_frame`. The work item should be queued only when there is a</span> <span class='doccomment'>/// frame to be handled to avoid blocking the `run_once` call.</span> <span class='ident'>HandleFrame</span>, <span class='doccomment'>/// Trigger a new `send_next_data` operation.</span> <span class='ident'>SendData</span>, <span class='doccomment'>/// Signals to the service that a new client is connected. Helps it keep track of whether there</span> <span class='doccomment'>/// are clients that would expect a response.</span> <span class='ident'>NewClient</span>, <span class='doccomment'>/// Signals to the service that a client has disconnected. Helps it keep track of whether there</span> <span class='doccomment'>/// are clients that would expect a response.</span> <span class='ident'>ClientLeft</span>, } <span class='doccomment'>/// An internal struct encapsulating a service that lets multiple clients</span> <span class='doccomment'>/// issue concurrent requests to the same HTTP/2 connection.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// The service maintains an internal queue of `WorkItem`s that indicate what the operations that</span> <span class='doccomment'>/// it should perform. The next operation from the queue is performed on each `run_once` method</span> <span class='doccomment'>/// call.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// It handles issuing new requests (corresponding to `WorkItem::Request` work item), handling the</span> <span class='doccomment'>/// next received frame (when indicated by the `WorkItem::HandleFrame`), and tracks the number of</span> <span class='doccomment'>/// connected clients (`run_once` returns an error once there are no more clients connected to the</span> <span class='doccomment'>/// service).</span> <span class='doccomment'>///</span> <span class='doccomment'>/// If there is no work in the queue, the `run_once` method blocks.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// Essentially, this represents a simplified event loop that handles events queued on the work</span> <span class='doccomment'>/// queue (blocking to wait for new work when none is available; does not spin). Therefore, the</span> <span class='doccomment'>/// user of the `ClientService` needs to provide a dedicated thread in which to run the `run_once`</span> <span class='doccomment'>/// event loop handler.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// Additionally, the client needs to make sure to perform the actual socket IO (which is fully</span> <span class='doccomment'>/// blocking, without even timeout support currently in Rust) in threads dedicated for that, by</span> <span class='doccomment'>/// calling the `send_next` or `read_next` methods of the `ChannelFrameSender` or</span> <span class='doccomment'>/// `ChannelFrameReceiver`, which are returned from the `ClientService` constructor.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// TODO: Technically, the `run_once` method could take a `WorkItem`, so a single event loop could</span> <span class='doccomment'>/// dispatch work items to a corresponding service, removing the need for the</span> <span class='doccomment'>/// thread-per-service requirement. However, at that point we're nearing a reimplementation</span> <span class='doccomment'>/// of a real event loop, which is slightly out of scope of the `solicit` library, as</span> <span class='doccomment'>/// imagined; the async client is (for now) supposed to be a proof-of-concept</span> <span class='doccomment'>/// implementation of a high-level async/concurrent HTTP/2 client.</span> <span class='kw'>struct</span> <span class='ident'>ClientService</span> { <span class='doccomment'>/// The ID that will be assigned to the next client-initiated stream.</span> <span class='ident'>next_stream_id</span>: <span class='ident'>StreamId</span>, <span class='doccomment'>/// The number of requests that have been sent, but are yet unanswered.</span> <span class='ident'>outstanding_reqs</span>: <span class='ident'>u32</span>, <span class='doccomment'>/// The limit to the number of requests that can be pending (unanswered,</span> <span class='doccomment'>/// but sent).</span> <span class='ident'>limit</span>: <span class='ident'>u32</span>, <span class='doccomment'>/// The connection that is used for underlying HTTP/2 communication.</span> <span class='ident'>conn</span>: <span class='ident'>ClientConnection</span><span class='op'><</span><span class='ident'>ChannelFrameSenderHandle</span>, <span class='ident'>ChannelFrameReceiverHandle</span><span class='op'>></span>, <span class='doccomment'>/// A mapping of stream IDs to the sender side of a channel that is</span> <span class='doccomment'>/// expecting a response to the request that is to arrive on that stream.</span> <span class='ident'>chans</span>: <span class='ident'>HashMap</span><span class='op'><</span><span class='ident'>StreamId</span>, <span class='ident'>Sender</span><span class='op'><</span><span class='ident'>Response</span><span class='op'>>></span>, <span class='doccomment'>/// The receiver end of a channel to which work items for the service are</span> <span class='doccomment'>/// queued. Work items include the variants of the `WorkItem` enum.</span> <span class='ident'>work_queue</span>: <span class='ident'>Receiver</span><span class='op'><</span><span class='ident'>WorkItem</span><span class='op'>></span>, <span class='doccomment'>/// The queue of `AsyncRequest`s that haven't yet been sent to the server.</span> <span class='ident'>request_queue</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>AsyncRequest</span><span class='op'>></span>, <span class='doccomment'>/// Tracks the number of currently connected clients -- once it reaches 0, the `run_once`</span> <span class='doccomment'>/// method returns an error.</span> <span class='ident'>client_count</span>: <span class='ident'>i32</span>, <span class='doccomment'>/// The name of the host the connection is established to.</span> <span class='ident'>host</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>, <span class='doccomment'>/// Whether the connection has already been initialized.</span> <span class='ident'>initialized</span>: <span class='ident'>bool</span>, } <span class='doccomment'>/// A helper wrapper around the components of the `ClientService` that are returned from its</span> <span class='doccomment'>/// constructor.</span> <span class='kw'>struct</span> <span class='ident'>Service</span><span class='op'><</span><span class='ident'>S</span><span class='op'>></span>( <span class='ident'>ClientService</span>, <span class='ident'>Sender</span><span class='op'><</span><span class='ident'>WorkItem</span><span class='op'>></span>, <span class='ident'>ChannelFrameReceiver</span><span class='op'><</span><span class='ident'>S</span><span class='op'>></span>, <span class='ident'>ChannelFrameSender</span><span class='op'><</span><span class='ident'>S</span><span class='op'>></span>) <span class='kw'>where</span> <span class='ident'>S</span>: <span class='ident'>TransportStream</span>; <span class='kw'>impl</span> <span class='ident'>ClientService</span> { <span class='doccomment'>/// Creates a new `ClientService` that will use the provided `ClientStream` for its underlying</span> <span class='doccomment'>/// network communication. A handle is returned for both the read, as well as the write end of</span> <span class='doccomment'>/// the socket that allows the client that creates the `ClientService` to perform the blocking</span> <span class='doccomment'>/// IO without influencing the `ClientService` (i.e. without having its `run_once` method</span> <span class='doccomment'>/// block).</span> <span class='doccomment'>///</span> <span class='doccomment'>/// # Returns</span> <span class='doccomment'>///</span> <span class='doccomment'>/// Returns all the relevant components of the newly created `ClientService`:</span> <span class='doccomment'>///</span> <span class='doccomment'>/// - The `ClientService` itself -- processes events (`WorkItem`s) on each `run_once` call.</span> <span class='doccomment'>/// - The sender-side of the work queue -- allows `WorkItem`s to be queued into the</span> <span class='doccomment'>/// `ClientService`'s simplified event loop.</span> <span class='doccomment'>/// - The `ChannelFrameReceiver` -- the instance that wraps the actual socket that performs</span> <span class='doccomment'>/// the blocking read IO. Allows the caller to block on the IO in a customized manner (e.g.</span> <span class='doccomment'>/// in a separate dedicated thread).</span> <span class='doccomment'>/// - The `ChannelFrameSender` -- the instance that wraps the actual socket that performs the</span> <span class='doccomment'>/// blocking write IO. Allows the caller to block on the IO in a customized manner (e.g. in</span> <span class='doccomment'>/// a separate thread).</span> <span class='doccomment'>///</span> <span class='doccomment'>/// If no HTTP/2 connection can be established to the given host on the</span> <span class='doccomment'>/// given port, returns `None`.</span> <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span><span class='op'><</span><span class='ident'>S</span><span class='op'>></span>(<span class='ident'>client_stream</span>: <span class='ident'>ClientStream</span><span class='op'><</span><span class='ident'>S</span><span class='op'>></span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>Service</span><span class='op'><</span><span class='ident'>S</span><span class='op'>>></span> <span class='kw'>where</span> <span class='ident'>S</span>: <span class='ident'>TransportStream</span> { <span class='kw'>let</span> (<span class='ident'>tx</span>, <span class='ident'>rx</span>): (<span class='ident'>Sender</span><span class='op'><</span><span class='ident'>WorkItem</span><span class='op'>></span>, <span class='ident'>Receiver</span><span class='op'><</span><span class='ident'>WorkItem</span><span class='op'>></span>) <span class='op'>=</span> <span class='ident'>mpsc</span>::<span class='ident'>channel</span>(); <span class='kw'>let</span> <span class='ident'>ClientStream</span>(<span class='ident'>stream</span>, <span class='ident'>scheme</span>, <span class='ident'>host</span>) <span class='op'>=</span> <span class='ident'>client_stream</span>; <span class='comment'>// Manually split the stream into the write/read ends, so that we can...</span> <span class='kw'>let</span> <span class='ident'>sender</span> <span class='op'>=</span> <span class='ident'>stream</span>.<span class='ident'>try_split</span>().<span class='ident'>unwrap</span>(); <span class='kw'>let</span> <span class='ident'>receiver</span> <span class='op'>=</span> <span class='ident'>stream</span>; <span class='comment'>// ...wrap them into the adapters...</span> <span class='kw'>let</span> (<span class='ident'>recv_frame</span>, <span class='ident'>recv_handle</span>) <span class='op'>=</span> <span class='ident'>ChannelFrameReceiver</span>::<span class='ident'>new</span>(<span class='ident'>receiver</span>); <span class='kw'>let</span> (<span class='ident'>send_frame</span>, <span class='ident'>send_handle</span>) <span class='op'>=</span> <span class='ident'>ChannelFrameSender</span>::<span class='ident'>new</span>(<span class='ident'>sender</span>); <span class='comment'>// ...and pass the non-blocking/buffering ends into the `HttpConnect` instead of the</span> <span class='comment'>// blocking socket itself.</span> <span class='kw'>let</span> <span class='ident'>conn</span> <span class='op'>=</span> <span class='ident'>ClientConnection</span>::<span class='ident'>with_connection</span>( <span class='ident'>HttpConnection</span>::<span class='ident'>new</span>( <span class='ident'>send_handle</span>, <span class='ident'>recv_handle</span>, <span class='ident'>scheme</span>), <span class='ident'>DefaultSessionState</span>::<span class='ident'>new</span>()); <span class='kw'>let</span> <span class='ident'>service</span> <span class='op'>=</span> <span class='ident'>ClientService</span> { <span class='ident'>next_stream_id</span>: <span class='number'>1</span>, <span class='ident'>outstanding_reqs</span>: <span class='number'>0</span>, <span class='ident'>limit</span>: <span class='number'>3</span>, <span class='ident'>conn</span>: <span class='ident'>conn</span>, <span class='ident'>chans</span>: <span class='ident'>HashMap</span>::<span class='ident'>new</span>(), <span class='ident'>work_queue</span>: <span class='ident'>rx</span>, <span class='ident'>request_queue</span>: <span class='ident'>Vec</span>::<span class='ident'>new</span>(), <span class='ident'>client_count</span>: <span class='number'>0</span>, <span class='ident'>host</span>: <span class='ident'>host</span>.<span class='ident'>as_bytes</span>().<span class='ident'>to_vec</span>(), <span class='ident'>initialized</span>: <span class='bool-val'>false</span>, }; <span class='comment'>// Returns the handles to the channel sender/receiver, so that the client can use them to</span> <span class='comment'>// perform the real IO somewhere.</span> <span class='prelude-val'>Some</span>(<span class='ident'>Service</span>(<span class='ident'>service</span>, <span class='ident'>tx</span>, <span class='ident'>recv_frame</span>, <span class='ident'>send_frame</span>)) } <span class='doccomment'>/// Performs one iteration of the service.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// One iteration corresponds to running the next `WorkItem` that the service</span> <span class='doccomment'>/// has queued in its `work_queue`. Essentially, this is a poor-man's event</span> <span class='doccomment'>/// loop implementation. If there is no work queued for the service, it will</span> <span class='doccomment'>/// *block*, until there is. As such, embedding calls to this method into a</span> <span class='doccomment'>/// real event loop should not be done.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// For `WorkItem::Request` work items, the service will queue the received</span> <span class='doccomment'>/// `AsyncRequest` for sending. It will also attempt to queue it for</span> <span class='doccomment'>/// transmission to the server, unless the concurrent requests limit has been</span> <span class='doccomment'>/// exceeded, in which case the request is kept in an internal FIFO queue and</span> <span class='doccomment'>/// will be sent when its time comes.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// For `WorkItem::HandleFrame` work items, the service will perform a single</span> <span class='doccomment'>/// `handle_next_frame` call on its underlying `ClientConnection` instance.</span> <span class='doccomment'>/// Since the item is queued only when the connection actually has frames to</span> <span class='doccomment'>/// process, this call will never block. If a response got finalized by the</span> <span class='doccomment'>/// handling of the frame, it is shipped to the channel that expects it and</span> <span class='doccomment'>/// a new request from the request queue sent.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// # Returns</span> <span class='doccomment'>///</span> <span class='doccomment'>/// On a successful pass, the function returns an `Ok(())`.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// The `Err` response is returned when there are no more responses to be</span> <span class='doccomment'>/// received and there are no more clients connected to the service (and</span> <span class='doccomment'>/// thus no more requests could ever be issued by the instance). This</span> <span class='doccomment'>/// corresponds to the `ClientServiceErr::Done` variant.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// Any HTTP/2 error is propagated (wrapped into a ClientServiceErr::Http</span> <span class='doccomment'>/// variant).</span> <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>run_once</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span>(), <span class='ident'>ClientServiceErr</span><span class='op'>></span> { <span class='kw'>let</span> <span class='ident'>work_item</span> <span class='op'>=</span> <span class='kw'>match</span> <span class='self'>self</span>.<span class='ident'>work_queue</span>.<span class='ident'>recv</span>() { <span class='prelude-val'>Ok</span>(<span class='ident'>item</span>) <span class='op'>=></span> <span class='ident'>item</span>, <span class='comment'>// The receive operation can only fail if the sender has</span> <span class='comment'>// disconnected implying no further receives are possible.</span> <span class='comment'>// At that point, we make sure to gracefully stop the service.</span> <span class='prelude-val'>Err</span>(_) <span class='op'>=></span> <span class='kw'>return</span> <span class='prelude-val'>Err</span>(<span class='ident'>ClientServiceErr</span>::<span class='ident'>Done</span>), }; <span class='comment'>// Dispatch the work to the corresponding method...</span> <span class='kw'>match</span> <span class='ident'>work_item</span> { <span class='ident'>WorkItem</span>::<span class='ident'>Request</span>(<span class='ident'>async_req</span>) <span class='op'>=></span> { <span class='macro'>debug</span><span class='macro'>!</span>(<span class='string'>"Queuing request"</span>); <span class='self'>self</span>.<span class='ident'>request_queue</span>.<span class='ident'>push</span>(<span class='ident'>async_req</span>); <span class='self'>self</span>.<span class='ident'>queue_next_request</span>(); <span class='prelude-val'>Ok</span>(()) }, <span class='ident'>WorkItem</span>::<span class='ident'>HandleFrame</span> <span class='op'>=></span> { <span class='kw'>if</span> <span class='op'>!</span><span class='self'>self</span>.<span class='ident'>initialized</span> { <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>conn</span>.<span class='ident'>init</span>()); <span class='self'>self</span>.<span class='ident'>initialized</span> <span class='op'>=</span> <span class='bool-val'>true</span>; <span class='prelude-val'>Ok</span>(()) } <span class='kw'>else</span> { <span class='self'>self</span>.<span class='ident'>handle_frame</span>() } }, <span class='ident'>WorkItem</span>::<span class='ident'>SendData</span> <span class='op'>=></span> { <span class='macro'>debug</span><span class='macro'>!</span>(<span class='string'>"Will queue some request data"</span>); <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>conn</span>.<span class='ident'>send_next_data</span>()); <span class='prelude-val'>Ok</span>(()) } <span class='ident'>WorkItem</span>::<span class='ident'>NewClient</span> <span class='op'>=></span> { <span class='self'>self</span>.<span class='ident'>client_count</span> <span class='op'>+=</span> <span class='number'>1</span>; <span class='prelude-val'>Ok</span>(()) }, <span class='ident'>WorkItem</span>::<span class='ident'>ClientLeft</span> <span class='op'>=></span> { <span class='self'>self</span>.<span class='ident'>client_count</span> <span class='op'>-=</span> <span class='number'>1</span>; <span class='kw'>if</span> <span class='self'>self</span>.<span class='ident'>client_count</span> <span class='op'>==</span> <span class='number'>0</span> { <span class='prelude-val'>Err</span>(<span class='ident'>ClientServiceErr</span>::<span class='ident'>Done</span>) } <span class='kw'>else</span> { <span class='prelude-val'>Ok</span>(()) } } } } <span class='doccomment'>/// A private convenience method that performs the handling of the next received frame.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// It calls the underlying connection's `handle_next_frame` method and then inspects the</span> <span class='doccomment'>/// changes made to the session, notifying clients of completed requests or queueing new ones,</span> <span class='doccomment'>/// if available.</span> <span class='kw'>fn</span> <span class='ident'>handle_frame</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span>(), <span class='ident'>ClientServiceErr</span><span class='op'>></span> { <span class='comment'>// Handles the next frame...</span> <span class='macro'>debug</span><span class='macro'>!</span>(<span class='string'>"Handling next frame"</span>); <span class='macro'>try</span><span class='macro'>!</span>(<span class='self'>self</span>.<span class='ident'>conn</span>.<span class='ident'>handle_next_frame</span>()); <span class='comment'>// ...and then any connections that may have been closed in the meantime</span> <span class='comment'>// are converted to responses and notifications sent to appropriate</span> <span class='comment'>// channels.</span> <span class='self'>self</span>.<span class='ident'>handle_closed</span>(); <span class='comment'>// At this point we try to queue another outstanding request (if the</span> <span class='comment'>// limit has not been reached).</span> <span class='self'>self</span>.<span class='ident'>queue_next_request</span>(); <span class='prelude-val'>Ok</span>(()) } <span class='doccomment'>/// Internal helper method. Sends a request to the server based on the</span> <span class='doccomment'>/// parameters given in the `AsyncRequest`. It blocks until the request is</span> <span class='doccomment'>/// fully transmitted to the server.</span> <span class='kw'>fn</span> <span class='ident'>send_request</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>async_req</span>: <span class='ident'>AsyncRequest</span>) { <span class='kw'>let</span> (<span class='ident'>req</span>, <span class='ident'>tx</span>) <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>create_request</span>(<span class='ident'>async_req</span>); <span class='macro'>debug</span><span class='macro'>!</span>(<span class='string'>"Sending new request... id = {}"</span>, <span class='ident'>req</span>.<span class='ident'>stream</span>.<span class='ident'>id</span>()); <span class='self'>self</span>.<span class='ident'>chans</span>.<span class='ident'>insert</span>(<span class='ident'>req</span>.<span class='ident'>stream</span>.<span class='ident'>id</span>(), <span class='ident'>tx</span>); <span class='self'>self</span>.<span class='ident'>conn</span>.<span class='ident'>start_request</span>(<span class='ident'>req</span>).<span class='ident'>ok</span>().<span class='ident'>unwrap</span>(); <span class='self'>self</span>.<span class='ident'>outstanding_reqs</span> <span class='op'>+=</span> <span class='number'>1</span>; } <span class='doccomment'>/// Internal helper method. Creates a new `RequestStream` instance based on the</span> <span class='doccomment'>/// given parameters. Such a `RequestStream` instance is ready to be passed to</span> <span class='doccomment'>/// the connection for transmission to the server (i.e. `start_request`).</span> <span class='doccomment'>/// Also returns the sender end of the channel to which the response is to be transmitted,</span> <span class='doccomment'>/// once received.</span> <span class='kw'>fn</span> <span class='ident'>create_request</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>async_req</span>: <span class='ident'>AsyncRequest</span>) <span class='op'>-></span> (<span class='ident'>RequestStream</span><span class='op'><</span><span class='ident'>DefaultStream</span><span class='op'>></span>, <span class='ident'>Sender</span><span class='op'><</span><span class='ident'>Response</span><span class='op'>></span>) { <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>headers</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>Header</span><span class='op'>></span> <span class='op'>=</span> <span class='ident'>Vec</span>::<span class='ident'>new</span>(); <span class='ident'>headers</span>.<span class='ident'>extend</span>(<span class='macro'>vec</span><span class='macro'>!</span>[ (<span class='string'>b":method"</span>.<span class='ident'>to_vec</span>(), <span class='ident'>async_req</span>.<span class='ident'>method</span>), (<span class='string'>b":path"</span>.<span class='ident'>to_vec</span>(), <span class='ident'>async_req</span>.<span class='ident'>path</span>), (<span class='string'>b":authority"</span>.<span class='ident'>to_vec</span>(), <span class='self'>self</span>.<span class='ident'>host</span>.<span class='ident'>clone</span>()), (<span class='string'>b":scheme"</span>.<span class='ident'>to_vec</span>(), <span class='self'>self</span>.<span class='ident'>conn</span>.<span class='ident'>scheme</span>().<span class='ident'>as_bytes</span>().<span class='ident'>to_vec</span>()), ].<span class='ident'>into_iter</span>()); <span class='ident'>headers</span>.<span class='ident'>extend</span>(<span class='ident'>async_req</span>.<span class='ident'>headers</span>.<span class='ident'>into_iter</span>()); <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>stream</span> <span class='op'>=</span> <span class='ident'>DefaultStream</span>::<span class='ident'>new</span>(<span class='self'>self</span>.<span class='ident'>next_stream_id</span>); <span class='self'>self</span>.<span class='ident'>next_stream_id</span> <span class='op'>+=</span> <span class='number'>2</span>; <span class='kw'>match</span> <span class='ident'>async_req</span>.<span class='ident'>body</span> { <span class='prelude-val'>Some</span>(<span class='ident'>body</span>) <span class='op'>=></span> <span class='ident'>stream</span>.<span class='ident'>set_full_data</span>(<span class='ident'>body</span>), <span class='prelude-val'>None</span> <span class='op'>=></span> <span class='ident'>stream</span>.<span class='ident'>close_local</span>(), }; ( <span class='ident'>RequestStream</span> { <span class='ident'>stream</span>: <span class='ident'>stream</span>, <span class='ident'>headers</span>: <span class='ident'>headers</span>, }, <span class='ident'>async_req</span>.<span class='ident'>tx</span> ) } <span class='doccomment'>/// Internal helper method. Sends a response assembled from the given</span> <span class='doccomment'>/// stream to the corresponding channel that is waiting for the response.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// The given `stream` instance is consumed by this method.</span> <span class='kw'>fn</span> <span class='ident'>send_response</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>stream</span>: <span class='ident'>DefaultStream</span>) { <span class='kw'>match</span> <span class='self'>self</span>.<span class='ident'>chans</span>.<span class='ident'>remove</span>(<span class='kw-2'>&</span><span class='ident'>stream</span>.<span class='ident'>stream_id</span>) { <span class='prelude-val'>None</span> <span class='op'>=></span> { <span class='comment'>// This should never happen, it means the session gave us</span> <span class='comment'>// a response that we didn't request.</span> <span class='macro'>panic</span><span class='macro'>!</span>(<span class='string'>"Received a response for an unknown request!"</span>); }, <span class='prelude-val'>Some</span>(<span class='ident'>tx</span>) <span class='op'>=></span> { <span class='kw'>let</span> _ <span class='op'>=</span> <span class='ident'>tx</span>.<span class='ident'>send</span>(<span class='ident'>Response</span> { <span class='ident'>stream_id</span>: <span class='ident'>stream</span>.<span class='ident'>stream_id</span>, <span class='ident'>headers</span>: <span class='ident'>stream</span>.<span class='ident'>headers</span>.<span class='ident'>unwrap</span>(), <span class='ident'>body</span>: <span class='ident'>stream</span>.<span class='ident'>body</span>, }); } }; } <span class='doccomment'>/// Internal helper method. Handles all closed streams by sending appropriate</span> <span class='doccomment'>/// notifications to waiting channels.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// For now, the channels are all given a `Response`, even though the</span> <span class='doccomment'>/// stream might end up being closed by the server with an error.</span> <span class='kw'>fn</span> <span class='ident'>handle_closed</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) { <span class='kw'>let</span> <span class='ident'>done</span> <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>conn</span>.<span class='ident'>state</span>.<span class='ident'>get_closed</span>(); <span class='kw'>for</span> <span class='ident'>stream</span> <span class='kw'>in</span> <span class='ident'>done</span> { <span class='self'>self</span>.<span class='ident'>send_response</span>(<span class='ident'>stream</span>); <span class='self'>self</span>.<span class='ident'>outstanding_reqs</span> <span class='op'>-=</span> <span class='number'>1</span>; } } <span class='doccomment'>/// Internal helper method. If there are yet unsent requests queued by a</span> <span class='doccomment'>/// client to the service and the service has not exceeded the limit of</span> <span class='doccomment'>/// concurrent requests that it is allowed to issue, it sends a single</span> <span class='doccomment'>/// new request to the server. Blocks until this request is sent.</span> <span class='kw'>fn</span> <span class='ident'>queue_next_request</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) { <span class='kw'>if</span> <span class='self'>self</span>.<span class='ident'>outstanding_reqs</span> <span class='op'><</span> <span class='self'>self</span>.<span class='ident'>limit</span> { <span class='comment'>// Try to queue another request since we haven't gone over</span> <span class='comment'>// the (arbitrary) limit.</span> <span class='macro'>debug</span><span class='macro'>!</span>(<span class='string'>"Not over the limit yet. Checking for more requests..."</span>); <span class='kw'>if</span> <span class='self'>self</span>.<span class='ident'>request_queue</span>.<span class='ident'>len</span>() <span class='op'>></span> <span class='number'>0</span> { <span class='kw'>let</span> <span class='ident'>async_req</span> <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>request_queue</span>.<span class='ident'>remove</span>(<span class='number'>0</span>); <span class='self'>self</span>.<span class='ident'>send_request</span>(<span class='ident'>async_req</span>); } } } } <span class='doccomment'>/// A struct representing an HTTP/2 client that receives responses to its</span> <span class='doccomment'>/// requests asynchronously. Additionally, this client can be cloned and all</span> <span class='doccomment'>/// clones can issue (concurrently) requests to the server, using the same</span> <span class='doccomment'>/// underlying HTTP/2 connection.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// # Example</span> <span class='doccomment'>///</span> <span class='doccomment'>/// ```no_run</span> <span class='doccomment'>/// use solicit::client::Client;</span> <span class='doccomment'>/// use solicit::http::client::CleartextConnector;</span> <span class='doccomment'>/// use std::thread;</span> <span class='doccomment'>/// use std::str;</span> <span class='doccomment'>///</span> <span class='doccomment'>/// // Connect to a server that supports HTTP/2</span> <span class='doccomment'>/// let connector = CleartextConnector::new("http2bin.org");</span> <span class='doccomment'>/// let client = Client::with_connector(connector).unwrap();</span> <span class='doccomment'>///</span> <span class='doccomment'>/// // Issue 5 requests from 5 different threads concurrently and wait for all</span> <span class='doccomment'>/// // threads to receive their response.</span> <span class='doccomment'>/// let threads: Vec<_> = (0..5).map(|i| {</span> <span class='doccomment'>/// let this = client.clone();</span> <span class='doccomment'>/// thread::spawn(move || {</span> <span class='doccomment'>/// let resp = this.get(b"/", &[]).unwrap();</span> <span class='doccomment'>/// let response = resp.recv().unwrap();</span> <span class='doccomment'>/// println!("Thread {} got response ... {}", i, response.status_code().ok().unwrap());</span> <span class='doccomment'>/// println!("The response contains the following headers:");</span> <span class='doccomment'>/// for header in response.headers.iter() {</span> <span class='doccomment'>/// println!(" {}: {}",</span> <span class='doccomment'>/// str::from_utf8(&header.0).unwrap(),</span> <span class='doccomment'>/// str::from_utf8(&header.1).unwrap());</span> <span class='doccomment'>/// }</span> <span class='doccomment'>/// })</span> <span class='doccomment'>/// }).collect();</span> <span class='doccomment'>///</span> <span class='doccomment'>/// let _: Vec<_> = threads.into_iter().map(|thread| thread.join()).collect();</span> <span class='doccomment'>/// ```</span> <span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>Client</span> { <span class='doccomment'>/// The sender side of a channel on which a running `ClientService` expects</span> <span class='doccomment'>/// to receive new requests, which are to be sent to the server.</span> <span class='ident'>sender</span>: <span class='ident'>Sender</span><span class='op'><</span><span class='ident'>WorkItem</span><span class='op'>></span>, } <span class='kw'>impl</span> <span class='ident'>Clone</span> <span class='kw'>for</span> <span class='ident'>Client</span> { <span class='kw'>fn</span> <span class='ident'>clone</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Client</span> { <span class='self'>self</span>.<span class='ident'>sender</span>.<span class='ident'>send</span>(<span class='ident'>WorkItem</span>::<span class='ident'>NewClient</span>).<span class='ident'>unwrap</span>(); <span class='ident'>Client</span> { <span class='ident'>sender</span>: <span class='self'>self</span>.<span class='ident'>sender</span>.<span class='ident'>clone</span>(), } } } <span class='kw'>impl</span> <span class='ident'>Drop</span> <span class='kw'>for</span> <span class='ident'>Client</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='kw'>let</span> _ <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>sender</span>.<span class='ident'>send</span>(<span class='ident'>WorkItem</span>::<span class='ident'>ClientLeft</span>); } } <span class='kw'>impl</span> <span class='ident'>Client</span> { <span class='doccomment'>/// Creates a brand new HTTP/2 client. This means that a new HTTP/2</span> <span class='doccomment'>/// connection will be established behind the scenes. A thread is spawned</span> <span class='doccomment'>/// to handle the connection in the background, so that the thread that</span> <span class='doccomment'>/// creates the client can use it asynchronously.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// # Returns</span> <span class='doccomment'>///</span> <span class='doccomment'>/// A `Client` instance that allows access to the underlying HTTP/2</span> <span class='doccomment'>/// connection on the application level. Only full requests and responses</span> <span class='doccomment'>/// are exposed to users.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// The returned `Client` can be cloned and all clones will use the same</span> <span class='doccomment'>/// underlying HTTP/2 connection. Once all cloned instances (as well as the</span> <span class='doccomment'>/// original one) are dropped, the thread that was spawned will also exit</span> <span class='doccomment'>/// gracefully. Any error on the underlying HTTP/2 connection also causes</span> <span class='doccomment'>/// the thread to exit.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// If the HTTP/2 connection cannot be initialized returns `None`.</span> <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>with_connector</span><span class='op'><</span><span class='ident'>C</span>, <span class='ident'>S</span><span class='op'>></span>(<span class='ident'>connector</span>: <span class='ident'>C</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>Client</span><span class='op'>></span> <span class='kw'>where</span> <span class='ident'>C</span>: <span class='ident'>HttpConnect</span><span class='op'><</span><span class='ident'>Stream</span><span class='op'>=</span><span class='ident'>S</span><span class='op'>></span>, <span class='ident'>S</span>: <span class='ident'>TransportStream</span> <span class='op'>+</span> <span class='ident'>Send</span> <span class='op'>+</span> <span class='lifetime'>'static</span> { <span class='comment'>// Use the provided connector to establish a network connection...</span> <span class='kw'>let</span> <span class='ident'>client_stream</span> <span class='op'>=</span> <span class='ident'>connector</span>.<span class='ident'>connect</span>().<span class='ident'>ok</span>().<span class='ident'>unwrap</span>(); <span class='comment'>// Keep a socket handle in order to shut it down once the service stops. This is required</span> <span class='comment'>// because if the service decides to stop (due to all clients disconnecting) while the</span> <span class='comment'>// socket is still open and the read thread waiting, it can happen that the read thread</span> <span class='comment'>// (and as such the socket itself) ends up waiting indefinitely (or well, until the server</span> <span class='comment'>// decides to close it), effectively leaking the socket and thread.</span> <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>sck</span> <span class='op'>=</span> <span class='ident'>client_stream</span>.<span class='number'>0</span>.<span class='ident'>try_split</span>().<span class='ident'>unwrap</span>(); <span class='kw'>let</span> <span class='ident'>service</span> <span class='op'>=</span> <span class='kw'>match</span> <span class='ident'>ClientService</span>::<span class='ident'>new</span>(<span class='ident'>client_stream</span>) { <span class='prelude-val'>Some</span>(<span class='ident'>service</span>) <span class='op'>=></span> <span class='ident'>service</span>, <span class='prelude-val'>None</span> <span class='op'>=></span> <span class='kw'>return</span> <span class='prelude-val'>None</span>, }; <span class='kw'>let</span> <span class='ident'>Service</span>(<span class='kw-2'>mut</span> <span class='ident'>service</span>, <span class='ident'>rx</span>, <span class='kw-2'>mut</span> <span class='ident'>recv_frame</span>, <span class='kw-2'>mut</span> <span class='ident'>send_frame</span>) <span class='op'>=</span> <span class='ident'>service</span>; <span class='kw'>if</span> <span class='kw'>let</span> <span class='prelude-val'>Err</span>(_) <span class='op'>=</span> <span class='ident'>rx</span>.<span class='ident'>send</span>(<span class='ident'>WorkItem</span>::<span class='ident'>NewClient</span>) { <span class='kw'>return</span> <span class='prelude-val'>None</span>; } <span class='comment'>// Keep a handle to the work queue to notify the service of newly read frames, making it so</span> <span class='comment'>// that it never blocks on waiting for frames to read.</span> <span class='kw'>let</span> <span class='ident'>read_notify</span> <span class='op'>=</span> <span class='ident'>rx</span>.<span class='ident'>clone</span>(); <span class='kw'>let</span> <span class='ident'>sender_work_queue</span> <span class='op'>=</span> <span class='ident'>rx</span>.<span class='ident'>clone</span>(); <span class='ident'>thread</span>::<span class='ident'>spawn</span>(<span class='kw'>move</span> <span class='op'>||</span> { <span class='kw'>while</span> <span class='kw'>let</span> <span class='prelude-val'>Ok</span>(_) <span class='op'>=</span> <span class='ident'>service</span>.<span class='ident'>run_once</span>() {} <span class='macro'>debug</span><span class='macro'>!</span>(<span class='string'>"Service thread halting"</span>); <span class='comment'>// This is the one place where it's okay to unwrap, as if the shutdown fails, there's</span> <span class='comment'>// really nothing we can do to recover at this point...</span> <span class='comment'>// This forces the reader thread to stop, as the socket is no longer operational.</span> <span class='ident'>sck</span>.<span class='ident'>close</span>().<span class='ident'>unwrap</span>(); }); <span class='ident'>thread</span>::<span class='ident'>spawn</span>(<span class='kw'>move</span> <span class='op'>||</span> { <span class='kw'>while</span> <span class='kw'>let</span> <span class='prelude-val'>Ok</span>(_) <span class='op'>=</span> <span class='ident'>send_frame</span>.<span class='ident'>send_next</span>() { <span class='ident'>sender_work_queue</span>.<span class='ident'>send</span>(<span class='ident'>WorkItem</span>::<span class='ident'>SendData</span>).<span class='ident'>unwrap</span>(); } <span class='macro'>debug</span><span class='macro'>!</span>(<span class='string'>"Sender thread halting"</span>); }); <span class='ident'>thread</span>::<span class='ident'>spawn</span>(<span class='kw'>move</span> <span class='op'>||</span> { <span class='kw'>while</span> <span class='kw'>let</span> <span class='prelude-val'>Ok</span>(_) <span class='op'>=</span> <span class='ident'>recv_frame</span>.<span class='ident'>read_next</span>() { <span class='ident'>read_notify</span>.<span class='ident'>send</span>(<span class='ident'>WorkItem</span>::<span class='ident'>HandleFrame</span>).<span class='ident'>unwrap</span>(); } <span class='macro'>debug</span><span class='macro'>!</span>(<span class='string'>"Reader thread halting"</span>); }); <span class='prelude-val'>Some</span>(<span class='ident'>Client</span> { <span class='ident'>sender</span>: <span class='ident'>rx</span>, }) } <span class='doccomment'>/// Issues a new request to the server.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// The request's method, path, and extra headers are provided as parameters.</span> <span class='doccomment'>/// The headers should *never* include any meta-headers (such as `:method`).</span> <span class='doccomment'>///</span> <span class='doccomment'>/// # Returns</span> <span class='doccomment'>///</span> <span class='doccomment'>/// The method itself returns immediately upon queuing the request. It does</span> <span class='doccomment'>/// not wait for the request to be transmitted nor for the response to</span> <span class='doccomment'>/// arrive. Once the caller is interested in the final response, they can</span> <span class='doccomment'>/// block on the returned `Receiver` end of a channel which will receive</span> <span class='doccomment'>/// the response once generated.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// The `Response` instance that the channel receives will contain the full</span> <span class='doccomment'>/// response body and is available only once the full response body has</span> <span class='doccomment'>/// been received.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// If the method is unable to queue the request, it must mean that the</span> <span class='doccomment'>/// underlying HTTP/2 connection to which this client is associated has</span> <span class='doccomment'>/// failed and it returns `None`.</span> <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>request</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>method</span>: <span class='kw-2'>&</span>[<span class='ident'>u8</span>], <span class='ident'>path</span>: <span class='kw-2'>&</span>[<span class='ident'>u8</span>], <span class='ident'>headers</span>: <span class='kw-2'>&</span>[<span class='ident'>Header</span>], <span class='ident'>body</span>: <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>>></span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>Receiver</span><span class='op'><</span><span class='ident'>Response</span><span class='op'>>></span> { <span class='kw'>let</span> (<span class='ident'>resp_tx</span>, <span class='ident'>resp_rx</span>): (<span class='ident'>Sender</span><span class='op'><</span><span class='ident'>Response</span><span class='op'>></span>, <span class='ident'>Receiver</span><span class='op'><</span><span class='ident'>Response</span><span class='op'>></span>) <span class='op'>=</span> <span class='ident'>mpsc</span>::<span class='ident'>channel</span>(); <span class='comment'>// A send can only fail if the receiver is disconnected. If the send</span> <span class='comment'>// fails here, it means that the service hit an error on the underlying</span> <span class='comment'>// HTTP/2 connection and will never come alive again.</span> <span class='kw'>let</span> <span class='ident'>res</span> <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>sender</span>.<span class='ident'>send</span>(<span class='ident'>WorkItem</span>::<span class='ident'>Request</span>(<span class='ident'>AsyncRequest</span> { <span class='ident'>method</span>: <span class='ident'>method</span>.<span class='ident'>to_vec</span>(), <span class='ident'>path</span>: <span class='ident'>path</span>.<span class='ident'>to_vec</span>(), <span class='ident'>headers</span>: <span class='ident'>headers</span>.<span class='ident'>to_vec</span>(), <span class='ident'>body</span>: <span class='ident'>body</span>, <span class='ident'>tx</span>: <span class='ident'>resp_tx</span>, })); <span class='kw'>match</span> <span class='ident'>res</span> { <span class='prelude-val'>Ok</span>(_) <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>resp_rx</span>), <span class='prelude-val'>Err</span>(_) <span class='op'>=></span> <span class='prelude-val'>None</span>, } } <span class='doccomment'>/// Issues a GET request to the server.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// A convenience wrapper around the `request` method that sets the correct</span> <span class='doccomment'>/// method.</span> <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>get</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>path</span>: <span class='kw-2'>&</span>[<span class='ident'>u8</span>], <span class='ident'>headers</span>: <span class='kw-2'>&</span>[<span class='ident'>Header</span>]) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>Receiver</span><span class='op'><</span><span class='ident'>Response</span><span class='op'>>></span> { <span class='self'>self</span>.<span class='ident'>request</span>(<span class='string'>b"GET"</span>, <span class='ident'>path</span>, <span class='ident'>headers</span>, <span class='prelude-val'>None</span>) } <span class='doccomment'>/// Issues a POST request to the server.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// Returns the receiving end of a channel where the `Response` will eventually be pushed.</span> <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>post</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>path</span>: <span class='kw-2'>&</span>[<span class='ident'>u8</span>], <span class='ident'>headers</span>: <span class='kw-2'>&</span>[<span class='ident'>Header</span>], <span class='ident'>body</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>Receiver</span><span class='op'><</span><span class='ident'>Response</span><span class='op'>>></span> { <span class='self'>self</span>.<span class='ident'>request</span>(<span class='string'>b"POST"</span>, <span class='ident'>path</span>, <span class='ident'>headers</span>, <span class='prelude-val'>Some</span>(<span class='ident'>body</span>)) } } </pre> </section> <section id='search' class="content hidden"></section> <section class="footer"></section> <aside id="help" class="hidden"> <div> <h1 class="hidden">Help</h1> <div class="shortcuts"> <h2>Keyboard Shortcuts</h2> <dl> <dt>?</dt> <dd>Show this help dialog</dd> <dt>S</dt> <dd>Focus the search field</dd> <dt>⇤</dt> <dd>Move up in search results</dd> <dt>⇥</dt> <dd>Move down in search results</dd> <dt>⏎</dt> <dd>Go to active search result</dd> <dt>+</dt> <dd>Collapse/expand all sections</dd> </dl> </div> <div class="infos"> <h2>Search Tricks</h2> <p> Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type. </p> <p> Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>. </p> <p> Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>) </p> </div> </div> </aside> <script> window.rootPath = "../../../"; window.currentCrate = "solicit"; window.playgroundUrl = ""; </script> <script src="../../../jquery.js"></script> <script src="../../../main.js"></script> <script defer src="../../../search-index.js"></script> </body> </html>