| <!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/git/checkouts/tokio-377c595163f99a10/dfe252d/tokio/src/sync/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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> |
| </pre><pre class="rust"><code><span class="attribute">#![cfg_attr(loom, allow(dead_code, unreachable_pub, unused_imports))] |
| |
| </span><span class="doccomment">//! Synchronization primitives for use in asynchronous contexts. |
| //! |
| //! Tokio programs tend to be organized as a set of [tasks] where each task |
| //! operates independently and may be executed on separate physical threads. The |
| //! synchronization primitives provided in this module permit these independent |
| //! tasks to communicate together. |
| //! |
| //! [tasks]: crate::task |
| //! |
| //! # Message passing |
| //! |
| //! The most common form of synchronization in a Tokio program is message |
| //! passing. Two tasks operate independently and send messages to each other to |
| //! synchronize. Doing so has the advantage of avoiding shared state. |
| //! |
| //! Message passing is implemented using channels. A channel supports sending a |
| //! message from one producer task to one or more consumer tasks. There are a |
| //! few flavors of channels provided by Tokio. Each channel flavor supports |
| //! different message passing patterns. When a channel supports multiple |
| //! producers, many separate tasks may **send** messages. When a channel |
| //! supports multiple consumers, many different separate tasks may **receive** |
| //! messages. |
| //! |
| //! Tokio provides many different channel flavors as different message passing |
| //! patterns are best handled with different implementations. |
| //! |
| //! ## `oneshot` channel |
| //! |
| //! The [`oneshot` channel][oneshot] supports sending a **single** value from a |
| //! single producer to a single consumer. This channel is usually used to send |
| //! the result of a computation to a waiter. |
| //! |
| //! **Example:** using a [`oneshot` channel][oneshot] to receive the result of a |
| //! computation. |
| //! |
| //! ``` |
| //! use tokio::sync::oneshot; |
| //! |
| //! async fn some_computation() -> String { |
| //! "represents the result of the computation".to_string() |
| //! } |
| //! |
| //! #[tokio::main] |
| //! async fn main() { |
| //! let (tx, rx) = oneshot::channel(); |
| //! |
| //! tokio::spawn(async move { |
| //! let res = some_computation().await; |
| //! tx.send(res).unwrap(); |
| //! }); |
| //! |
| //! // Do other work while the computation is happening in the background |
| //! |
| //! // Wait for the computation result |
| //! let res = rx.await.unwrap(); |
| //! } |
| //! ``` |
| //! |
| //! Note, if the task produces a computation result as its final |
| //! action before terminating, the [`JoinHandle`] can be used to |
| //! receive that value instead of allocating resources for the |
| //! `oneshot` channel. Awaiting on [`JoinHandle`] returns `Result`. If |
| //! the task panics, the `Joinhandle` yields `Err` with the panic |
| //! cause. |
| //! |
| //! **Example:** |
| //! |
| //! ``` |
| //! async fn some_computation() -> String { |
| //! "the result of the computation".to_string() |
| //! } |
| //! |
| //! #[tokio::main] |
| //! async fn main() { |
| //! let join_handle = tokio::spawn(async move { |
| //! some_computation().await |
| //! }); |
| //! |
| //! // Do other work while the computation is happening in the background |
| //! |
| //! // Wait for the computation result |
| //! let res = join_handle.await.unwrap(); |
| //! } |
| //! ``` |
| //! |
| //! [oneshot]: oneshot |
| //! [`JoinHandle`]: crate::task::JoinHandle |
| //! |
| //! ## `mpsc` channel |
| //! |
| //! The [`mpsc` channel][mpsc] supports sending **many** values from **many** |
| //! producers to a single consumer. This channel is often used to send work to a |
| //! task or to receive the result of many computations. |
| //! |
| //! This is also the channel you should use if you want to send many messages |
| //! from a single producer to a single consumer. There is no dedicated spsc |
| //! channel. |
| //! |
| //! **Example:** using an mpsc to incrementally stream the results of a series |
| //! of computations. |
| //! |
| //! ``` |
| //! use tokio::sync::mpsc; |
| //! |
| //! async fn some_computation(input: u32) -> String { |
| //! format!("the result of computation {}", input) |
| //! } |
| //! |
| //! #[tokio::main] |
| //! async fn main() { |
| //! let (tx, mut rx) = mpsc::channel(100); |
| //! |
| //! tokio::spawn(async move { |
| //! for i in 0..10 { |
| //! let res = some_computation(i).await; |
| //! tx.send(res).await.unwrap(); |
| //! } |
| //! }); |
| //! |
| //! while let Some(res) = rx.recv().await { |
| //! println!("got = {}", res); |
| //! } |
| //! } |
| //! ``` |
| //! |
| //! The argument to `mpsc::channel` is the channel capacity. This is the maximum |
| //! number of values that can be stored in the channel pending receipt at any |
| //! given time. Properly setting this value is key in implementing robust |
| //! programs as the channel capacity plays a critical part in handling back |
| //! pressure. |
| //! |
| //! A common concurrency pattern for resource management is to spawn a task |
| //! dedicated to managing that resource and using message passing between other |
| //! tasks to interact with the resource. The resource may be anything that may |
| //! not be concurrently used. Some examples include a socket and program state. |
| //! For example, if multiple tasks need to send data over a single socket, spawn |
| //! a task to manage the socket and use a channel to synchronize. |
| //! |
| //! **Example:** sending data from many tasks over a single socket using message |
| //! passing. |
| //! |
| //! ```no_run |
| //! use tokio::io::{self, AsyncWriteExt}; |
| //! use tokio::net::TcpStream; |
| //! use tokio::sync::mpsc; |
| //! |
| //! #[tokio::main] |
| //! async fn main() -> io::Result<()> { |
| //! let mut socket = TcpStream::connect("www.example.com:1234").await?; |
| //! let (tx, mut rx) = mpsc::channel(100); |
| //! |
| //! for _ in 0..10 { |
| //! // Each task needs its own `tx` handle. This is done by cloning the |
| //! // original handle. |
| //! let tx = tx.clone(); |
| //! |
| //! tokio::spawn(async move { |
| //! tx.send(&b"data to write"[..]).await.unwrap(); |
| //! }); |
| //! } |
| //! |
| //! // The `rx` half of the channel returns `None` once **all** `tx` clones |
| //! // drop. To ensure `None` is returned, drop the handle owned by the |
| //! // current task. If this `tx` handle is not dropped, there will always |
| //! // be a single outstanding `tx` handle. |
| //! drop(tx); |
| //! |
| //! while let Some(res) = rx.recv().await { |
| //! socket.write_all(res).await?; |
| //! } |
| //! |
| //! Ok(()) |
| //! } |
| //! ``` |
| //! |
| //! The [`mpsc`][mpsc] and [`oneshot`][oneshot] channels can be combined to |
| //! provide a request / response type synchronization pattern with a shared |
| //! resource. A task is spawned to synchronize a resource and waits on commands |
| //! received on a [`mpsc`][mpsc] channel. Each command includes a |
| //! [`oneshot`][oneshot] `Sender` on which the result of the command is sent. |
| //! |
| //! **Example:** use a task to synchronize a `u64` counter. Each task sends an |
| //! "fetch and increment" command. The counter value **before** the increment is |
| //! sent over the provided `oneshot` channel. |
| //! |
| //! ``` |
| //! use tokio::sync::{oneshot, mpsc}; |
| //! use Command::Increment; |
| //! |
| //! enum Command { |
| //! Increment, |
| //! // Other commands can be added here |
| //! } |
| //! |
| //! #[tokio::main] |
| //! async fn main() { |
| //! let (cmd_tx, mut cmd_rx) = mpsc::channel::<(Command, oneshot::Sender<u64>)>(100); |
| //! |
| //! // Spawn a task to manage the counter |
| //! tokio::spawn(async move { |
| //! let mut counter: u64 = 0; |
| //! |
| //! while let Some((cmd, response)) = cmd_rx.recv().await { |
| //! match cmd { |
| //! Increment => { |
| //! let prev = counter; |
| //! counter += 1; |
| //! response.send(prev).unwrap(); |
| //! } |
| //! } |
| //! } |
| //! }); |
| //! |
| //! let mut join_handles = vec![]; |
| //! |
| //! // Spawn tasks that will send the increment command. |
| //! for _ in 0..10 { |
| //! let cmd_tx = cmd_tx.clone(); |
| //! |
| //! join_handles.push(tokio::spawn(async move { |
| //! let (resp_tx, resp_rx) = oneshot::channel(); |
| //! |
| //! cmd_tx.send((Increment, resp_tx)).await.ok().unwrap(); |
| //! let res = resp_rx.await.unwrap(); |
| //! |
| //! println!("previous value = {}", res); |
| //! })); |
| //! } |
| //! |
| //! // Wait for all tasks to complete |
| //! for join_handle in join_handles.drain(..) { |
| //! join_handle.await.unwrap(); |
| //! } |
| //! } |
| //! ``` |
| //! |
| //! [mpsc]: mpsc |
| //! |
| //! ## `broadcast` channel |
| //! |
| //! The [`broadcast` channel] supports sending **many** values from |
| //! **many** producers to **many** consumers. Each consumer will receive |
| //! **each** value. This channel can be used to implement "fan out" style |
| //! patterns common with pub / sub or "chat" systems. |
| //! |
| //! This channel tends to be used less often than `oneshot` and `mpsc` but still |
| //! has its use cases. |
| //! |
| //! This is also the channel you should use if you want to broadcast values from |
| //! a single producer to many consumers. There is no dedicated spmc broadcast |
| //! channel. |
| //! |
| //! 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(); |
| //! } |
| //! ``` |
| //! |
| //! [`broadcast` channel]: crate::sync::broadcast |
| //! |
| //! ## `watch` channel |
| //! |
| //! The [`watch` channel] supports sending **many** values from a **single** |
| //! producer to **many** consumers. However, only the **most recent** value is |
| //! stored in the channel. Consumers are notified when a new value is sent, but |
| //! there is no guarantee that consumers will see **all** values. |
| //! |
| //! The [`watch` channel] is similar to a [`broadcast` channel] with capacity 1. |
| //! |
| //! Use cases for the [`watch` channel] include broadcasting configuration |
| //! changes or signalling program state changes, such as transitioning to |
| //! shutdown. |
| //! |
| //! **Example:** use a [`watch` channel] to notify tasks of configuration |
| //! changes. In this example, a configuration file is checked periodically. When |
| //! the file changes, the configuration changes are signalled to consumers. |
| //! |
| //! ``` |
| //! use tokio::sync::watch; |
| //! use tokio::time::{self, Duration, Instant}; |
| //! |
| //! use std::io; |
| //! |
| //! #[derive(Debug, Clone, Eq, PartialEq)] |
| //! struct Config { |
| //! timeout: Duration, |
| //! } |
| //! |
| //! impl Config { |
| //! async fn load_from_file() -> io::Result<Config> { |
| //! // file loading and deserialization logic here |
| //! # Ok(Config { timeout: Duration::from_secs(1) }) |
| //! } |
| //! } |
| //! |
| //! async fn my_async_operation() { |
| //! // Do something here |
| //! } |
| //! |
| //! #[tokio::main] |
| //! async fn main() { |
| //! // Load initial configuration value |
| //! let mut config = Config::load_from_file().await.unwrap(); |
| //! |
| //! // Create the watch channel, initialized with the loaded configuration |
| //! let (tx, rx) = watch::channel(config.clone()); |
| //! |
| //! // Spawn a task to monitor the file. |
| //! tokio::spawn(async move { |
| //! loop { |
| //! // Wait 10 seconds between checks |
| //! time::sleep(Duration::from_secs(10)).await; |
| //! |
| //! // Load the configuration file |
| //! let new_config = Config::load_from_file().await.unwrap(); |
| //! |
| //! // If the configuration changed, send the new config value |
| //! // on the watch channel. |
| //! if new_config != config { |
| //! tx.send(new_config.clone()).unwrap(); |
| //! config = new_config; |
| //! } |
| //! } |
| //! }); |
| //! |
| //! let mut handles = vec![]; |
| //! |
| //! // Spawn tasks that runs the async operation for at most `timeout`. If |
| //! // the timeout elapses, restart the operation. |
| //! // |
| //! // The task simultaneously watches the `Config` for changes. When the |
| //! // timeout duration changes, the timeout is updated without restarting |
| //! // the in-flight operation. |
| //! for _ in 0..5 { |
| //! // Clone a config watch handle for use in this task |
| //! let mut rx = rx.clone(); |
| //! |
| //! let handle = tokio::spawn(async move { |
| //! // Start the initial operation and pin the future to the stack. |
| //! // Pinning to the stack is required to resume the operation |
| //! // across multiple calls to `select!` |
| //! let op = my_async_operation(); |
| //! tokio::pin!(op); |
| //! |
| //! // Get the initial config value |
| //! let mut conf = rx.borrow().clone(); |
| //! |
| //! let mut op_start = Instant::now(); |
| //! let sleep = time::sleep_until(op_start + conf.timeout); |
| //! tokio::pin!(sleep); |
| //! |
| //! loop { |
| //! tokio::select! { |
| //! _ = &mut sleep => { |
| //! // The operation elapsed. Restart it |
| //! op.set(my_async_operation()); |
| //! |
| //! // Track the new start time |
| //! op_start = Instant::now(); |
| //! |
| //! // Restart the timeout |
| //! sleep.set(time::sleep_until(op_start + conf.timeout)); |
| //! } |
| //! _ = rx.changed() => { |
| //! conf = rx.borrow().clone(); |
| //! |
| //! // The configuration has been updated. Update the |
| //! // `sleep` using the new `timeout` value. |
| //! sleep.as_mut().reset(op_start + conf.timeout); |
| //! } |
| //! _ = &mut op => { |
| //! // The operation completed! |
| //! return |
| //! } |
| //! } |
| //! } |
| //! }); |
| //! |
| //! handles.push(handle); |
| //! } |
| //! |
| //! for handle in handles.drain(..) { |
| //! handle.await.unwrap(); |
| //! } |
| //! } |
| //! ``` |
| //! |
| //! [`watch` channel]: mod@crate::sync::watch |
| //! [`broadcast` channel]: mod@crate::sync::broadcast |
| //! |
| //! # State synchronization |
| //! |
| //! The remaining synchronization primitives focus on synchronizing state. |
| //! These are asynchronous equivalents to versions provided by `std`. They |
| //! operate in a similar way as their `std` counterparts but will wait |
| //! asynchronously instead of blocking the thread. |
| //! |
| //! * [`Barrier`](Barrier) Ensures multiple tasks will wait for each other to |
| //! reach a point in the program, before continuing execution all together. |
| //! |
| //! * [`Mutex`](Mutex) Mutual Exclusion mechanism, which ensures that at most |
| //! one thread at a time is able to access some data. |
| //! |
| //! * [`Notify`](Notify) Basic task notification. `Notify` supports notifying a |
| //! receiving task without sending data. In this case, the task wakes up and |
| //! resumes processing. |
| //! |
| //! * [`RwLock`](RwLock) Provides a mutual exclusion mechanism which allows |
| //! multiple readers at the same time, while allowing only one writer at a |
| //! time. In some cases, this can be more efficient than a mutex. |
| //! |
| //! * [`Semaphore`](Semaphore) Limits the amount of concurrency. A semaphore |
| //! holds a number of permits, which tasks may request in order to enter a |
| //! critical section. Semaphores are useful for implementing limiting or |
| //! bounding of any kind. |
| |
| </span><span class="macro">cfg_sync! </span>{ |
| <span class="doccomment">/// Named future types. |
| </span><span class="kw">pub mod </span>futures { |
| <span class="kw">pub use </span><span class="kw">super</span>::notify::Notified; |
| } |
| |
| <span class="kw">mod </span>barrier; |
| <span class="kw">pub use </span>barrier::{Barrier, BarrierWaitResult}; |
| |
| <span class="kw">pub mod </span>broadcast; |
| |
| <span class="kw">pub mod </span>mpsc; |
| |
| <span class="kw">mod </span>mutex; |
| <span class="kw">pub use </span>mutex::{Mutex, MutexGuard, TryLockError, OwnedMutexGuard, MappedMutexGuard}; |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>notify; |
| <span class="kw">pub use </span>notify::Notify; |
| |
| <span class="kw">pub mod </span>oneshot; |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>batch_semaphore; |
| <span class="kw">pub use </span>batch_semaphore::{AcquireError, TryAcquireError}; |
| |
| <span class="kw">mod </span>semaphore; |
| <span class="kw">pub use </span>semaphore::{Semaphore, SemaphorePermit, OwnedSemaphorePermit}; |
| |
| <span class="kw">mod </span>rwlock; |
| <span class="kw">pub use </span>rwlock::RwLock; |
| <span class="kw">pub use </span>rwlock::owned_read_guard::OwnedRwLockReadGuard; |
| <span class="kw">pub use </span>rwlock::owned_write_guard::OwnedRwLockWriteGuard; |
| <span class="kw">pub use </span>rwlock::owned_write_guard_mapped::OwnedRwLockMappedWriteGuard; |
| <span class="kw">pub use </span>rwlock::read_guard::RwLockReadGuard; |
| <span class="kw">pub use </span>rwlock::write_guard::RwLockWriteGuard; |
| <span class="kw">pub use </span>rwlock::write_guard_mapped::RwLockMappedWriteGuard; |
| |
| <span class="kw">mod </span>task; |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>task::AtomicWaker; |
| |
| <span class="kw">mod </span>once_cell; |
| <span class="kw">pub use </span><span class="self">self</span>::once_cell::{OnceCell, SetError}; |
| |
| <span class="kw">pub mod </span>watch; |
| } |
| |
| <span class="macro">cfg_not_sync! </span>{ |
| <span class="macro">cfg_fs! </span>{ |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>batch_semaphore; |
| <span class="kw">mod </span>mutex; |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>mutex::Mutex; |
| } |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"rt"</span>, feature = <span class="string">"signal"</span>, all(unix, feature = <span class="string">"process"</span>)))] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>notify; |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"rt"</span>, all(windows, feature = <span class="string">"process"</span>)))] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>oneshot; |
| |
| <span class="macro">cfg_atomic_waker_impl! </span>{ |
| <span class="kw">mod </span>task; |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>task::AtomicWaker; |
| } |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"signal"</span>, all(unix, feature = <span class="string">"process"</span>)))] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>watch; |
| } |
| |
| <span class="doccomment">/// Unit tests |
| </span><span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests; |
| </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> |