blob: 00179919d171e2f6cb1ac030a1160453e7dc07dd [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/signal-hook-0.1.17/src/iterator.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>iterator.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="../../signal_hook/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="../../signal_hook/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>
</pre><pre class="rust"><code><span class="doccomment">//! An iterator over incoming signals.
//!
//! This provides a higher abstraction over the signals, providing a structure
//! ([`Signals`](struct.Signals.html)) able to iterate over the incoming signals.
//!
//! In case the `tokio-support` feature is turned on, the [`Async`](struct.Async.html) is also
//! available, making it possible to integrate with the tokio runtime.
//!
//! # Examples
//!
//! ```rust
//! extern crate libc;
//! extern crate signal_hook;
//!
//! use std::io::Error;
//!
//! use signal_hook::iterator::Signals;
//!
//! fn main() -&gt; Result&lt;(), Error&gt; {
//! let signals = Signals::new(&amp;[
//! signal_hook::SIGHUP,
//! signal_hook::SIGTERM,
//! signal_hook::SIGINT,
//! signal_hook::SIGQUIT,
//! # signal_hook::SIGUSR1,
//! ])?;
//! # // A trick to terminate the example when run as doc-test. Not part of the real code.
//! # unsafe { libc::raise(signal_hook::SIGUSR1) };
//! &#39;outer: loop {
//! // Pick up signals that arrived since last time
//! for signal in signals.pending() {
//! match signal as libc::c_int {
//! signal_hook::SIGHUP =&gt; {
//! // Reload configuration
//! // Reopen the log file
//! }
//! signal_hook::SIGTERM | signal_hook::SIGINT | signal_hook::SIGQUIT =&gt; {
//! break &#39;outer;
//! },
//! # signal_hook::SIGUSR1 =&gt; return Ok(()),
//! _ =&gt; unreachable!(),
//! }
//! }
//! // Do some bit of work ‒ something with upper limit on waiting, so we don&#39;t block
//! // forever with a SIGTERM already waiting.
//! }
//! println!(&quot;Terminating. Bye bye&quot;);
//! Ok(())
//! }
//! ```
</span><span class="kw">use </span>std::borrow::Borrow;
<span class="kw">use </span>std::io::Error;
<span class="kw">use </span>std::iter::Enumerate;
<span class="kw">use </span>std::os::unix::io::AsRawFd;
<span class="kw">use </span>std::os::unix::net::UnixStream;
<span class="kw">use </span>std::slice::Iter;
<span class="kw">use </span>std::sync::atomic::{AtomicBool, Ordering};
<span class="kw">use </span>std::sync::{Arc, Mutex};
<span class="kw">use </span>libc::{<span class="self">self</span>, c_int};
<span class="kw">use </span><span class="kw">crate</span>::SigId;
<span class="doccomment">/// Maximal signal number we support.
</span><span class="kw">const </span>MAX_SIGNUM: usize = <span class="number">128</span>;
<span class="attribute">#[derive(Debug)]
</span><span class="kw">struct </span>Waker {
pending: Vec&lt;AtomicBool&gt;,
closed: AtomicBool,
read: UnixStream,
write: UnixStream,
}
<span class="kw">impl </span>Waker {
<span class="doccomment">/// Sends a wakeup signal to the internal wakeup pipe.
</span><span class="kw">fn </span>wake(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="kw">unsafe </span>{
<span class="comment">// See the comment at pipe::write.
//
// We don&#39;t use pipe::write, because it expects the FD to be already in non-blocking
// mode. That&#39;s because it needs to support actual pipes. We can afford send here,
// which has flags.
</span>libc::send(
<span class="self">self</span>.write.as_raw_fd(),
<span class="string">b&quot;X&quot; </span><span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span><span class="kw-2">*const </span><span class="kw">_</span>,
<span class="number">1</span>,
libc::MSG_DONTWAIT,
);
}
}
}
<span class="attribute">#[derive(Debug)]
</span><span class="kw">struct </span>RegisteredSignals(Mutex&lt;Vec&lt;<span class="prelude-ty">Option</span>&lt;SigId&gt;&gt;&gt;);
<span class="kw">impl </span>Drop <span class="kw">for </span>RegisteredSignals {
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">let </span>lock = <span class="self">self</span>.<span class="number">0</span>.lock().unwrap();
<span class="kw">for </span>id <span class="kw">in </span>lock.iter().filter_map(|s| <span class="kw-2">*</span>s) {
<span class="kw">crate</span>::unregister(id);
}
}
}
<span class="doccomment">/// The main structure of the module, representing interest in some signals.
///
/// Unlike the helpers in other modules, this registers the signals when created and unregisters
/// them on drop. It provides the pending signals during its lifetime, either in batches or as an
/// infinite iterator.
///
/// # Multiple consumers
///
/// You may have noticed this structure can be used simultaneously by multiple threads. If it is
/// done, a signal arrives to one of the threads (on the first come, first serve basis). The signal
/// is *not* broadcasted to all currently active threads.
///
/// A similar thing applies to cloning the structure ‒ at least one of the copies gets the signal,
/// but it is not broadcasted to all of them.
///
/// If you need multiple recipients, you can create multiple independent instances (not by cloning,
/// but by the constructor).
///
/// # Examples
///
/// ```rust
/// # extern crate signal_hook;
/// #
/// # use std::io::Error;
/// # use std::thread;
/// use signal_hook::iterator::Signals;
///
/// #
/// # fn main() -&gt; Result&lt;(), Error&gt; {
/// let signals = Signals::new(&amp;[signal_hook::SIGUSR1, signal_hook::SIGUSR2])?;
/// thread::spawn(move || {
/// for signal in &amp;signals {
/// match signal {
/// signal_hook::SIGUSR1 =&gt; {},
/// signal_hook::SIGUSR2 =&gt; {},
/// _ =&gt; unreachable!(),
/// }
/// }
/// });
/// # Ok(())
/// # }
/// ```
///
/// # `mio` support
///
/// If the crate is compiled with the `mio-support` or `mio-0_7-support` flags, the `Signals`
/// becomes pluggable into `mio` version `0.6` or `0.7` respectively (it implements the `Source`
/// trait). If it becomes readable, there may be new signals to pick up.
///
/// # `tokio` support
///
/// If the crate is compiled with the `tokio-support` flag, the [`into_async`](#method.into_async)
/// method becomes available. This method turns the iterator into an asynchronous stream of
/// received signals.
</span><span class="attribute">#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>Signals {
ids: Arc&lt;RegisteredSignals&gt;,
waker: Arc&lt;Waker&gt;,
}
<span class="kw">impl </span>Signals {
<span class="doccomment">/// Creates the `Signals` structure.
///
/// This registers all the signals listed. The same restrictions (panics, errors) apply as with
/// [`register`](../fn.register.html).
</span><span class="kw">pub fn </span>new&lt;I, S&gt;(signals: I) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, Error&gt;
<span class="kw">where
</span>I: IntoIterator&lt;Item = S&gt;,
S: Borrow&lt;c_int&gt;,
{
<span class="kw">let </span>(read, write) = UnixStream::pair()<span class="question-mark">?</span>;
<span class="kw">let </span>pending = (<span class="number">0</span>..MAX_SIGNUM).map(|<span class="kw">_</span>| AtomicBool::new(<span class="bool-val">false</span>)).collect();
<span class="kw">let </span>waker = Arc::new(Waker {
pending,
closed: AtomicBool::new(<span class="bool-val">false</span>),
read,
write,
});
<span class="kw">let </span>ids = (<span class="number">0</span>..MAX_SIGNUM).map(|<span class="kw">_</span>| <span class="prelude-val">None</span>).collect();
<span class="kw">let </span>me = <span class="self">Self </span>{
ids: Arc::new(RegisteredSignals(Mutex::new(ids))),
waker,
};
<span class="kw">for </span>sig <span class="kw">in </span>signals {
me.add_signal(<span class="kw-2">*</span>sig.borrow())<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(me)
}
<span class="doccomment">/// Registers another signal to the set watched by this [`Signals`] instance.
///
/// # Notes
///
/// * This is safe to call concurrently from whatever thread.
/// * This is *not* safe to call from within a signal handler.
/// * If the signal number was already registered previously, this is a no-op.
/// * If this errors, the original set of signals is left intact.
/// * This actually registers the signal into the whole group of [`Signals`] cloned from each
/// other, so any of them might start receiving the signals.
///
/// # Panics
///
/// * If the given signal is [forbidden][crate::FORBIDDEN].
/// * If the signal number is negative or larger than internal limit. The limit should be
/// larger than any supported signal the OS supports.
</span><span class="kw">pub fn </span>add_signal(<span class="kw-2">&amp;</span><span class="self">self</span>, signal: c_int) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="macro">assert!</span>(signal &gt;= <span class="number">0</span>);
<span class="macro">assert!</span>(
(signal <span class="kw">as </span>usize) &lt; MAX_SIGNUM,
<span class="string">&quot;Signal number {} too large. If your OS really supports such signal, file a bug&quot;</span>,
signal,
);
<span class="kw">let </span><span class="kw-2">mut </span>lock = <span class="self">self</span>.ids.<span class="number">0</span>.lock().unwrap();
<span class="comment">// Already registered, ignoring
</span><span class="kw">if </span>lock[signal <span class="kw">as </span>usize].is_some() {
<span class="kw">return </span><span class="prelude-val">Ok</span>(());
}
<span class="kw">let </span>waker = Arc::clone(<span class="kw-2">&amp;</span><span class="self">self</span>.waker);
<span class="kw">let </span>action = <span class="kw">move </span>|| {
waker.pending[signal <span class="kw">as </span>usize].store(<span class="bool-val">true</span>, Ordering::SeqCst);
waker.wake();
};
<span class="kw">let </span>id = <span class="kw">unsafe </span>{ <span class="kw">crate</span>::register(signal, action) }<span class="question-mark">?</span>;
lock[signal <span class="kw">as </span>usize] = <span class="prelude-val">Some</span>(id);
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Reads data from the internal self-pipe.
///
/// If `wait` is `true` and there are no data in the self pipe, it blocks until some come.
///
/// Returns weather it successfully read something.
</span><span class="kw">fn </span>flush(<span class="kw-2">&amp;</span><span class="self">self</span>, wait: bool) -&gt; bool {
<span class="comment">// Just an optimisation.. would work without it too.
</span><span class="kw">if </span><span class="self">self</span>.waker.closed.load(Ordering::SeqCst) {
<span class="kw">return </span><span class="bool-val">false</span>;
}
<span class="kw">const </span>SIZE: usize = <span class="number">1024</span>;
<span class="kw">let </span><span class="kw-2">mut </span>buff = [<span class="number">0u8</span>; SIZE];
<span class="kw">let </span>res = <span class="kw">unsafe </span>{
<span class="comment">// We ignore all errors on purpose. This should not be something like closed file
// descriptor. It could EAGAIN, but that&#39;s OK in case we say MSG_DONTWAIT. If it&#39;s
// EINTR, then it&#39;s OK too, it&#39;ll only create a spurious wakeup.
</span>libc::recv(
<span class="self">self</span>.waker.read.as_raw_fd(),
buff.as_mut_ptr() <span class="kw">as </span><span class="kw-2">*mut </span>libc::c_void,
SIZE,
<span class="kw">if </span>wait { <span class="number">0 </span>} <span class="kw">else </span>{ libc::MSG_DONTWAIT },
)
};
<span class="kw">if </span>res &gt; <span class="number">0 </span>{
<span class="kw">unsafe </span>{
<span class="comment">// Finish draining the data in case there&#39;s more
</span><span class="kw">while </span>libc::recv(
<span class="self">self</span>.waker.read.as_raw_fd(),
buff.as_mut_ptr() <span class="kw">as </span><span class="kw-2">*mut </span>libc::c_void,
SIZE,
libc::MSG_DONTWAIT,
) &gt; <span class="number">0
</span>{}
}
}
<span class="kw">if </span><span class="self">self</span>.waker.closed.load(Ordering::SeqCst) {
<span class="comment">// Wake any other sleeping ends
// (if none wait, it&#39;ll only leave garbage inside the pipe, but we&#39;ll close it soon
// anyway).
</span><span class="self">self</span>.waker.wake();
}
res &gt; <span class="number">0
</span>}
<span class="doccomment">/// Returns an iterator of already received signals.
///
/// This returns an iterator over all the signal numbers of the signals received since last
/// time they were read (out of the set registered by this `Signals` instance). Note that they
/// are returned in arbitrary order and a signal number is returned only once even if it was
/// received multiple times.
///
/// This method returns immediately (does not block) and may produce an empty iterator if there
/// are no signals ready.
</span><span class="kw">pub fn </span>pending(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Pending {
<span class="self">self</span>.flush(<span class="bool-val">false</span>);
Pending(<span class="self">self</span>.waker.pending.iter().enumerate())
}
<span class="doccomment">/// Waits for some signals to be available and returns an iterator.
///
/// This is similar to [`pending`](#method.pending). If there are no signals available, it
/// tries to wait for some to arrive. However, due to implementation details, this still can
/// produce an empty iterator.
///
/// This can block for arbitrary long time.
///
/// Note that the blocking is done in this method, not in the iterator.
</span><span class="kw">pub fn </span>wait(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Pending {
<span class="self">self</span>.flush(<span class="bool-val">true</span>);
Pending(<span class="self">self</span>.waker.pending.iter().enumerate())
}
<span class="doccomment">/// Returns an infinite iterator over arriving signals.
///
/// The iterator&#39;s `next()` blocks as necessary to wait for signals to arrive. This is adequate
/// if you want to designate a thread solely to handling signals. If multiple signals come at
/// the same time (between two values produced by the iterator), they will be returned in
/// arbitrary order. Multiple instances of the same signal may be collated.
///
/// This is also the iterator returned by `IntoIterator` implementation on `&amp;Signals`.
///
/// This iterator terminates only if the [`Signals`] is explicitly [closed][Signals::close].
///
/// # Examples
///
/// ```rust
/// # extern crate libc;
/// # extern crate signal_hook;
/// #
/// # use std::io::Error;
/// # use std::thread;
/// #
/// use signal_hook::iterator::Signals;
///
/// # fn main() -&gt; Result&lt;(), Error&gt; {
/// let signals = Signals::new(&amp;[signal_hook::SIGUSR1, signal_hook::SIGUSR2])?;
/// thread::spawn(move || {
/// for signal in signals.forever() {
/// match signal {
/// signal_hook::SIGUSR1 =&gt; {},
/// signal_hook::SIGUSR2 =&gt; {},
/// _ =&gt; unreachable!(),
/// }
/// }
/// });
/// # Ok(())
/// # }
/// ```
</span><span class="kw">pub fn </span>forever(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Forever {
Forever {
signals: <span class="self">self</span>,
iter: <span class="self">self</span>.pending(),
}
}
<span class="doccomment">/// Is it closed?
///
/// See [`close`][Signals::close].
</span><span class="kw">pub fn </span>is_closed(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.waker.closed.load(Ordering::SeqCst)
}
<span class="doccomment">/// Closes the instance.
///
/// This is meant to signalize termination through all the interrelated instances ‒ the ones
/// created by cloning the same original [`Signals`] instance (and all the [`Async`] ones
/// created from them). After calling close:
///
/// * [`is_closed`][Signals::is_closed] will return true.
/// * All currently blocking operations on all threads and all the instances are interrupted
/// and terminate.
/// * Any further operations will never block.
/// * Further signals may or may not be returned from the iterators. However, if any are
/// returned, these are real signals that happened.
/// * The [`forever`][Signals::forever] terminates (follows from the above).
///
/// The goal is to be able to shut down any background thread that handles only the signals.
///
/// ```rust
/// # use signal_hook::iterator::Signals;
/// # use signal_hook::SIGUSR1;
/// # fn main() -&gt; Result&lt;(), std::io::Error&gt; {
/// let signals = Signals::new(&amp;[SIGUSR1])?;
/// let signals_bg = signals.clone();
/// let thread = std::thread::spawn(move || {
/// for signal in &amp;signals_bg {
/// // Whatever with the signal
/// # let _ = signal;
/// }
/// });
///
/// signals.close();
///
/// // The thread will terminate on its own now (the for cycle runs out of signals).
/// thread.join().expect(&quot;background thread panicked&quot;);
/// # Ok(()) }
/// ```
</span><span class="kw">pub fn </span>close(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="self">self</span>.waker.closed.store(<span class="bool-val">true</span>, Ordering::SeqCst);
<span class="self">self</span>.waker.wake();
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; IntoIterator <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Signals {
<span class="kw">type </span>Item = c_int;
<span class="kw">type </span>IntoIter = Forever&lt;<span class="lifetime">&#39;a</span>&gt;;
<span class="kw">fn </span>into_iter(<span class="self">self</span>) -&gt; Forever&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="self">self</span>.forever()
}
}
<span class="doccomment">/// The iterator of one batch of signals.
///
/// This is returned by the [`pending`](struct.Signals.html#method.pending) and
/// [`wait`](struct.Signals.html#method.wait) methods.
</span><span class="kw">pub struct </span>Pending&lt;<span class="lifetime">&#39;a</span>&gt;(Enumerate&lt;Iter&lt;<span class="lifetime">&#39;a</span>, AtomicBool&gt;&gt;);
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Iterator <span class="kw">for </span>Pending&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">type </span>Item = c_int;
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;c_int&gt; {
<span class="kw">while let </span><span class="prelude-val">Some</span>((sig, flag)) = <span class="self">self</span>.<span class="number">0</span>.next() {
<span class="kw">if </span>flag
.compare_exchange(<span class="bool-val">true</span>, <span class="bool-val">false</span>, Ordering::SeqCst, Ordering::Relaxed)
.is_ok()
{
<span class="kw">return </span><span class="prelude-val">Some</span>(sig <span class="kw">as </span>c_int);
}
}
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// The infinite iterator of signals.
///
/// It is returned by the [`forever`](struct.Signals.html#method.forever) and by the `IntoIterator`
/// implementation of [`&amp;Signals`](struct.Signals.html).
</span><span class="kw">pub struct </span>Forever&lt;<span class="lifetime">&#39;a</span>&gt; {
signals: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Signals,
iter: Pending&lt;<span class="lifetime">&#39;a</span>&gt;,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Iterator <span class="kw">for </span>Forever&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">type </span>Item = c_int;
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;c_int&gt; {
<span class="kw">while </span>!<span class="self">self</span>.signals.is_closed() {
<span class="kw">if let </span><span class="prelude-val">Some</span>(result) = <span class="self">self</span>.iter.next() {
<span class="kw">return </span><span class="prelude-val">Some</span>(result);
}
<span class="self">self</span>.iter = <span class="self">self</span>.signals.wait();
}
<span class="prelude-val">None
</span>}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;mio-support&quot;</span>)]
</span><span class="kw">mod </span>mio_support {
<span class="kw">use </span>std::io::Error;
<span class="kw">use </span>std::os::unix::io::AsRawFd;
<span class="kw">use </span>mio::event::Evented;
<span class="kw">use </span>mio::unix::EventedFd;
<span class="kw">use </span>mio::{Poll, PollOpt, Ready, Token};
<span class="kw">use </span><span class="kw">super</span>::Signals;
<span class="kw">impl </span>Evented <span class="kw">for </span>Signals {
<span class="kw">fn </span>register(
<span class="kw-2">&amp;</span><span class="self">self</span>,
poll: <span class="kw-2">&amp;</span>Poll,
token: Token,
interest: Ready,
opts: PollOpt,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
EventedFd(<span class="kw-2">&amp;</span><span class="self">self</span>.waker.read.as_raw_fd()).register(poll, token, interest, opts)
}
<span class="kw">fn </span>reregister(
<span class="kw-2">&amp;</span><span class="self">self</span>,
poll: <span class="kw-2">&amp;</span>Poll,
token: Token,
interest: Ready,
opts: PollOpt,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
EventedFd(<span class="kw-2">&amp;</span><span class="self">self</span>.waker.read.as_raw_fd()).reregister(poll, token, interest, opts)
}
<span class="kw">fn </span>deregister(<span class="kw-2">&amp;</span><span class="self">self</span>, poll: <span class="kw-2">&amp;</span>Poll) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
EventedFd(<span class="kw-2">&amp;</span><span class="self">self</span>.waker.read.as_raw_fd()).deregister(poll)
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>std::time::Duration;
<span class="kw">use </span>libc;
<span class="kw">use </span>mio::Events;
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>mio_wakeup() {
<span class="kw">let </span>signals = Signals::new(<span class="kw-2">&amp;</span>[<span class="kw">crate</span>::SIGUSR1]).unwrap();
<span class="kw">let </span>token = Token(<span class="number">0</span>);
<span class="kw">let </span>poll = Poll::new().unwrap();
poll.register(<span class="kw-2">&amp;</span>signals, token, Ready::readable(), PollOpt::level())
.unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>events = Events::with_capacity(<span class="number">10</span>);
<span class="kw">unsafe </span>{ libc::raise(<span class="kw">crate</span>::SIGUSR1) };
poll.poll(<span class="kw-2">&amp;mut </span>events, <span class="prelude-val">Some</span>(Duration::from_secs(<span class="number">10</span>)))
.unwrap();
<span class="kw">let </span>event = events.iter().next().unwrap();
<span class="macro">assert!</span>(event.readiness().is_readable());
<span class="macro">assert_eq!</span>(token, event.token());
<span class="kw">let </span>sig = signals.pending().next().unwrap();
<span class="macro">assert_eq!</span>(<span class="kw">crate</span>::SIGUSR1, sig);
}
}
}
<span class="attribute">#[cfg(any(test, feature = <span class="string">&quot;mio-0_7-support&quot;</span>))]
</span><span class="kw">mod </span>mio_0_7_support {
<span class="kw">use </span>std::io::Error;
<span class="kw">use </span>std::os::unix::io::AsRawFd;
<span class="kw">use </span>mio_0_7::event::Source;
<span class="kw">use </span>mio_0_7::unix::SourceFd;
<span class="kw">use </span>mio_0_7::{Interest, Registry, Token};
<span class="kw">use </span><span class="kw">super</span>::Signals;
<span class="kw">impl </span>Source <span class="kw">for </span>Signals {
<span class="kw">fn </span>register(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
registry: <span class="kw-2">&amp;</span>Registry,
token: Token,
interest: Interest,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
SourceFd(<span class="kw-2">&amp;</span><span class="self">self</span>.waker.read.as_raw_fd()).register(registry, token, interest)
}
<span class="kw">fn </span>reregister(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
registry: <span class="kw-2">&amp;</span>Registry,
token: Token,
interest: Interest,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
SourceFd(<span class="kw-2">&amp;</span><span class="self">self</span>.waker.read.as_raw_fd()).reregister(registry, token, interest)
}
<span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
SourceFd(<span class="kw-2">&amp;</span><span class="self">self</span>.waker.read.as_raw_fd()).deregister(registry)
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>std::time::Duration;
<span class="kw">use </span>mio_0_7::{Events, Poll};
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>mio_wakeup() {
<span class="kw">let </span><span class="kw-2">mut </span>signals = Signals::new(<span class="kw-2">&amp;</span>[<span class="kw">crate</span>::SIGUSR1]).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>poll = Poll::new().unwrap();
<span class="kw">let </span>token = Token(<span class="number">0</span>);
poll.registry()
.register(<span class="kw-2">&amp;mut </span>signals, token, Interest::READABLE)
.unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>events = Events::with_capacity(<span class="number">10</span>);
<span class="kw">unsafe </span>{ libc::raise(<span class="kw">crate</span>::SIGUSR1) };
poll.poll(<span class="kw-2">&amp;mut </span>events, <span class="prelude-val">Some</span>(Duration::from_secs(<span class="number">10</span>)))
.unwrap();
<span class="kw">let </span>event = events.iter().next().unwrap();
<span class="macro">assert!</span>(event.is_readable());
<span class="macro">assert_eq!</span>(token, event.token());
<span class="kw">let </span>sig = signals.pending().next().unwrap();
<span class="macro">assert_eq!</span>(<span class="kw">crate</span>::SIGUSR1, sig);
}
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;tokio-support&quot;</span>)]
</span><span class="kw">mod </span>tokio_support {
<span class="kw">use </span>std::io::Error;
<span class="kw">use </span>std::sync::atomic::Ordering;
<span class="kw">use </span>futures::stream::Stream;
<span class="kw">use </span>futures::{Async <span class="kw">as </span>AsyncResult, Poll};
<span class="kw">use </span>libc::{<span class="self">self</span>, c_int};
<span class="kw">use </span>tokio_reactor::{Handle, Registration};
<span class="kw">use </span><span class="kw">super</span>::Signals;
<span class="doccomment">/// An asynchronous stream of registered signals.
///
/// It is created by converting [`Signals`](struct.Signals.html). See
/// [`Signals::into_async`](struct.Signals.html#method.into_async).
///
/// # Cloning
///
/// If you register multiple signals, then create multiple `Signals` instances by cloning and
/// convert them to `Async`, one of them can „steal“ wakeups for several signals at once. This
/// one will produce the signals while the others will be silent.
///
/// This has an effect if the one consumes them slowly or is dropped after the first one.
///
/// It is recommended not to clone the `Signals` instances and keep just one `Async` stream
/// around.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>Async {
registration: Registration,
inner: Signals,
<span class="comment">// It seems we can&#39;t easily use the iterator into the array here because of lifetimes ‒
// using non-&#39;static things in around futures is real pain.
</span>position: usize,
}
<span class="kw">impl </span>Async {
<span class="doccomment">/// Creates a new `Async`.
</span><span class="kw">pub fn </span>new(signals: Signals, handle: <span class="kw-2">&amp;</span>Handle) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, Error&gt; {
<span class="kw">let </span>registration = Registration::new();
registration.register_with(<span class="kw-2">&amp;</span>signals, handle)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Async {
registration,
inner: signals,
position: <span class="number">0</span>,
})
}
}
<span class="kw">impl </span>Stream <span class="kw">for </span>Async {
<span class="kw">type </span>Item = libc::c_int;
<span class="kw">type </span>Error = Error;
<span class="kw">fn </span>poll(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; Poll&lt;<span class="prelude-ty">Option</span>&lt;libc::c_int&gt;, <span class="self">Self</span>::Error&gt; {
<span class="kw">while </span>!<span class="self">self</span>.inner.is_closed() {
<span class="kw">if </span><span class="self">self</span>.position &gt;= <span class="self">self</span>.inner.waker.pending.len() {
<span class="kw">if </span><span class="self">self</span>.registration.poll_read_ready()<span class="question-mark">?</span>.is_not_ready() {
<span class="kw">return </span><span class="prelude-val">Ok</span>(AsyncResult::NotReady);
}
<span class="comment">// Non-blocking clean of the pipe
</span><span class="kw">while </span><span class="self">self</span>.inner.flush(<span class="bool-val">false</span>) {}
<span class="comment">// By now we have an indication there might be some stuff inside the signals,
// reset the scanning position
</span><span class="self">self</span>.position = <span class="number">0</span>;
}
<span class="macro">assert!</span>(<span class="self">self</span>.position &lt; <span class="self">self</span>.inner.waker.pending.len());
<span class="kw">let </span>sig = <span class="kw-2">&amp;</span><span class="self">self</span>.inner.waker.pending[<span class="self">self</span>.position];
<span class="kw">let </span>sig_num = <span class="self">self</span>.position;
<span class="self">self</span>.position += <span class="number">1</span>;
<span class="kw">if </span>sig
.compare_exchange(<span class="bool-val">true</span>, <span class="bool-val">false</span>, Ordering::SeqCst, Ordering::Relaxed)
.is_ok()
{
<span class="comment">// Successfully claimed a signal, return it
</span><span class="kw">return </span><span class="prelude-val">Ok</span>(AsyncResult::Ready(<span class="prelude-val">Some</span>(sig_num <span class="kw">as </span>c_int)));
}
}
<span class="prelude-val">Ok</span>(AsyncResult::Ready(<span class="prelude-val">None</span>))
}
}
<span class="kw">impl </span>Signals {
<span class="doccomment">/// Turns the iterator into an asynchronous stream.
///
/// This allows getting the signals in asynchronous way in a tokio event loop. Available
/// only if compiled with the `tokio-support` feature enabled.
///
/// # Examples
///
/// ```rust
/// extern crate libc;
/// extern crate signal_hook;
/// extern crate tokio;
///
/// use std::io::Error;
///
/// use signal_hook::iterator::Signals;
/// use tokio::prelude::*;
///
/// fn main() -&gt; Result&lt;(), Error&gt; {
/// let wait_signal = Signals::new(&amp;[signal_hook::SIGUSR1])?
/// .into_async()?
/// .into_future()
/// .map(|sig| assert_eq!(sig.0.unwrap(), signal_hook::SIGUSR1))
/// .map_err(|e| panic!(&quot;{}&quot;, e.0));
/// unsafe { libc::raise(signal_hook::SIGUSR1) };
/// tokio::run(wait_signal);
/// Ok(())
/// }
/// ```
</span><span class="kw">pub fn </span>into_async(<span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;Async, Error&gt; {
Async::new(<span class="self">self</span>, <span class="kw-2">&amp;</span>Handle::default())
}
<span class="doccomment">/// Turns the iterator into a stream, tied into a specific tokio reactor.
</span><span class="kw">pub fn </span>into_async_with_handle(<span class="self">self</span>, handle: <span class="kw-2">&amp;</span>Handle) -&gt; <span class="prelude-ty">Result</span>&lt;Async, Error&gt; {
Async::new(<span class="self">self</span>, handle)
}
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;tokio-support&quot;</span>)]
</span><span class="kw">pub use </span><span class="self">self</span>::tokio_support::Async;
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="signal_hook" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>