332 lines
11 KiB
HTML
332 lines
11 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>executor</title>
|
|
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
|
<link rel="home" href="../../index.html" title="Asio">
|
|
<link rel="up" href="../reference.html" title="Reference">
|
|
<link rel="prev" href="execution_context__service/shutdown.html" title="execution_context::service::shutdown">
|
|
<link rel="next" href="executor/context.html" title="executor::context">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="execution_context__service/shutdown.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="executor/context.html"><img src="../../next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h3 class="title">
|
|
<a name="asio.reference.executor"></a><a class="link" href="executor.html" title="executor">executor</a>
|
|
</h3></div></div></div>
|
|
<p>
|
|
<a class="indexterm" name="asio.indexterm.executor"></a>
|
|
</p>
|
|
<p>
|
|
Polymorphic wrapper for executors.
|
|
</p>
|
|
<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">executor</span>
|
|
</pre>
|
|
<h5>
|
|
<a name="asio.reference.executor.h0"></a>
|
|
<span><a name="asio.reference.executor.types"></a></span><a class="link" href="executor.html#asio.reference.executor.types">Types</a>
|
|
</h5>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Name
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor__unspecified_bool_type_t.html" title="executor::unspecified_bool_type_t"><span class="bold"><strong>unspecified_bool_type_t</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/unspecified_bool_type.html" title="executor::unspecified_bool_type"><span class="bold"><strong>unspecified_bool_type</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h5>
|
|
<a name="asio.reference.executor.h1"></a>
|
|
<span><a name="asio.reference.executor.member_functions"></a></span><a class="link" href="executor.html#asio.reference.executor.member_functions">Member
|
|
Functions</a>
|
|
</h5>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Name
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/context.html" title="executor::context"><span class="bold"><strong>context</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Obtain the underlying execution context.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/defer.html" title="executor::defer"><span class="bold"><strong>defer</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Request the executor to invoke the given function object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/dispatch.html" title="executor::dispatch"><span class="bold"><strong>dispatch</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Request the executor to invoke the given function object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/executor.html" title="executor::executor"><span class="bold"><strong>executor</strong></span></a>
|
|
<span class="silver">[constructor]</span>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Default constructor. <br> <span class="silver"> —</span><br> Construct from nullptr. <br>
|
|
<span class="silver"> —</span><br> Copy constructor. <br> <span class="silver"> —</span><br> Move constructor. <br>
|
|
<span class="silver"> —</span><br> Construct a polymorphic wrapper for the specified executor.
|
|
<br> <span class="silver"> —</span><br> Allocator-aware constructor to create a polymorphic
|
|
wrapper for the specified executor.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/on_work_finished.html" title="executor::on_work_finished"><span class="bold"><strong>on_work_finished</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Inform the executor that some work is no longer outstanding.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/on_work_started.html" title="executor::on_work_started"><span class="bold"><strong>on_work_started</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Inform the executor that it has some outstanding work to do.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/operator_unspecified_bool_type.html" title="executor::operator unspecified_bool_type"><span class="bold"><strong>operator unspecified_bool_type</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Operator to test if the executor contains a valid target.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/operator_eq_.html" title="executor::operator="><span class="bold"><strong>operator=</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Assignment operator. <br> <span class="silver"> —</span><br>
|
|
</p>
|
|
<p>
|
|
<br> <span class="silver"> —</span><br> Assignment operator for nullptr_t. <br> <span class="silver"> —</span><br>
|
|
Assignment operator to create a polymorphic wrapper for the specified
|
|
executor.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/post.html" title="executor::post"><span class="bold"><strong>post</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Request the executor to invoke the given function object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/target.html" title="executor::target"><span class="bold"><strong>target</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Obtain a pointer to the target executor object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/target_type.html" title="executor::target_type"><span class="bold"><strong>target_type</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Obtain type information for the target executor object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/unspecified_bool_true.html" title="executor::unspecified_bool_true"><span class="bold"><strong>unspecified_bool_true</strong></span></a> <span class="silver">[static]</span>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/_executor.html" title="executor::~executor"><span class="bold"><strong>~executor</strong></span></a>
|
|
<span class="silver">[destructor]</span>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Destructor.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h5>
|
|
<a name="asio.reference.executor.h2"></a>
|
|
<span><a name="asio.reference.executor.friends"></a></span><a class="link" href="executor.html#asio.reference.executor.friends">Friends</a>
|
|
</h5>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Name
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/operator_not__eq_.html" title="executor::operator!="><span class="bold"><strong>operator!=</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Compare two executors for inequality.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="executor/operator_eq__eq_.html" title="executor::operator=="><span class="bold"><strong>operator==</strong></span></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Compare two executors for equality.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h5>
|
|
<a name="asio.reference.executor.h3"></a>
|
|
<span><a name="asio.reference.executor.requirements"></a></span><a class="link" href="executor.html#asio.reference.executor.requirements">Requirements</a>
|
|
</h5>
|
|
<p>
|
|
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/executor.hpp</code>
|
|
</p>
|
|
<p>
|
|
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
|
|
</p>
|
|
</div>
|
|
<div class="copyright-footer">Copyright © 2003-2023 Christopher M. Kohlhoff<p>
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="execution_context__service/shutdown.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="executor/context.html"><img src="../../next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|