| <!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/tokio-1.28.2/src/sync/broadcast.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>broadcast.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="../../../tokio/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="../../../tokio/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> |
| <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> |
| <span id="718">718</span> |
| <span id="719">719</span> |
| <span id="720">720</span> |
| <span id="721">721</span> |
| <span id="722">722</span> |
| <span id="723">723</span> |
| <span id="724">724</span> |
| <span id="725">725</span> |
| <span id="726">726</span> |
| <span id="727">727</span> |
| <span id="728">728</span> |
| <span id="729">729</span> |
| <span id="730">730</span> |
| <span id="731">731</span> |
| <span id="732">732</span> |
| <span id="733">733</span> |
| <span id="734">734</span> |
| <span id="735">735</span> |
| <span id="736">736</span> |
| <span id="737">737</span> |
| <span id="738">738</span> |
| <span id="739">739</span> |
| <span id="740">740</span> |
| <span id="741">741</span> |
| <span id="742">742</span> |
| <span id="743">743</span> |
| <span id="744">744</span> |
| <span id="745">745</span> |
| <span id="746">746</span> |
| <span id="747">747</span> |
| <span id="748">748</span> |
| <span id="749">749</span> |
| <span id="750">750</span> |
| <span id="751">751</span> |
| <span id="752">752</span> |
| <span id="753">753</span> |
| <span id="754">754</span> |
| <span id="755">755</span> |
| <span id="756">756</span> |
| <span id="757">757</span> |
| <span id="758">758</span> |
| <span id="759">759</span> |
| <span id="760">760</span> |
| <span id="761">761</span> |
| <span id="762">762</span> |
| <span id="763">763</span> |
| <span id="764">764</span> |
| <span id="765">765</span> |
| <span id="766">766</span> |
| <span id="767">767</span> |
| <span id="768">768</span> |
| <span id="769">769</span> |
| <span id="770">770</span> |
| <span id="771">771</span> |
| <span id="772">772</span> |
| <span id="773">773</span> |
| <span id="774">774</span> |
| <span id="775">775</span> |
| <span id="776">776</span> |
| <span id="777">777</span> |
| <span id="778">778</span> |
| <span id="779">779</span> |
| <span id="780">780</span> |
| <span id="781">781</span> |
| <span id="782">782</span> |
| <span id="783">783</span> |
| <span id="784">784</span> |
| <span id="785">785</span> |
| <span id="786">786</span> |
| <span id="787">787</span> |
| <span id="788">788</span> |
| <span id="789">789</span> |
| <span id="790">790</span> |
| <span id="791">791</span> |
| <span id="792">792</span> |
| <span id="793">793</span> |
| <span id="794">794</span> |
| <span id="795">795</span> |
| <span id="796">796</span> |
| <span id="797">797</span> |
| <span id="798">798</span> |
| <span id="799">799</span> |
| <span id="800">800</span> |
| <span id="801">801</span> |
| <span id="802">802</span> |
| <span id="803">803</span> |
| <span id="804">804</span> |
| <span id="805">805</span> |
| <span id="806">806</span> |
| <span id="807">807</span> |
| <span id="808">808</span> |
| <span id="809">809</span> |
| <span id="810">810</span> |
| <span id="811">811</span> |
| <span id="812">812</span> |
| <span id="813">813</span> |
| <span id="814">814</span> |
| <span id="815">815</span> |
| <span id="816">816</span> |
| <span id="817">817</span> |
| <span id="818">818</span> |
| <span id="819">819</span> |
| <span id="820">820</span> |
| <span id="821">821</span> |
| <span id="822">822</span> |
| <span id="823">823</span> |
| <span id="824">824</span> |
| <span id="825">825</span> |
| <span id="826">826</span> |
| <span id="827">827</span> |
| <span id="828">828</span> |
| <span id="829">829</span> |
| <span id="830">830</span> |
| <span id="831">831</span> |
| <span id="832">832</span> |
| <span id="833">833</span> |
| <span id="834">834</span> |
| <span id="835">835</span> |
| <span id="836">836</span> |
| <span id="837">837</span> |
| <span id="838">838</span> |
| <span id="839">839</span> |
| <span id="840">840</span> |
| <span id="841">841</span> |
| <span id="842">842</span> |
| <span id="843">843</span> |
| <span id="844">844</span> |
| <span id="845">845</span> |
| <span id="846">846</span> |
| <span id="847">847</span> |
| <span id="848">848</span> |
| <span id="849">849</span> |
| <span id="850">850</span> |
| <span id="851">851</span> |
| <span id="852">852</span> |
| <span id="853">853</span> |
| <span id="854">854</span> |
| <span id="855">855</span> |
| <span id="856">856</span> |
| <span id="857">857</span> |
| <span id="858">858</span> |
| <span id="859">859</span> |
| <span id="860">860</span> |
| <span id="861">861</span> |
| <span id="862">862</span> |
| <span id="863">863</span> |
| <span id="864">864</span> |
| <span id="865">865</span> |
| <span id="866">866</span> |
| <span id="867">867</span> |
| <span id="868">868</span> |
| <span id="869">869</span> |
| <span id="870">870</span> |
| <span id="871">871</span> |
| <span id="872">872</span> |
| <span id="873">873</span> |
| <span id="874">874</span> |
| <span id="875">875</span> |
| <span id="876">876</span> |
| <span id="877">877</span> |
| <span id="878">878</span> |
| <span id="879">879</span> |
| <span id="880">880</span> |
| <span id="881">881</span> |
| <span id="882">882</span> |
| <span id="883">883</span> |
| <span id="884">884</span> |
| <span id="885">885</span> |
| <span id="886">886</span> |
| <span id="887">887</span> |
| <span id="888">888</span> |
| <span id="889">889</span> |
| <span id="890">890</span> |
| <span id="891">891</span> |
| <span id="892">892</span> |
| <span id="893">893</span> |
| <span id="894">894</span> |
| <span id="895">895</span> |
| <span id="896">896</span> |
| <span id="897">897</span> |
| <span id="898">898</span> |
| <span id="899">899</span> |
| <span id="900">900</span> |
| <span id="901">901</span> |
| <span id="902">902</span> |
| <span id="903">903</span> |
| <span id="904">904</span> |
| <span id="905">905</span> |
| <span id="906">906</span> |
| <span id="907">907</span> |
| <span id="908">908</span> |
| <span id="909">909</span> |
| <span id="910">910</span> |
| <span id="911">911</span> |
| <span id="912">912</span> |
| <span id="913">913</span> |
| <span id="914">914</span> |
| <span id="915">915</span> |
| <span id="916">916</span> |
| <span id="917">917</span> |
| <span id="918">918</span> |
| <span id="919">919</span> |
| <span id="920">920</span> |
| <span id="921">921</span> |
| <span id="922">922</span> |
| <span id="923">923</span> |
| <span id="924">924</span> |
| <span id="925">925</span> |
| <span id="926">926</span> |
| <span id="927">927</span> |
| <span id="928">928</span> |
| <span id="929">929</span> |
| <span id="930">930</span> |
| <span id="931">931</span> |
| <span id="932">932</span> |
| <span id="933">933</span> |
| <span id="934">934</span> |
| <span id="935">935</span> |
| <span id="936">936</span> |
| <span id="937">937</span> |
| <span id="938">938</span> |
| <span id="939">939</span> |
| <span id="940">940</span> |
| <span id="941">941</span> |
| <span id="942">942</span> |
| <span id="943">943</span> |
| <span id="944">944</span> |
| <span id="945">945</span> |
| <span id="946">946</span> |
| <span id="947">947</span> |
| <span id="948">948</span> |
| <span id="949">949</span> |
| <span id="950">950</span> |
| <span id="951">951</span> |
| <span id="952">952</span> |
| <span id="953">953</span> |
| <span id="954">954</span> |
| <span id="955">955</span> |
| <span id="956">956</span> |
| <span id="957">957</span> |
| <span id="958">958</span> |
| <span id="959">959</span> |
| <span id="960">960</span> |
| <span id="961">961</span> |
| <span id="962">962</span> |
| <span id="963">963</span> |
| <span id="964">964</span> |
| <span id="965">965</span> |
| <span id="966">966</span> |
| <span id="967">967</span> |
| <span id="968">968</span> |
| <span id="969">969</span> |
| <span id="970">970</span> |
| <span id="971">971</span> |
| <span id="972">972</span> |
| <span id="973">973</span> |
| <span id="974">974</span> |
| <span id="975">975</span> |
| <span id="976">976</span> |
| <span id="977">977</span> |
| <span id="978">978</span> |
| <span id="979">979</span> |
| <span id="980">980</span> |
| <span id="981">981</span> |
| <span id="982">982</span> |
| <span id="983">983</span> |
| <span id="984">984</span> |
| <span id="985">985</span> |
| <span id="986">986</span> |
| <span id="987">987</span> |
| <span id="988">988</span> |
| <span id="989">989</span> |
| <span id="990">990</span> |
| <span id="991">991</span> |
| <span id="992">992</span> |
| <span id="993">993</span> |
| <span id="994">994</span> |
| <span id="995">995</span> |
| <span id="996">996</span> |
| <span id="997">997</span> |
| <span id="998">998</span> |
| <span id="999">999</span> |
| <span id="1000">1000</span> |
| <span id="1001">1001</span> |
| <span id="1002">1002</span> |
| <span id="1003">1003</span> |
| <span id="1004">1004</span> |
| <span id="1005">1005</span> |
| <span id="1006">1006</span> |
| <span id="1007">1007</span> |
| <span id="1008">1008</span> |
| <span id="1009">1009</span> |
| <span id="1010">1010</span> |
| <span id="1011">1011</span> |
| <span id="1012">1012</span> |
| <span id="1013">1013</span> |
| <span id="1014">1014</span> |
| <span id="1015">1015</span> |
| <span id="1016">1016</span> |
| <span id="1017">1017</span> |
| <span id="1018">1018</span> |
| <span id="1019">1019</span> |
| <span id="1020">1020</span> |
| <span id="1021">1021</span> |
| <span id="1022">1022</span> |
| <span id="1023">1023</span> |
| <span id="1024">1024</span> |
| <span id="1025">1025</span> |
| <span id="1026">1026</span> |
| <span id="1027">1027</span> |
| <span id="1028">1028</span> |
| <span id="1029">1029</span> |
| <span id="1030">1030</span> |
| <span id="1031">1031</span> |
| <span id="1032">1032</span> |
| <span id="1033">1033</span> |
| <span id="1034">1034</span> |
| <span id="1035">1035</span> |
| <span id="1036">1036</span> |
| <span id="1037">1037</span> |
| <span id="1038">1038</span> |
| <span id="1039">1039</span> |
| <span id="1040">1040</span> |
| <span id="1041">1041</span> |
| <span id="1042">1042</span> |
| <span id="1043">1043</span> |
| <span id="1044">1044</span> |
| <span id="1045">1045</span> |
| <span id="1046">1046</span> |
| <span id="1047">1047</span> |
| <span id="1048">1048</span> |
| <span id="1049">1049</span> |
| <span id="1050">1050</span> |
| <span id="1051">1051</span> |
| <span id="1052">1052</span> |
| <span id="1053">1053</span> |
| <span id="1054">1054</span> |
| <span id="1055">1055</span> |
| <span id="1056">1056</span> |
| <span id="1057">1057</span> |
| <span id="1058">1058</span> |
| <span id="1059">1059</span> |
| <span id="1060">1060</span> |
| <span id="1061">1061</span> |
| <span id="1062">1062</span> |
| <span id="1063">1063</span> |
| <span id="1064">1064</span> |
| <span id="1065">1065</span> |
| <span id="1066">1066</span> |
| <span id="1067">1067</span> |
| <span id="1068">1068</span> |
| <span id="1069">1069</span> |
| <span id="1070">1070</span> |
| <span id="1071">1071</span> |
| <span id="1072">1072</span> |
| <span id="1073">1073</span> |
| <span id="1074">1074</span> |
| <span id="1075">1075</span> |
| <span id="1076">1076</span> |
| <span id="1077">1077</span> |
| <span id="1078">1078</span> |
| <span id="1079">1079</span> |
| <span id="1080">1080</span> |
| <span id="1081">1081</span> |
| <span id="1082">1082</span> |
| <span id="1083">1083</span> |
| <span id="1084">1084</span> |
| <span id="1085">1085</span> |
| <span id="1086">1086</span> |
| <span id="1087">1087</span> |
| <span id="1088">1088</span> |
| <span id="1089">1089</span> |
| <span id="1090">1090</span> |
| <span id="1091">1091</span> |
| <span id="1092">1092</span> |
| <span id="1093">1093</span> |
| <span id="1094">1094</span> |
| <span id="1095">1095</span> |
| <span id="1096">1096</span> |
| <span id="1097">1097</span> |
| <span id="1098">1098</span> |
| <span id="1099">1099</span> |
| <span id="1100">1100</span> |
| <span id="1101">1101</span> |
| <span id="1102">1102</span> |
| <span id="1103">1103</span> |
| <span id="1104">1104</span> |
| <span id="1105">1105</span> |
| <span id="1106">1106</span> |
| <span id="1107">1107</span> |
| <span id="1108">1108</span> |
| <span id="1109">1109</span> |
| <span id="1110">1110</span> |
| <span id="1111">1111</span> |
| <span id="1112">1112</span> |
| <span id="1113">1113</span> |
| <span id="1114">1114</span> |
| <span id="1115">1115</span> |
| <span id="1116">1116</span> |
| <span id="1117">1117</span> |
| <span id="1118">1118</span> |
| <span id="1119">1119</span> |
| <span id="1120">1120</span> |
| <span id="1121">1121</span> |
| <span id="1122">1122</span> |
| <span id="1123">1123</span> |
| <span id="1124">1124</span> |
| <span id="1125">1125</span> |
| <span id="1126">1126</span> |
| <span id="1127">1127</span> |
| <span id="1128">1128</span> |
| <span id="1129">1129</span> |
| <span id="1130">1130</span> |
| <span id="1131">1131</span> |
| <span id="1132">1132</span> |
| <span id="1133">1133</span> |
| <span id="1134">1134</span> |
| <span id="1135">1135</span> |
| <span id="1136">1136</span> |
| <span id="1137">1137</span> |
| <span id="1138">1138</span> |
| <span id="1139">1139</span> |
| <span id="1140">1140</span> |
| <span id="1141">1141</span> |
| <span id="1142">1142</span> |
| <span id="1143">1143</span> |
| <span id="1144">1144</span> |
| <span id="1145">1145</span> |
| <span id="1146">1146</span> |
| <span id="1147">1147</span> |
| <span id="1148">1148</span> |
| <span id="1149">1149</span> |
| <span id="1150">1150</span> |
| <span id="1151">1151</span> |
| <span id="1152">1152</span> |
| <span id="1153">1153</span> |
| <span id="1154">1154</span> |
| <span id="1155">1155</span> |
| <span id="1156">1156</span> |
| <span id="1157">1157</span> |
| <span id="1158">1158</span> |
| <span id="1159">1159</span> |
| <span id="1160">1160</span> |
| <span id="1161">1161</span> |
| <span id="1162">1162</span> |
| <span id="1163">1163</span> |
| <span id="1164">1164</span> |
| <span id="1165">1165</span> |
| <span id="1166">1166</span> |
| <span id="1167">1167</span> |
| <span id="1168">1168</span> |
| <span id="1169">1169</span> |
| <span id="1170">1170</span> |
| <span id="1171">1171</span> |
| <span id="1172">1172</span> |
| <span id="1173">1173</span> |
| <span id="1174">1174</span> |
| <span id="1175">1175</span> |
| <span id="1176">1176</span> |
| <span id="1177">1177</span> |
| <span id="1178">1178</span> |
| <span id="1179">1179</span> |
| <span id="1180">1180</span> |
| <span id="1181">1181</span> |
| <span id="1182">1182</span> |
| <span id="1183">1183</span> |
| <span id="1184">1184</span> |
| <span id="1185">1185</span> |
| <span id="1186">1186</span> |
| <span id="1187">1187</span> |
| <span id="1188">1188</span> |
| <span id="1189">1189</span> |
| <span id="1190">1190</span> |
| <span id="1191">1191</span> |
| <span id="1192">1192</span> |
| <span id="1193">1193</span> |
| <span id="1194">1194</span> |
| <span id="1195">1195</span> |
| <span id="1196">1196</span> |
| <span id="1197">1197</span> |
| <span id="1198">1198</span> |
| <span id="1199">1199</span> |
| <span id="1200">1200</span> |
| <span id="1201">1201</span> |
| <span id="1202">1202</span> |
| <span id="1203">1203</span> |
| <span id="1204">1204</span> |
| <span id="1205">1205</span> |
| <span id="1206">1206</span> |
| <span id="1207">1207</span> |
| <span id="1208">1208</span> |
| <span id="1209">1209</span> |
| <span id="1210">1210</span> |
| <span id="1211">1211</span> |
| <span id="1212">1212</span> |
| <span id="1213">1213</span> |
| <span id="1214">1214</span> |
| <span id="1215">1215</span> |
| <span id="1216">1216</span> |
| <span id="1217">1217</span> |
| <span id="1218">1218</span> |
| <span id="1219">1219</span> |
| <span id="1220">1220</span> |
| <span id="1221">1221</span> |
| <span id="1222">1222</span> |
| <span id="1223">1223</span> |
| <span id="1224">1224</span> |
| <span id="1225">1225</span> |
| <span id="1226">1226</span> |
| <span id="1227">1227</span> |
| <span id="1228">1228</span> |
| <span id="1229">1229</span> |
| <span id="1230">1230</span> |
| <span id="1231">1231</span> |
| <span id="1232">1232</span> |
| <span id="1233">1233</span> |
| <span id="1234">1234</span> |
| <span id="1235">1235</span> |
| <span id="1236">1236</span> |
| <span id="1237">1237</span> |
| <span id="1238">1238</span> |
| <span id="1239">1239</span> |
| <span id="1240">1240</span> |
| <span id="1241">1241</span> |
| <span id="1242">1242</span> |
| <span id="1243">1243</span> |
| <span id="1244">1244</span> |
| <span id="1245">1245</span> |
| <span id="1246">1246</span> |
| <span id="1247">1247</span> |
| <span id="1248">1248</span> |
| <span id="1249">1249</span> |
| <span id="1250">1250</span> |
| <span id="1251">1251</span> |
| <span id="1252">1252</span> |
| <span id="1253">1253</span> |
| <span id="1254">1254</span> |
| <span id="1255">1255</span> |
| <span id="1256">1256</span> |
| <span id="1257">1257</span> |
| <span id="1258">1258</span> |
| <span id="1259">1259</span> |
| <span id="1260">1260</span> |
| <span id="1261">1261</span> |
| <span id="1262">1262</span> |
| <span id="1263">1263</span> |
| <span id="1264">1264</span> |
| <span id="1265">1265</span> |
| <span id="1266">1266</span> |
| <span id="1267">1267</span> |
| <span id="1268">1268</span> |
| <span id="1269">1269</span> |
| <span id="1270">1270</span> |
| <span id="1271">1271</span> |
| <span id="1272">1272</span> |
| <span id="1273">1273</span> |
| <span id="1274">1274</span> |
| <span id="1275">1275</span> |
| <span id="1276">1276</span> |
| <span id="1277">1277</span> |
| <span id="1278">1278</span> |
| <span id="1279">1279</span> |
| <span id="1280">1280</span> |
| <span id="1281">1281</span> |
| <span id="1282">1282</span> |
| <span id="1283">1283</span> |
| <span id="1284">1284</span> |
| <span id="1285">1285</span> |
| <span id="1286">1286</span> |
| <span id="1287">1287</span> |
| <span id="1288">1288</span> |
| <span id="1289">1289</span> |
| <span id="1290">1290</span> |
| <span id="1291">1291</span> |
| <span id="1292">1292</span> |
| <span id="1293">1293</span> |
| <span id="1294">1294</span> |
| <span id="1295">1295</span> |
| <span id="1296">1296</span> |
| <span id="1297">1297</span> |
| <span id="1298">1298</span> |
| <span id="1299">1299</span> |
| <span id="1300">1300</span> |
| <span id="1301">1301</span> |
| <span id="1302">1302</span> |
| <span id="1303">1303</span> |
| <span id="1304">1304</span> |
| <span id="1305">1305</span> |
| <span id="1306">1306</span> |
| <span id="1307">1307</span> |
| <span id="1308">1308</span> |
| <span id="1309">1309</span> |
| <span id="1310">1310</span> |
| <span id="1311">1311</span> |
| <span id="1312">1312</span> |
| <span id="1313">1313</span> |
| <span id="1314">1314</span> |
| <span id="1315">1315</span> |
| <span id="1316">1316</span> |
| <span id="1317">1317</span> |
| <span id="1318">1318</span> |
| <span id="1319">1319</span> |
| <span id="1320">1320</span> |
| <span id="1321">1321</span> |
| <span id="1322">1322</span> |
| <span id="1323">1323</span> |
| <span id="1324">1324</span> |
| <span id="1325">1325</span> |
| <span id="1326">1326</span> |
| <span id="1327">1327</span> |
| <span id="1328">1328</span> |
| <span id="1329">1329</span> |
| <span id="1330">1330</span> |
| <span id="1331">1331</span> |
| <span id="1332">1332</span> |
| <span id="1333">1333</span> |
| <span id="1334">1334</span> |
| <span id="1335">1335</span> |
| <span id="1336">1336</span> |
| <span id="1337">1337</span> |
| <span id="1338">1338</span> |
| <span id="1339">1339</span> |
| <span id="1340">1340</span> |
| <span id="1341">1341</span> |
| <span id="1342">1342</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! A multi-producer, multi-consumer broadcast queue. Each sent value is seen by |
| //! all consumers. |
| //! |
| //! A [`Sender`] is used to broadcast values to **all** connected [`Receiver`] |
| //! values. [`Sender`] handles are clone-able, allowing concurrent send and |
| //! receive actions. [`Sender`] and [`Receiver`] are both `Send` and `Sync` as |
| //! long as `T` is `Send`. |
| //! |
| //! When a value is sent, **all** [`Receiver`] handles are notified and will |
| //! receive the value. The value is stored once inside the channel and cloned on |
| //! demand for each receiver. Once all receivers have received a clone of the |
| //! value, the value is released from the channel. |
| //! |
| //! A channel is created by calling [`channel`], specifying the maximum number |
| //! of messages the channel can retain at any given time. |
| //! |
| //! New [`Receiver`] handles are created by calling [`Sender::subscribe`]. The |
| //! returned [`Receiver`] will receive values sent **after** the call to |
| //! `subscribe`. |
| //! |
| //! This channel is also suitable for the single-producer multi-consumer |
| //! use-case, where a single sender broadcasts values to many receivers. |
| //! |
| //! ## Lagging |
| //! |
| //! As sent messages must be retained until **all** [`Receiver`] handles receive |
| //! a clone, broadcast channels are susceptible to the "slow receiver" problem. |
| //! In this case, all but one receiver are able to receive values at the rate |
| //! they are sent. Because one receiver is stalled, the channel starts to fill |
| //! up. |
| //! |
| //! This broadcast channel implementation handles this case by setting a hard |
| //! upper bound on the number of values the channel may retain at any given |
| //! time. This upper bound is passed to the [`channel`] function as an argument. |
| //! |
| //! If a value is sent when the channel is at capacity, the oldest value |
| //! currently held by the channel is released. This frees up space for the new |
| //! value. Any receiver that has not yet seen the released value will return |
| //! [`RecvError::Lagged`] the next time [`recv`] is called. |
| //! |
| //! Once [`RecvError::Lagged`] is returned, the lagging receiver's position is |
| //! updated to the oldest value contained by the channel. The next call to |
| //! [`recv`] will return this value. |
| //! |
| //! This behavior enables a receiver to detect when it has lagged so far behind |
| //! that data has been dropped. The caller may decide how to respond to this: |
| //! either by aborting its task or by tolerating lost messages and resuming |
| //! consumption of the channel. |
| //! |
| //! ## Closing |
| //! |
| //! When **all** [`Sender`] handles have been dropped, no new values may be |
| //! sent. At this point, the channel is "closed". Once a receiver has received |
| //! all values retained by the channel, the next call to [`recv`] will return |
| //! with [`RecvError::Closed`]. |
| //! |
| //! When a [`Receiver`] handle is dropped, any messages not read by the receiver |
| //! will be marked as read. If this receiver was the only one not to have read |
| //! that message, the message will be dropped at this point. |
| //! |
| //! [`Sender`]: crate::sync::broadcast::Sender |
| //! [`Sender::subscribe`]: crate::sync::broadcast::Sender::subscribe |
| //! [`Receiver`]: crate::sync::broadcast::Receiver |
| //! [`channel`]: crate::sync::broadcast::channel |
| //! [`RecvError::Lagged`]: crate::sync::broadcast::error::RecvError::Lagged |
| //! [`RecvError::Closed`]: crate::sync::broadcast::error::RecvError::Closed |
| //! [`recv`]: crate::sync::broadcast::Receiver::recv |
| //! |
| //! # Examples |
| //! |
| //! Basic usage |
| //! |
| //! ``` |
| //! use tokio::sync::broadcast; |
| //! |
| //! #[tokio::main] |
| //! async fn main() { |
| //! let (tx, mut rx1) = broadcast::channel(16); |
| //! let mut rx2 = tx.subscribe(); |
| //! |
| //! tokio::spawn(async move { |
| //! assert_eq!(rx1.recv().await.unwrap(), 10); |
| //! assert_eq!(rx1.recv().await.unwrap(), 20); |
| //! }); |
| //! |
| //! tokio::spawn(async move { |
| //! assert_eq!(rx2.recv().await.unwrap(), 10); |
| //! assert_eq!(rx2.recv().await.unwrap(), 20); |
| //! }); |
| //! |
| //! tx.send(10).unwrap(); |
| //! tx.send(20).unwrap(); |
| //! } |
| //! ``` |
| //! |
| //! Handling lag |
| //! |
| //! ``` |
| //! use tokio::sync::broadcast; |
| //! |
| //! #[tokio::main] |
| //! async fn main() { |
| //! let (tx, mut rx) = broadcast::channel(2); |
| //! |
| //! tx.send(10).unwrap(); |
| //! tx.send(20).unwrap(); |
| //! tx.send(30).unwrap(); |
| //! |
| //! // The receiver lagged behind |
| //! assert!(rx.recv().await.is_err()); |
| //! |
| //! // At this point, we can abort or continue with lost messages |
| //! |
| //! assert_eq!(20, rx.recv().await.unwrap()); |
| //! assert_eq!(30, rx.recv().await.unwrap()); |
| //! } |
| //! ``` |
| |
| </span><span class="kw">use </span><span class="kw">crate</span>::loom::cell::UnsafeCell; |
| <span class="kw">use </span><span class="kw">crate</span>::loom::sync::atomic::AtomicUsize; |
| <span class="kw">use </span><span class="kw">crate</span>::loom::sync::{Arc, Mutex, MutexGuard, RwLock, RwLockReadGuard}; |
| <span class="kw">use </span><span class="kw">crate</span>::util::linked_list::{<span class="self">self</span>, LinkedList}; |
| <span class="kw">use </span><span class="kw">crate</span>::util::WakeList; |
| |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::future::Future; |
| <span class="kw">use </span>std::marker::PhantomPinned; |
| <span class="kw">use </span>std::pin::Pin; |
| <span class="kw">use </span>std::ptr::NonNull; |
| <span class="kw">use </span>std::sync::atomic::Ordering::SeqCst; |
| <span class="kw">use </span>std::task::{Context, Poll, Waker}; |
| <span class="kw">use </span>std::usize; |
| |
| <span class="doccomment">/// Sending-half of the [`broadcast`] channel. |
| /// |
| /// May be used from many threads. Messages can be sent with |
| /// [`send`][Sender::send]. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx1) = broadcast::channel(16); |
| /// let mut rx2 = tx.subscribe(); |
| /// |
| /// tokio::spawn(async move { |
| /// assert_eq!(rx1.recv().await.unwrap(), 10); |
| /// assert_eq!(rx1.recv().await.unwrap(), 20); |
| /// }); |
| /// |
| /// tokio::spawn(async move { |
| /// assert_eq!(rx2.recv().await.unwrap(), 10); |
| /// assert_eq!(rx2.recv().await.unwrap(), 20); |
| /// }); |
| /// |
| /// tx.send(10).unwrap(); |
| /// tx.send(20).unwrap(); |
| /// } |
| /// ``` |
| /// |
| /// [`broadcast`]: crate::sync::broadcast |
| </span><span class="kw">pub struct </span>Sender<T> { |
| shared: Arc<Shared<T>>, |
| } |
| |
| <span class="doccomment">/// Receiving-half of the [`broadcast`] channel. |
| /// |
| /// Must not be used concurrently. Messages may be retrieved using |
| /// [`recv`][Receiver::recv]. |
| /// |
| /// To turn this receiver into a `Stream`, you can use the [`BroadcastStream`] |
| /// wrapper. |
| /// |
| /// [`BroadcastStream`]: https://docs.rs/tokio-stream/0.1/tokio_stream/wrappers/struct.BroadcastStream.html |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx1) = broadcast::channel(16); |
| /// let mut rx2 = tx.subscribe(); |
| /// |
| /// tokio::spawn(async move { |
| /// assert_eq!(rx1.recv().await.unwrap(), 10); |
| /// assert_eq!(rx1.recv().await.unwrap(), 20); |
| /// }); |
| /// |
| /// tokio::spawn(async move { |
| /// assert_eq!(rx2.recv().await.unwrap(), 10); |
| /// assert_eq!(rx2.recv().await.unwrap(), 20); |
| /// }); |
| /// |
| /// tx.send(10).unwrap(); |
| /// tx.send(20).unwrap(); |
| /// } |
| /// ``` |
| /// |
| /// [`broadcast`]: crate::sync::broadcast |
| </span><span class="kw">pub struct </span>Receiver<T> { |
| <span class="doccomment">/// State shared with all receivers and senders. |
| </span>shared: Arc<Shared<T>>, |
| |
| <span class="doccomment">/// Next position to read from |
| </span>next: u64, |
| } |
| |
| <span class="kw">pub mod </span>error { |
| <span class="doccomment">//! Broadcast error types |
| |
| </span><span class="kw">use </span>std::fmt; |
| |
| <span class="doccomment">/// Error returned by from the [`send`] function on a [`Sender`]. |
| /// |
| /// A **send** operation can only fail if there are no active receivers, |
| /// implying that the message could never be received. The error contains the |
| /// message being sent as a payload so it can be recovered. |
| /// |
| /// [`send`]: crate::sync::broadcast::Sender::send |
| /// [`Sender`]: crate::sync::broadcast::Sender |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>SendError<T>(<span class="kw">pub </span>T); |
| |
| <span class="kw">impl</span><T> fmt::Display <span class="kw">for </span>SendError<T> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="macro">write!</span>(f, <span class="string">"channel closed"</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><T: fmt::Debug> std::error::Error <span class="kw">for </span>SendError<T> {} |
| |
| <span class="doccomment">/// An error returned from the [`recv`] function on a [`Receiver`]. |
| /// |
| /// [`recv`]: crate::sync::broadcast::Receiver::recv |
| /// [`Receiver`]: crate::sync::broadcast::Receiver |
| </span><span class="attribute">#[derive(Debug, PartialEq, Eq, Clone)] |
| </span><span class="kw">pub enum </span>RecvError { |
| <span class="doccomment">/// There are no more active senders implying no further messages will ever |
| /// be sent. |
| </span>Closed, |
| |
| <span class="doccomment">/// The receiver lagged too far behind. Attempting to receive again will |
| /// return the oldest message still retained by the channel. |
| /// |
| /// Includes the number of skipped messages. |
| </span>Lagged(u64), |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>RecvError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="kw">match </span><span class="self">self </span>{ |
| RecvError::Closed => <span class="macro">write!</span>(f, <span class="string">"channel closed"</span>), |
| RecvError::Lagged(amt) => <span class="macro">write!</span>(f, <span class="string">"channel lagged by {}"</span>, amt), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>std::error::Error <span class="kw">for </span>RecvError {} |
| |
| <span class="doccomment">/// An error returned from the [`try_recv`] function on a [`Receiver`]. |
| /// |
| /// [`try_recv`]: crate::sync::broadcast::Receiver::try_recv |
| /// [`Receiver`]: crate::sync::broadcast::Receiver |
| </span><span class="attribute">#[derive(Debug, PartialEq, Eq, Clone)] |
| </span><span class="kw">pub enum </span>TryRecvError { |
| <span class="doccomment">/// The channel is currently empty. There are still active |
| /// [`Sender`] handles, so data may yet become available. |
| /// |
| /// [`Sender`]: crate::sync::broadcast::Sender |
| </span>Empty, |
| |
| <span class="doccomment">/// There are no more active senders implying no further messages will ever |
| /// be sent. |
| </span>Closed, |
| |
| <span class="doccomment">/// The receiver lagged too far behind and has been forcibly disconnected. |
| /// Attempting to receive again will return the oldest message still |
| /// retained by the channel. |
| /// |
| /// Includes the number of skipped messages. |
| </span>Lagged(u64), |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>TryRecvError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="kw">match </span><span class="self">self </span>{ |
| TryRecvError::Empty => <span class="macro">write!</span>(f, <span class="string">"channel empty"</span>), |
| TryRecvError::Closed => <span class="macro">write!</span>(f, <span class="string">"channel closed"</span>), |
| TryRecvError::Lagged(amt) => <span class="macro">write!</span>(f, <span class="string">"channel lagged by {}"</span>, amt), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>std::error::Error <span class="kw">for </span>TryRecvError {} |
| } |
| |
| <span class="kw">use </span><span class="self">self</span>::error::<span class="kw-2">*</span>; |
| |
| <span class="doccomment">/// Data shared between senders and receivers. |
| </span><span class="kw">struct </span>Shared<T> { |
| <span class="doccomment">/// slots in the channel. |
| </span>buffer: Box<[RwLock<Slot<T>>]>, |
| |
| <span class="doccomment">/// Mask a position -> index. |
| </span>mask: usize, |
| |
| <span class="doccomment">/// Tail of the queue. Includes the rx wait list. |
| </span>tail: Mutex<Tail>, |
| |
| <span class="doccomment">/// Number of outstanding Sender handles. |
| </span>num_tx: AtomicUsize, |
| } |
| |
| <span class="doccomment">/// Next position to write a value. |
| </span><span class="kw">struct </span>Tail { |
| <span class="doccomment">/// Next position to write to. |
| </span>pos: u64, |
| |
| <span class="doccomment">/// Number of active receivers. |
| </span>rx_cnt: usize, |
| |
| <span class="doccomment">/// True if the channel is closed. |
| </span>closed: bool, |
| |
| <span class="doccomment">/// Receivers waiting for a value. |
| </span>waiters: LinkedList<Waiter, <Waiter <span class="kw">as </span>linked_list::Link>::Target>, |
| } |
| |
| <span class="doccomment">/// Slot in the buffer. |
| </span><span class="kw">struct </span>Slot<T> { |
| <span class="doccomment">/// Remaining number of receivers that are expected to see this value. |
| /// |
| /// When this goes to zero, the value is released. |
| /// |
| /// An atomic is used as it is mutated concurrently with the slot read lock |
| /// acquired. |
| </span>rem: AtomicUsize, |
| |
| <span class="doccomment">/// Uniquely identifies the `send` stored in the slot. |
| </span>pos: u64, |
| |
| <span class="doccomment">/// The value being broadcast. |
| /// |
| /// The value is set by `send` when the write lock is held. When a reader |
| /// drops, `rem` is decremented. When it hits zero, the value is dropped. |
| </span>val: UnsafeCell<<span class="prelude-ty">Option</span><T>>, |
| } |
| |
| <span class="doccomment">/// An entry in the wait queue. |
| </span><span class="kw">struct </span>Waiter { |
| <span class="doccomment">/// True if queued. |
| </span>queued: bool, |
| |
| <span class="doccomment">/// Task waiting on the broadcast channel. |
| </span>waker: <span class="prelude-ty">Option</span><Waker>, |
| |
| <span class="doccomment">/// Intrusive linked-list pointers. |
| </span>pointers: linked_list::Pointers<Waiter>, |
| |
| <span class="doccomment">/// Should not be `Unpin`. |
| </span>_p: PhantomPinned, |
| } |
| |
| <span class="macro">generate_addr_of_methods! </span>{ |
| <span class="kw">impl</span><> Waiter { |
| <span class="kw">unsafe fn </span>addr_of_pointers(<span class="self">self</span>: NonNull<<span class="self">Self</span>>) -> NonNull<linked_list::Pointers<Waiter>> { |
| <span class="kw-2">&</span><span class="self">self</span>.pointers |
| } |
| } |
| } |
| |
| <span class="kw">struct </span>RecvGuard<<span class="lifetime">'a</span>, T> { |
| slot: RwLockReadGuard<<span class="lifetime">'a</span>, Slot<T>>, |
| } |
| |
| <span class="doccomment">/// Receive a value future. |
| </span><span class="kw">struct </span>Recv<<span class="lifetime">'a</span>, T> { |
| <span class="doccomment">/// Receiver being waited on. |
| </span>receiver: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>Receiver<T>, |
| |
| <span class="doccomment">/// Entry in the waiter `LinkedList`. |
| </span>waiter: UnsafeCell<Waiter>, |
| } |
| |
| <span class="kw">unsafe impl</span><<span class="lifetime">'a</span>, T: Send> Send <span class="kw">for </span>Recv<<span class="lifetime">'a</span>, T> {} |
| <span class="kw">unsafe impl</span><<span class="lifetime">'a</span>, T: Send> Sync <span class="kw">for </span>Recv<<span class="lifetime">'a</span>, T> {} |
| |
| <span class="doccomment">/// Max number of receivers. Reserve space to lock. |
| </span><span class="kw">const </span>MAX_RECEIVERS: usize = usize::MAX >> <span class="number">2</span>; |
| |
| <span class="doccomment">/// Create a bounded, multi-producer, multi-consumer channel where each sent |
| /// value is broadcasted to all active receivers. |
| /// |
| /// All data sent on [`Sender`] will become available on every active |
| /// [`Receiver`] in the same order as it was sent. |
| /// |
| /// The `Sender` can be cloned to `send` to the same channel from multiple |
| /// points in the process or it can be used concurrently from an `Arc`. New |
| /// `Receiver` handles are created by calling [`Sender::subscribe`]. |
| /// |
| /// If all [`Receiver`] handles are dropped, the `send` method will return a |
| /// [`SendError`]. Similarly, if all [`Sender`] handles are dropped, the [`recv`] |
| /// method will return a [`RecvError`]. |
| /// |
| /// [`Sender`]: crate::sync::broadcast::Sender |
| /// [`Sender::subscribe`]: crate::sync::broadcast::Sender::subscribe |
| /// [`Receiver`]: crate::sync::broadcast::Receiver |
| /// [`recv`]: crate::sync::broadcast::Receiver::recv |
| /// [`SendError`]: crate::sync::broadcast::error::SendError |
| /// [`RecvError`]: crate::sync::broadcast::error::RecvError |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx1) = broadcast::channel(16); |
| /// let mut rx2 = tx.subscribe(); |
| /// |
| /// tokio::spawn(async move { |
| /// assert_eq!(rx1.recv().await.unwrap(), 10); |
| /// assert_eq!(rx1.recv().await.unwrap(), 20); |
| /// }); |
| /// |
| /// tokio::spawn(async move { |
| /// assert_eq!(rx2.recv().await.unwrap(), 10); |
| /// assert_eq!(rx2.recv().await.unwrap(), 20); |
| /// }); |
| /// |
| /// tx.send(10).unwrap(); |
| /// tx.send(20).unwrap(); |
| /// } |
| /// ``` |
| /// |
| /// # Panics |
| /// |
| /// This will panic if `capacity` is equal to `0` or larger |
| /// than `usize::MAX / 2`. |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>channel<T: Clone>(<span class="kw-2">mut </span>capacity: usize) -> (Sender<T>, Receiver<T>) { |
| <span class="macro">assert!</span>(capacity > <span class="number">0</span>, <span class="string">"capacity is empty"</span>); |
| <span class="macro">assert!</span>(capacity <= usize::MAX >> <span class="number">1</span>, <span class="string">"requested capacity too large"</span>); |
| |
| <span class="comment">// Round to a power of two |
| </span>capacity = capacity.next_power_of_two(); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buffer = Vec::with_capacity(capacity); |
| |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..capacity { |
| buffer.push(RwLock::new(Slot { |
| rem: AtomicUsize::new(<span class="number">0</span>), |
| pos: (i <span class="kw">as </span>u64).wrapping_sub(capacity <span class="kw">as </span>u64), |
| val: UnsafeCell::new(<span class="prelude-val">None</span>), |
| })); |
| } |
| |
| <span class="kw">let </span>shared = Arc::new(Shared { |
| buffer: buffer.into_boxed_slice(), |
| mask: capacity - <span class="number">1</span>, |
| tail: Mutex::new(Tail { |
| pos: <span class="number">0</span>, |
| rx_cnt: <span class="number">1</span>, |
| closed: <span class="bool-val">false</span>, |
| waiters: LinkedList::new(), |
| }), |
| num_tx: AtomicUsize::new(<span class="number">1</span>), |
| }); |
| |
| <span class="kw">let </span>rx = Receiver { |
| shared: shared.clone(), |
| next: <span class="number">0</span>, |
| }; |
| |
| <span class="kw">let </span>tx = Sender { shared }; |
| |
| (tx, rx) |
| } |
| |
| <span class="kw">unsafe impl</span><T: Send> Send <span class="kw">for </span>Sender<T> {} |
| <span class="kw">unsafe impl</span><T: Send> Sync <span class="kw">for </span>Sender<T> {} |
| |
| <span class="kw">unsafe impl</span><T: Send> Send <span class="kw">for </span>Receiver<T> {} |
| <span class="kw">unsafe impl</span><T: Send> Sync <span class="kw">for </span>Receiver<T> {} |
| |
| <span class="kw">impl</span><T> Sender<T> { |
| <span class="doccomment">/// Attempts to send a value to all active [`Receiver`] handles, returning |
| /// it back if it could not be sent. |
| /// |
| /// A successful send occurs when there is at least one active [`Receiver`] |
| /// handle. An unsuccessful send would be one where all associated |
| /// [`Receiver`] handles have already been dropped. |
| /// |
| /// # Return |
| /// |
| /// On success, the number of subscribed [`Receiver`] handles is returned. |
| /// This does not mean that this number of receivers will see the message as |
| /// a receiver may drop before receiving the message. |
| /// |
| /// # Note |
| /// |
| /// A return value of `Ok` **does not** mean that the sent value will be |
| /// observed by all or any of the active [`Receiver`] handles. [`Receiver`] |
| /// handles may be dropped before receiving the sent message. |
| /// |
| /// A return value of `Err` **does not** mean that future calls to `send` |
| /// will fail. New [`Receiver`] handles may be created by calling |
| /// [`subscribe`]. |
| /// |
| /// [`Receiver`]: crate::sync::broadcast::Receiver |
| /// [`subscribe`]: crate::sync::broadcast::Sender::subscribe |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx1) = broadcast::channel(16); |
| /// let mut rx2 = tx.subscribe(); |
| /// |
| /// tokio::spawn(async move { |
| /// assert_eq!(rx1.recv().await.unwrap(), 10); |
| /// assert_eq!(rx1.recv().await.unwrap(), 20); |
| /// }); |
| /// |
| /// tokio::spawn(async move { |
| /// assert_eq!(rx2.recv().await.unwrap(), 10); |
| /// assert_eq!(rx2.recv().await.unwrap(), 20); |
| /// }); |
| /// |
| /// tx.send(10).unwrap(); |
| /// tx.send(20).unwrap(); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>send(<span class="kw-2">&</span><span class="self">self</span>, value: T) -> <span class="prelude-ty">Result</span><usize, SendError<T>> { |
| <span class="kw">let </span><span class="kw-2">mut </span>tail = <span class="self">self</span>.shared.tail.lock(); |
| |
| <span class="kw">if </span>tail.rx_cnt == <span class="number">0 </span>{ |
| <span class="kw">return </span><span class="prelude-val">Err</span>(SendError(value)); |
| } |
| |
| <span class="comment">// Position to write into |
| </span><span class="kw">let </span>pos = tail.pos; |
| <span class="kw">let </span>rem = tail.rx_cnt; |
| <span class="kw">let </span>idx = (pos & <span class="self">self</span>.shared.mask <span class="kw">as </span>u64) <span class="kw">as </span>usize; |
| |
| <span class="comment">// Update the tail position |
| </span>tail.pos = tail.pos.wrapping_add(<span class="number">1</span>); |
| |
| <span class="comment">// Get the slot |
| </span><span class="kw">let </span><span class="kw-2">mut </span>slot = <span class="self">self</span>.shared.buffer[idx].write().unwrap(); |
| |
| <span class="comment">// Track the position |
| </span>slot.pos = pos; |
| |
| <span class="comment">// Set remaining receivers |
| </span>slot.rem.with_mut(|v| <span class="kw-2">*</span>v = rem); |
| |
| <span class="comment">// Write the value |
| </span>slot.val = UnsafeCell::new(<span class="prelude-val">Some</span>(value)); |
| |
| <span class="comment">// Release the slot lock before notifying the receivers. |
| </span>drop(slot); |
| |
| <span class="comment">// Notify and release the mutex. This must happen after the slot lock is |
| // released, otherwise the writer lock bit could be cleared while another |
| // thread is in the critical section. |
| </span><span class="self">self</span>.shared.notify_rx(tail); |
| |
| <span class="prelude-val">Ok</span>(rem) |
| } |
| |
| <span class="doccomment">/// Creates a new [`Receiver`] handle that will receive values sent **after** |
| /// this call to `subscribe`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, _rx) = broadcast::channel(16); |
| /// |
| /// // Will not be seen |
| /// tx.send(10).unwrap(); |
| /// |
| /// let mut rx = tx.subscribe(); |
| /// |
| /// tx.send(20).unwrap(); |
| /// |
| /// let value = rx.recv().await.unwrap(); |
| /// assert_eq!(20, value); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>subscribe(<span class="kw-2">&</span><span class="self">self</span>) -> Receiver<T> { |
| <span class="kw">let </span>shared = <span class="self">self</span>.shared.clone(); |
| new_receiver(shared) |
| } |
| |
| <span class="doccomment">/// Returns the number of queued values. |
| /// |
| /// A value is queued until it has either been seen by all receivers that were alive at the time |
| /// it was sent, or has been evicted from the queue by subsequent sends that exceeded the |
| /// queue's capacity. |
| /// |
| /// # Note |
| /// |
| /// In contrast to [`Receiver::len`], this method only reports queued values and not values that |
| /// have been evicted from the queue before being seen by all receivers. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx1) = broadcast::channel(16); |
| /// let mut rx2 = tx.subscribe(); |
| /// |
| /// tx.send(10).unwrap(); |
| /// tx.send(20).unwrap(); |
| /// tx.send(30).unwrap(); |
| /// |
| /// assert_eq!(tx.len(), 3); |
| /// |
| /// rx1.recv().await.unwrap(); |
| /// |
| /// // The len is still 3 since rx2 hasn't seen the first value yet. |
| /// assert_eq!(tx.len(), 3); |
| /// |
| /// rx2.recv().await.unwrap(); |
| /// |
| /// assert_eq!(tx.len(), 2); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="kw">let </span>tail = <span class="self">self</span>.shared.tail.lock(); |
| |
| <span class="kw">let </span>base_idx = (tail.pos & <span class="self">self</span>.shared.mask <span class="kw">as </span>u64) <span class="kw">as </span>usize; |
| <span class="kw">let </span><span class="kw-2">mut </span>low = <span class="number">0</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>high = <span class="self">self</span>.shared.buffer.len(); |
| <span class="kw">while </span>low < high { |
| <span class="kw">let </span>mid = low + (high - low) / <span class="number">2</span>; |
| <span class="kw">let </span>idx = base_idx.wrapping_add(mid) & <span class="self">self</span>.shared.mask; |
| <span class="kw">if </span><span class="self">self</span>.shared.buffer[idx].read().unwrap().rem.load(SeqCst) == <span class="number">0 </span>{ |
| low = mid + <span class="number">1</span>; |
| } <span class="kw">else </span>{ |
| high = mid; |
| } |
| } |
| |
| <span class="self">self</span>.shared.buffer.len() - low |
| } |
| |
| <span class="doccomment">/// Returns true if there are no queued values. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx1) = broadcast::channel(16); |
| /// let mut rx2 = tx.subscribe(); |
| /// |
| /// assert!(tx.is_empty()); |
| /// |
| /// tx.send(10).unwrap(); |
| /// |
| /// assert!(!tx.is_empty()); |
| /// |
| /// rx1.recv().await.unwrap(); |
| /// |
| /// // The queue is still not empty since rx2 hasn't seen the value. |
| /// assert!(!tx.is_empty()); |
| /// |
| /// rx2.recv().await.unwrap(); |
| /// |
| /// assert!(tx.is_empty()); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="kw">let </span>tail = <span class="self">self</span>.shared.tail.lock(); |
| |
| <span class="kw">let </span>idx = (tail.pos.wrapping_sub(<span class="number">1</span>) & <span class="self">self</span>.shared.mask <span class="kw">as </span>u64) <span class="kw">as </span>usize; |
| <span class="self">self</span>.shared.buffer[idx].read().unwrap().rem.load(SeqCst) == <span class="number">0 |
| </span>} |
| |
| <span class="doccomment">/// Returns the number of active receivers |
| /// |
| /// An active receiver is a [`Receiver`] handle returned from [`channel`] or |
| /// [`subscribe`]. These are the handles that will receive values sent on |
| /// this [`Sender`]. |
| /// |
| /// # Note |
| /// |
| /// It is not guaranteed that a sent message will reach this number of |
| /// receivers. Active receivers may never call [`recv`] again before |
| /// dropping. |
| /// |
| /// [`recv`]: crate::sync::broadcast::Receiver::recv |
| /// [`Receiver`]: crate::sync::broadcast::Receiver |
| /// [`Sender`]: crate::sync::broadcast::Sender |
| /// [`subscribe`]: crate::sync::broadcast::Sender::subscribe |
| /// [`channel`]: crate::sync::broadcast::channel |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, _rx1) = broadcast::channel(16); |
| /// |
| /// assert_eq!(1, tx.receiver_count()); |
| /// |
| /// let mut _rx2 = tx.subscribe(); |
| /// |
| /// assert_eq!(2, tx.receiver_count()); |
| /// |
| /// tx.send(10).unwrap(); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>receiver_count(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="kw">let </span>tail = <span class="self">self</span>.shared.tail.lock(); |
| tail.rx_cnt |
| } |
| |
| <span class="doccomment">/// Returns `true` if senders belong to the same channel. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, _rx) = broadcast::channel::<()>(16); |
| /// let tx2 = tx.clone(); |
| /// |
| /// assert!(tx.same_channel(&tx2)); |
| /// |
| /// let (tx3, _rx3) = broadcast::channel::<()>(16); |
| /// |
| /// assert!(!tx3.same_channel(&tx2)); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>same_channel(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> bool { |
| Arc::ptr_eq(<span class="kw-2">&</span><span class="self">self</span>.shared, <span class="kw-2">&</span>other.shared) |
| } |
| |
| <span class="kw">fn </span>close_channel(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="kw">let </span><span class="kw-2">mut </span>tail = <span class="self">self</span>.shared.tail.lock(); |
| tail.closed = <span class="bool-val">true</span>; |
| |
| <span class="self">self</span>.shared.notify_rx(tail); |
| } |
| } |
| |
| <span class="doccomment">/// Create a new `Receiver` which reads starting from the tail. |
| </span><span class="kw">fn </span>new_receiver<T>(shared: Arc<Shared<T>>) -> Receiver<T> { |
| <span class="kw">let </span><span class="kw-2">mut </span>tail = shared.tail.lock(); |
| |
| <span class="kw">if </span>tail.rx_cnt == MAX_RECEIVERS { |
| <span class="macro">panic!</span>(<span class="string">"max receivers"</span>); |
| } |
| |
| tail.rx_cnt = tail.rx_cnt.checked_add(<span class="number">1</span>).expect(<span class="string">"overflow"</span>); |
| |
| <span class="kw">let </span>next = tail.pos; |
| |
| drop(tail); |
| |
| Receiver { shared, next } |
| } |
| |
| <span class="kw">impl</span><T> Shared<T> { |
| <span class="kw">fn </span>notify_rx<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>: <span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'b </span><span class="self">self</span>, <span class="kw-2">mut </span>tail: MutexGuard<<span class="lifetime">'a</span>, Tail>) { |
| <span class="kw">let </span><span class="kw-2">mut </span>wakers = WakeList::new(); |
| <span class="lifetime">'outer</span>: <span class="kw">loop </span>{ |
| <span class="kw">while </span>wakers.can_push() { |
| <span class="kw">match </span>tail.waiters.pop_back() { |
| <span class="prelude-val">Some</span>(<span class="kw-2">mut </span>waiter) => { |
| <span class="comment">// Safety: `tail` lock is still held. |
| </span><span class="kw">let </span>waiter = <span class="kw">unsafe </span>{ waiter.as_mut() }; |
| |
| <span class="macro">assert!</span>(waiter.queued); |
| waiter.queued = <span class="bool-val">false</span>; |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(waker) = waiter.waker.take() { |
| wakers.push(waker); |
| } |
| } |
| <span class="prelude-val">None </span>=> { |
| <span class="kw">break </span><span class="lifetime">'outer</span>; |
| } |
| } |
| } |
| |
| <span class="comment">// Release the lock before waking. |
| </span>drop(tail); |
| |
| <span class="comment">// Before we acquire the lock again all sorts of things can happen: |
| // some waiters may remove themselves from the list and new waiters |
| // may be added. This is fine since at worst we will unnecessarily |
| // wake up waiters which will then queue themselves again. |
| |
| </span>wakers.wake_all(); |
| |
| <span class="comment">// Acquire the lock again. |
| </span>tail = <span class="self">self</span>.tail.lock(); |
| } |
| |
| <span class="comment">// Release the lock before waking. |
| </span>drop(tail); |
| |
| wakers.wake_all(); |
| } |
| } |
| |
| <span class="kw">impl</span><T> Clone <span class="kw">for </span>Sender<T> { |
| <span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> Sender<T> { |
| <span class="kw">let </span>shared = <span class="self">self</span>.shared.clone(); |
| shared.num_tx.fetch_add(<span class="number">1</span>, SeqCst); |
| |
| Sender { shared } |
| } |
| } |
| |
| <span class="kw">impl</span><T> Drop <span class="kw">for </span>Sender<T> { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="kw">if </span><span class="number">1 </span>== <span class="self">self</span>.shared.num_tx.fetch_sub(<span class="number">1</span>, SeqCst) { |
| <span class="self">self</span>.close_channel(); |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> Receiver<T> { |
| <span class="doccomment">/// Returns the number of messages that were sent into the channel and that |
| /// this [`Receiver`] has yet to receive. |
| /// |
| /// If the returned value from `len` is larger than the next largest power of 2 |
| /// of the capacity of the channel any call to [`recv`] will return an |
| /// `Err(RecvError::Lagged)` and any call to [`try_recv`] will return an |
| /// `Err(TryRecvError::Lagged)`, e.g. if the capacity of the channel is 10, |
| /// [`recv`] will start to return `Err(RecvError::Lagged)` once `len` returns |
| /// values larger than 16. |
| /// |
| /// [`Receiver`]: crate::sync::broadcast::Receiver |
| /// [`recv`]: crate::sync::broadcast::Receiver::recv |
| /// [`try_recv`]: crate::sync::broadcast::Receiver::try_recv |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx1) = broadcast::channel(16); |
| /// |
| /// tx.send(10).unwrap(); |
| /// tx.send(20).unwrap(); |
| /// |
| /// assert_eq!(rx1.len(), 2); |
| /// assert_eq!(rx1.recv().await.unwrap(), 10); |
| /// assert_eq!(rx1.len(), 1); |
| /// assert_eq!(rx1.recv().await.unwrap(), 20); |
| /// assert_eq!(rx1.len(), 0); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="kw">let </span>next_send_pos = <span class="self">self</span>.shared.tail.lock().pos; |
| (next_send_pos - <span class="self">self</span>.next) <span class="kw">as </span>usize |
| } |
| |
| <span class="doccomment">/// Returns true if there aren't any messages in the channel that the [`Receiver`] |
| /// has yet to receive. |
| /// |
| /// [`Receiver]: create::sync::broadcast::Receiver |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx1) = broadcast::channel(16); |
| /// |
| /// assert!(rx1.is_empty()); |
| /// |
| /// tx.send(10).unwrap(); |
| /// tx.send(20).unwrap(); |
| /// |
| /// assert!(!rx1.is_empty()); |
| /// assert_eq!(rx1.recv().await.unwrap(), 10); |
| /// assert_eq!(rx1.recv().await.unwrap(), 20); |
| /// assert!(rx1.is_empty()); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.len() == <span class="number">0 |
| </span>} |
| |
| <span class="doccomment">/// Returns `true` if receivers belong to the same channel. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, rx) = broadcast::channel::<()>(16); |
| /// let rx2 = tx.subscribe(); |
| /// |
| /// assert!(rx.same_channel(&rx2)); |
| /// |
| /// let (_tx3, rx3) = broadcast::channel::<()>(16); |
| /// |
| /// assert!(!rx3.same_channel(&rx2)); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>same_channel(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> bool { |
| Arc::ptr_eq(<span class="kw-2">&</span><span class="self">self</span>.shared, <span class="kw-2">&</span>other.shared) |
| } |
| |
| <span class="doccomment">/// Locks the next value if there is one. |
| </span><span class="kw">fn </span>recv_ref( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| waiter: <span class="prelude-ty">Option</span><(<span class="kw-2">&</span>UnsafeCell<Waiter>, <span class="kw-2">&</span>Waker)>, |
| ) -> <span class="prelude-ty">Result</span><RecvGuard<<span class="lifetime">'_</span>, T>, TryRecvError> { |
| <span class="kw">let </span>idx = (<span class="self">self</span>.next & <span class="self">self</span>.shared.mask <span class="kw">as </span>u64) <span class="kw">as </span>usize; |
| |
| <span class="comment">// The slot holding the next value to read |
| </span><span class="kw">let </span><span class="kw-2">mut </span>slot = <span class="self">self</span>.shared.buffer[idx].read().unwrap(); |
| |
| <span class="kw">if </span>slot.pos != <span class="self">self</span>.next { |
| <span class="comment">// Release the `slot` lock before attempting to acquire the `tail` |
| // lock. This is required because `send2` acquires the tail lock |
| // first followed by the slot lock. Acquiring the locks in reverse |
| // order here would result in a potential deadlock: `recv_ref` |
| // acquires the `slot` lock and attempts to acquire the `tail` lock |
| // while `send2` acquired the `tail` lock and attempts to acquire |
| // the slot lock. |
| </span>drop(slot); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>old_waker = <span class="prelude-val">None</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>tail = <span class="self">self</span>.shared.tail.lock(); |
| |
| <span class="comment">// Acquire slot lock again |
| </span>slot = <span class="self">self</span>.shared.buffer[idx].read().unwrap(); |
| |
| <span class="comment">// Make sure the position did not change. This could happen in the |
| // unlikely event that the buffer is wrapped between dropping the |
| // read lock and acquiring the tail lock. |
| </span><span class="kw">if </span>slot.pos != <span class="self">self</span>.next { |
| <span class="kw">let </span>next_pos = slot.pos.wrapping_add(<span class="self">self</span>.shared.buffer.len() <span class="kw">as </span>u64); |
| |
| <span class="kw">if </span>next_pos == <span class="self">self</span>.next { |
| <span class="comment">// At this point the channel is empty for *this* receiver. If |
| // it's been closed, then that's what we return, otherwise we |
| // set a waker and return empty. |
| </span><span class="kw">if </span>tail.closed { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(TryRecvError::Closed); |
| } |
| |
| <span class="comment">// Store the waker |
| </span><span class="kw">if let </span><span class="prelude-val">Some</span>((waiter, waker)) = waiter { |
| <span class="comment">// Safety: called while locked. |
| </span><span class="kw">unsafe </span>{ |
| <span class="comment">// Only queue if not already queued |
| </span>waiter.with_mut(|ptr| { |
| <span class="comment">// If there is no waker **or** if the currently |
| // stored waker references a **different** task, |
| // track the tasks' waker to be notified on |
| // receipt of a new value. |
| </span><span class="kw">match </span>(<span class="kw-2">*</span>ptr).waker { |
| <span class="prelude-val">Some</span>(<span class="kw-2">ref </span>w) <span class="kw">if </span>w.will_wake(waker) => {} |
| <span class="kw">_ </span>=> { |
| old_waker = std::mem::replace( |
| <span class="kw-2">&mut </span>(<span class="kw-2">*</span>ptr).waker, |
| <span class="prelude-val">Some</span>(waker.clone()), |
| ); |
| } |
| } |
| |
| <span class="kw">if </span>!(<span class="kw-2">*</span>ptr).queued { |
| (<span class="kw-2">*</span>ptr).queued = <span class="bool-val">true</span>; |
| tail.waiters.push_front(NonNull::new_unchecked(<span class="kw-2">&mut *</span>ptr)); |
| } |
| }); |
| } |
| } |
| |
| <span class="comment">// Drop the old waker after releasing the locks. |
| </span>drop(slot); |
| drop(tail); |
| drop(old_waker); |
| |
| <span class="kw">return </span><span class="prelude-val">Err</span>(TryRecvError::Empty); |
| } |
| |
| <span class="comment">// At this point, the receiver has lagged behind the sender by |
| // more than the channel capacity. The receiver will attempt to |
| // catch up by skipping dropped messages and setting the |
| // internal cursor to the **oldest** message stored by the |
| // channel. |
| </span><span class="kw">let </span>next = tail.pos.wrapping_sub(<span class="self">self</span>.shared.buffer.len() <span class="kw">as </span>u64); |
| |
| <span class="kw">let </span>missed = next.wrapping_sub(<span class="self">self</span>.next); |
| |
| drop(tail); |
| |
| <span class="comment">// The receiver is slow but no values have been missed |
| </span><span class="kw">if </span>missed == <span class="number">0 </span>{ |
| <span class="self">self</span>.next = <span class="self">self</span>.next.wrapping_add(<span class="number">1</span>); |
| |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(RecvGuard { slot }); |
| } |
| |
| <span class="self">self</span>.next = next; |
| |
| <span class="kw">return </span><span class="prelude-val">Err</span>(TryRecvError::Lagged(missed)); |
| } |
| } |
| |
| <span class="self">self</span>.next = <span class="self">self</span>.next.wrapping_add(<span class="number">1</span>); |
| |
| <span class="prelude-val">Ok</span>(RecvGuard { slot }) |
| } |
| } |
| |
| <span class="kw">impl</span><T: Clone> Receiver<T> { |
| <span class="doccomment">/// Re-subscribes to the channel starting from the current tail element. |
| /// |
| /// This [`Receiver`] handle will receive a clone of all values sent |
| /// **after** it has resubscribed. This will not include elements that are |
| /// in the queue of the current receiver. Consider the following example. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx) = broadcast::channel(2); |
| /// |
| /// tx.send(1).unwrap(); |
| /// let mut rx2 = rx.resubscribe(); |
| /// tx.send(2).unwrap(); |
| /// |
| /// assert_eq!(rx2.recv().await.unwrap(), 2); |
| /// assert_eq!(rx.recv().await.unwrap(), 1); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>resubscribe(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{ |
| <span class="kw">let </span>shared = <span class="self">self</span>.shared.clone(); |
| new_receiver(shared) |
| } |
| <span class="doccomment">/// Receives the next value for this receiver. |
| /// |
| /// Each [`Receiver`] handle will receive a clone of all values sent |
| /// **after** it has subscribed. |
| /// |
| /// `Err(RecvError::Closed)` is returned when all `Sender` halves have |
| /// dropped, indicating that no further values can be sent on the channel. |
| /// |
| /// If the [`Receiver`] handle falls behind, once the channel is full, newly |
| /// sent values will overwrite old values. At this point, a call to [`recv`] |
| /// will return with `Err(RecvError::Lagged)` and the [`Receiver`]'s |
| /// internal cursor is updated to point to the oldest value still held by |
| /// the channel. A subsequent call to [`recv`] will return this value |
| /// **unless** it has been since overwritten. |
| /// |
| /// # Cancel safety |
| /// |
| /// This method is cancel safe. If `recv` is used as the event in a |
| /// [`tokio::select!`](crate::select) statement and some other branch |
| /// completes first, it is guaranteed that no messages were received on this |
| /// channel. |
| /// |
| /// [`Receiver`]: crate::sync::broadcast::Receiver |
| /// [`recv`]: crate::sync::broadcast::Receiver::recv |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx1) = broadcast::channel(16); |
| /// let mut rx2 = tx.subscribe(); |
| /// |
| /// tokio::spawn(async move { |
| /// assert_eq!(rx1.recv().await.unwrap(), 10); |
| /// assert_eq!(rx1.recv().await.unwrap(), 20); |
| /// }); |
| /// |
| /// tokio::spawn(async move { |
| /// assert_eq!(rx2.recv().await.unwrap(), 10); |
| /// assert_eq!(rx2.recv().await.unwrap(), 20); |
| /// }); |
| /// |
| /// tx.send(10).unwrap(); |
| /// tx.send(20).unwrap(); |
| /// } |
| /// ``` |
| /// |
| /// Handling lag |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx) = broadcast::channel(2); |
| /// |
| /// tx.send(10).unwrap(); |
| /// tx.send(20).unwrap(); |
| /// tx.send(30).unwrap(); |
| /// |
| /// // The receiver lagged behind |
| /// assert!(rx.recv().await.is_err()); |
| /// |
| /// // At this point, we can abort or continue with lost messages |
| /// |
| /// assert_eq!(20, rx.recv().await.unwrap()); |
| /// assert_eq!(30, rx.recv().await.unwrap()); |
| /// } |
| /// ``` |
| </span><span class="kw">pub async fn </span>recv(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><T, RecvError> { |
| <span class="kw">let </span>fut = Recv::new(<span class="self">self</span>); |
| fut.<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Attempts to return a pending value on this receiver without awaiting. |
| /// |
| /// This is useful for a flavor of "optimistic check" before deciding to |
| /// await on a receiver. |
| /// |
| /// Compared with [`recv`], this function has three failure cases instead of two |
| /// (one for closed, one for an empty buffer, one for a lagging receiver). |
| /// |
| /// `Err(TryRecvError::Closed)` is returned when all `Sender` halves have |
| /// dropped, indicating that no further values can be sent on the channel. |
| /// |
| /// If the [`Receiver`] handle falls behind, once the channel is full, newly |
| /// sent values will overwrite old values. At this point, a call to [`recv`] |
| /// will return with `Err(TryRecvError::Lagged)` and the [`Receiver`]'s |
| /// internal cursor is updated to point to the oldest value still held by |
| /// the channel. A subsequent call to [`try_recv`] will return this value |
| /// **unless** it has been since overwritten. If there are no values to |
| /// receive, `Err(TryRecvError::Empty)` is returned. |
| /// |
| /// [`recv`]: crate::sync::broadcast::Receiver::recv |
| /// [`try_recv`]: crate::sync::broadcast::Receiver::try_recv |
| /// [`Receiver`]: crate::sync::broadcast::Receiver |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::sync::broadcast; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let (tx, mut rx) = broadcast::channel(16); |
| /// |
| /// assert!(rx.try_recv().is_err()); |
| /// |
| /// tx.send(10).unwrap(); |
| /// |
| /// let value = rx.try_recv().unwrap(); |
| /// assert_eq!(10, value); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>try_recv(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><T, TryRecvError> { |
| <span class="kw">let </span>guard = <span class="self">self</span>.recv_ref(<span class="prelude-val">None</span>)<span class="question-mark">?</span>; |
| guard.clone_value().ok_or(TryRecvError::Closed) |
| } |
| } |
| |
| <span class="kw">impl</span><T> Drop <span class="kw">for </span>Receiver<T> { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="kw">let </span><span class="kw-2">mut </span>tail = <span class="self">self</span>.shared.tail.lock(); |
| |
| tail.rx_cnt -= <span class="number">1</span>; |
| <span class="kw">let </span>until = tail.pos; |
| |
| drop(tail); |
| |
| <span class="kw">while </span><span class="self">self</span>.next < until { |
| <span class="kw">match </span><span class="self">self</span>.recv_ref(<span class="prelude-val">None</span>) { |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => {} |
| <span class="comment">// The channel is closed |
| </span><span class="prelude-val">Err</span>(TryRecvError::Closed) => <span class="kw">break</span>, |
| <span class="comment">// Ignore lagging, we will catch up |
| </span><span class="prelude-val">Err</span>(TryRecvError::Lagged(..)) => {} |
| <span class="comment">// Can't be empty |
| </span><span class="prelude-val">Err</span>(TryRecvError::Empty) => <span class="macro">panic!</span>(<span class="string">"unexpected empty broadcast channel"</span>), |
| } |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, T> Recv<<span class="lifetime">'a</span>, T> { |
| <span class="kw">fn </span>new(receiver: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>Receiver<T>) -> Recv<<span class="lifetime">'a</span>, T> { |
| Recv { |
| receiver, |
| waiter: UnsafeCell::new(Waiter { |
| queued: <span class="bool-val">false</span>, |
| waker: <span class="prelude-val">None</span>, |
| pointers: linked_list::Pointers::new(), |
| _p: PhantomPinned, |
| }), |
| } |
| } |
| |
| <span class="doccomment">/// A custom `project` implementation is used in place of `pin-project-lite` |
| /// as a custom drop implementation is needed. |
| </span><span class="kw">fn </span>project(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>) -> (<span class="kw-2">&mut </span>Receiver<T>, <span class="kw-2">&</span>UnsafeCell<Waiter>) { |
| <span class="kw">unsafe </span>{ |
| <span class="comment">// Safety: Receiver is Unpin |
| </span>is_unpin::<<span class="kw-2">&mut </span>Receiver<T>>(); |
| |
| <span class="kw">let </span>me = <span class="self">self</span>.get_unchecked_mut(); |
| (me.receiver, <span class="kw-2">&</span>me.waiter) |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, T> Future <span class="kw">for </span>Recv<<span class="lifetime">'a</span>, T> |
| <span class="kw">where |
| </span>T: Clone, |
| { |
| <span class="kw">type </span>Output = <span class="prelude-ty">Result</span><T, RecvError>; |
| |
| <span class="kw">fn </span>poll(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><T, RecvError>> { |
| <span class="kw">let </span>(receiver, waiter) = <span class="self">self</span>.project(); |
| |
| <span class="kw">let </span>guard = <span class="kw">match </span>receiver.recv_ref(<span class="prelude-val">Some</span>((waiter, cx.waker()))) { |
| <span class="prelude-val">Ok</span>(value) => value, |
| <span class="prelude-val">Err</span>(TryRecvError::Empty) => <span class="kw">return </span>Poll::Pending, |
| <span class="prelude-val">Err</span>(TryRecvError::Lagged(n)) => <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Err</span>(RecvError::Lagged(n))), |
| <span class="prelude-val">Err</span>(TryRecvError::Closed) => <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Err</span>(RecvError::Closed)), |
| }; |
| |
| Poll::Ready(guard.clone_value().ok_or(RecvError::Closed)) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, T> Drop <span class="kw">for </span>Recv<<span class="lifetime">'a</span>, T> { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="comment">// Acquire the tail lock. This is required for safety before accessing |
| // the waiter node. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>tail = <span class="self">self</span>.receiver.shared.tail.lock(); |
| |
| <span class="comment">// safety: tail lock is held |
| </span><span class="kw">let </span>queued = <span class="self">self</span>.waiter.with(|ptr| <span class="kw">unsafe </span>{ (<span class="kw-2">*</span>ptr).queued }); |
| |
| <span class="kw">if </span>queued { |
| <span class="comment">// Remove the node |
| // |
| // safety: tail lock is held and the wait node is verified to be in |
| // the list. |
| </span><span class="kw">unsafe </span>{ |
| <span class="self">self</span>.waiter.with_mut(|ptr| { |
| tail.waiters.remove((<span class="kw-2">&mut *</span>ptr).into()); |
| }); |
| } |
| } |
| } |
| } |
| |
| <span class="doccomment">/// # Safety |
| /// |
| /// `Waiter` is forced to be !Unpin. |
| </span><span class="kw">unsafe impl </span>linked_list::Link <span class="kw">for </span>Waiter { |
| <span class="kw">type </span>Handle = NonNull<Waiter>; |
| <span class="kw">type </span>Target = Waiter; |
| |
| <span class="kw">fn </span>as_raw(handle: <span class="kw-2">&</span>NonNull<Waiter>) -> NonNull<Waiter> { |
| <span class="kw-2">*</span>handle |
| } |
| |
| <span class="kw">unsafe fn </span>from_raw(ptr: NonNull<Waiter>) -> NonNull<Waiter> { |
| ptr |
| } |
| |
| <span class="kw">unsafe fn </span>pointers(target: NonNull<Waiter>) -> NonNull<linked_list::Pointers<Waiter>> { |
| Waiter::addr_of_pointers(target) |
| } |
| } |
| |
| <span class="kw">impl</span><T> fmt::Debug <span class="kw">for </span>Sender<T> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="macro">write!</span>(fmt, <span class="string">"broadcast::Sender"</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><T> fmt::Debug <span class="kw">for </span>Receiver<T> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="macro">write!</span>(fmt, <span class="string">"broadcast::Receiver"</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, T> RecvGuard<<span class="lifetime">'a</span>, T> { |
| <span class="kw">fn </span>clone_value(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><T> |
| <span class="kw">where |
| </span>T: Clone, |
| { |
| <span class="self">self</span>.slot.val.with(|ptr| <span class="kw">unsafe </span>{ (<span class="kw-2">*</span>ptr).clone() }) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, T> Drop <span class="kw">for </span>RecvGuard<<span class="lifetime">'a</span>, T> { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="comment">// Decrement the remaining counter |
| </span><span class="kw">if </span><span class="number">1 </span>== <span class="self">self</span>.slot.rem.fetch_sub(<span class="number">1</span>, SeqCst) { |
| <span class="comment">// Safety: Last receiver, drop the value |
| </span><span class="self">self</span>.slot.val.with_mut(|ptr| <span class="kw">unsafe </span>{ <span class="kw-2">*</span>ptr = <span class="prelude-val">None </span>}); |
| } |
| } |
| } |
| |
| <span class="kw">fn </span>is_unpin<T: Unpin>() {} |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |