226 lines
11 KiB
HTML
226 lines
11 KiB
HTML
|
<!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="API documentation for the Rust `executor` mod in crate `tokio`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, executor">
|
|||
|
|
|
|||
|
|
<title>tokio::executor - Rust</title>
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../normalize.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
|
|||
|
|
<script src="../../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc mod">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
<div class="sidebar-menu">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Module executor</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>tokio</a></p><script>window.sidebarCurrent = {name: 'executor', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="theme-picker">
|
|||
|
|
<button id="theme-picker" aria-label="Pick another theme!">
|
|||
|
|
<img src="../../brush.svg" width="18" alt="Pick another theme!">
|
|||
|
|
</button>
|
|||
|
|
<div id="theme-choices"></div>
|
|||
|
|
</div>
|
|||
|
|
<script src="../../theme.js"></script>
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>tokio</a>::<wbr><a class="mod" href=''>executor</a></span><span class='out-of-band'><span id='render-detail'>
|
|||
|
|
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
|||
|
|
[<span class='inner'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../../src/tokio/executor/mod.rs.html#1-239' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<div class='docblock'><p>Task execution utilities.</p>
|
|||
|
|
<p>In the Tokio execution model, futures are lazy. When a future is created, no
|
|||
|
|
work is performed. In order for the work defined by the future to happen,
|
|||
|
|
the future must be submitted to an executor. A future that is submitted to
|
|||
|
|
an executor is called a "task".</p>
|
|||
|
|
<p>The executor executor is responsible for ensuring that <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#tymethod.poll"><code>Future::poll</code></a> is
|
|||
|
|
called whenever the task is <a href="https://docs.rs/futures/0.1/futures/executor/trait.Notify.html#tymethod.notify">notified</a>. Notification happens when the
|
|||
|
|
internal state of a task transitions from "not ready" to ready. For
|
|||
|
|
example, a socket might have received data and a call to <code>read</code> will now be
|
|||
|
|
able to succeed.</p>
|
|||
|
|
<p>The specific strategy used to manage the tasks is left up to the
|
|||
|
|
executor. There are two main flavors of executors: single-threaded and
|
|||
|
|
multithreaded. This module provides both.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p><strong><a href="current_thread/index.html"><code>current_thread</code></a></strong>: A single-threaded executor that support spawning
|
|||
|
|
tasks that are not <code>Send</code>. It guarantees that tasks will be executed on
|
|||
|
|
the same thread from which they are spawned.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p><strong><a href="thread_pool/index.html"><code>thread_pool</code></a></strong>: A multi-threaded executor that maintains a pool of
|
|||
|
|
threads. Tasks are spawned to one of the threads in the pool and executed.
|
|||
|
|
The pool employs a <a href="https://en.wikipedia.org/wiki/Work_stealing">work-stealing</a> strategy for optimizing how tasks get
|
|||
|
|
spread across the available threads.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h1 id="executor-trait" class="section-header"><a href="#executor-trait"><code>Executor</code> trait.</a></h1>
|
|||
|
|
<p>This module provides the <a href="#"><code>Executor</code></a> trait (re-exported from
|
|||
|
|
<a href="#"><code>tokio-executor</code></a>), which describes the API that all executors must
|
|||
|
|
implement.</p>
|
|||
|
|
<p>A free <a href="#"><code>spawn</code></a> function is provided that allows spawning futures onto the
|
|||
|
|
default executor (tracked via a thread-local variable) without referencing a
|
|||
|
|
handle. It is expected that all executors will set a value for the default
|
|||
|
|
executor. This value will often be set to the executor itself, but it is
|
|||
|
|
possible that the default executor might be set to a different executor.</p>
|
|||
|
|
<p>For example, the <a href="current_thread/index.html"><code>current_thread</code></a> executor might set the default executor
|
|||
|
|
to a thread pool instead of itself, allowing futures to spawn new tasks onto
|
|||
|
|
the thread pool when those tasks are <code>Send</code>.</p>
|
|||
|
|
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="current_thread/index.html"
|
|||
|
|
title='mod tokio::executor::current_thread'>current_thread</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Execute many tasks concurrently on the current thread.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="thread_pool/index.html"
|
|||
|
|
title='mod tokio::executor::thread_pool'>thread_pool</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Maintains a pool of threads across which the set of spawned tasks are
|
|||
|
|
executed.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.DefaultExecutor.html"
|
|||
|
|
title='struct tokio::executor::DefaultExecutor'>DefaultExecutor</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Executes futures on the default executor for the current execution context.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Spawn.html"
|
|||
|
|
title='struct tokio::executor::Spawn'>Spawn</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Return value from the <code>spawn</code> function.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.SpawnError.html"
|
|||
|
|
title='struct tokio::executor::SpawnError'>SpawnError</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Errors returned by <code>Executor::spawn</code>.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="trait" href="trait.Executor.html"
|
|||
|
|
title='trait tokio::executor::Executor'>Executor</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A value that executes futures.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.spawn.html"
|
|||
|
|
title='fn tokio::executor::spawn'>spawn</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Spawns a future on the default executor.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table></section>
|
|||
|
|
<section id='search' class="content hidden"></section>
|
|||
|
|
|
|||
|
|
<section class="footer"></section>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../";
|
|||
|
|
window.currentCrate = "tokio";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|