Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / src / tokio / runtime / scheduler / multi_thread / handle.rs.html
blob: 990839fefa051c053b24485262c574d9bfdd1073 [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/tokio-1.28.2/src/runtime/scheduler/multi_thread/handle.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>handle.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>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::future::Future;
<span class="kw">use </span><span class="kw">crate</span>::loom::sync::Arc;
<span class="kw">use </span><span class="kw">crate</span>::runtime::scheduler::multi_thread::worker;
<span class="kw">use </span><span class="kw">crate</span>::runtime::{
blocking, driver,
task::{<span class="self">self</span>, JoinHandle},
};
<span class="kw">use </span><span class="kw">crate</span>::util::RngSeedGenerator;
<span class="kw">use </span>std::fmt;
<span class="doccomment">/// Handle to the multi thread scheduler
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Handle {
<span class="doccomment">/// Task spawner
</span><span class="kw">pub</span>(<span class="kw">super</span>) shared: worker::Shared,
<span class="doccomment">/// Resource driver handles
</span><span class="kw">pub</span>(<span class="kw">crate</span>) driver: driver::Handle,
<span class="doccomment">/// Blocking pool spawner
</span><span class="kw">pub</span>(<span class="kw">crate</span>) blocking_spawner: blocking::Spawner,
<span class="doccomment">/// Current random number generator seed
</span><span class="kw">pub</span>(<span class="kw">crate</span>) seed_generator: RngSeedGenerator,
}
<span class="kw">impl </span>Handle {
<span class="doccomment">/// Spawns a future onto the thread pool
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>spawn&lt;F&gt;(me: <span class="kw-2">&amp;</span>Arc&lt;<span class="self">Self</span>&gt;, future: F, id: task::Id) -&gt; JoinHandle&lt;F::Output&gt;
<span class="kw">where
</span>F: <span class="kw">crate</span>::future::Future + Send + <span class="lifetime">&#39;static</span>,
F::Output: Send + <span class="lifetime">&#39;static</span>,
{
<span class="self">Self</span>::bind_new_task(me, future, id)
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>shutdown(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="self">self</span>.close();
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>bind_new_task&lt;T&gt;(me: <span class="kw-2">&amp;</span>Arc&lt;<span class="self">Self</span>&gt;, future: T, id: task::Id) -&gt; JoinHandle&lt;T::Output&gt;
<span class="kw">where
</span>T: Future + Send + <span class="lifetime">&#39;static</span>,
T::Output: Send + <span class="lifetime">&#39;static</span>,
{
<span class="kw">let </span>(handle, notified) = me.shared.owned.bind(future, me.clone(), id);
<span class="kw">if let </span><span class="prelude-val">Some</span>(notified) = notified {
me.schedule_task(notified, <span class="bool-val">false</span>);
}
handle
}
}
<span class="macro">cfg_metrics! </span>{
<span class="kw">use </span><span class="kw">crate</span>::runtime::{SchedulerMetrics, WorkerMetrics};
<span class="kw">impl </span>Handle {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>num_workers(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.shared.worker_metrics.len()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>num_blocking_threads(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.blocking_spawner.num_threads()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>num_idle_blocking_threads(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.blocking_spawner.num_idle_threads()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>scheduler_metrics(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>SchedulerMetrics {
<span class="kw-2">&amp;</span><span class="self">self</span>.shared.scheduler_metrics
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>worker_metrics(<span class="kw-2">&amp;</span><span class="self">self</span>, worker: usize) -&gt; <span class="kw-2">&amp;</span>WorkerMetrics {
<span class="kw-2">&amp;</span><span class="self">self</span>.shared.worker_metrics[worker]
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>injection_queue_depth(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.shared.injection_queue_depth()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>worker_local_queue_depth(<span class="kw-2">&amp;</span><span class="self">self</span>, worker: usize) -&gt; usize {
<span class="self">self</span>.shared.worker_local_queue_depth(worker)
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>blocking_queue_depth(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.blocking_spawner.queue_depth()
}
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Handle {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, fmt: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
fmt.debug_struct(<span class="string">&quot;multi_thread::Handle { ... }&quot;</span>).finish()
}
}
</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>