243 lines
15 KiB
HTML
243 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<title>tf::ChromeObserver class | Taskflow QuickStart</title>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
|
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
|
<link rel="icon" href="favicon.ico" type="image/vnd.microsoft.icon" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta name="theme-color" content="#22272e" />
|
|
</head>
|
|
<body>
|
|
<header><nav id="navigation">
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
|
|
<a href="https://taskflow.github.io"><img src="taskflow_logo.png" alt="" />Taskflow</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">QuickStart</a>
|
|
</span>
|
|
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
|
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
|
</svg></a>
|
|
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
|
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
|
</div>
|
|
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
|
<div class="m-row">
|
|
<ol class="m-col-t-6 m-col-m-none">
|
|
<li><a href="pages.html">Handbook</a></li>
|
|
<li><a href="namespaces.html">Namespaces</a></li>
|
|
</ol>
|
|
<ol class="m-col-t-6 m-col-m-none" start="3">
|
|
<li><a href="annotated.html">Classes</a></li>
|
|
<li><a href="files.html">Files</a></li>
|
|
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<use href="#m-doc-search-icon-path" />
|
|
</svg></a></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></header>
|
|
<main><article>
|
|
<div class="m-container m-container-inflatable">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<h1>
|
|
<span class="m-breadcrumb"><a href="namespacetf.html">tf</a>::<wbr/></span>ChromeObserver <span class="m-thin">class</span>
|
|
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="observer_8hpp.html"><taskflow/core/observer.hpp></a></div>
|
|
</h1>
|
|
<p>class to create an observer based on Chrome tracing format</p>
|
|
<nav class="m-block m-default">
|
|
<h3>Contents</h3>
|
|
<ul>
|
|
<li>
|
|
Reference
|
|
<ul>
|
|
<li><a href="#base-classes">Base classes</a></li>
|
|
<li><a href="#pub-methods">Public functions</a></li>
|
|
<li><a href="#pri-methods">Private functions</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<p>A <a href="classtf_1_1ChromeObserver.html" class="m-doc">tf::<wbr />ChromeObserver</a> inherits <a href="classtf_1_1ObserverInterface.html" class="m-doc">tf::<wbr />ObserverInterface</a> and defines methods to dump the observed thread activities into a format that can be visualized through <a href="https://www.chromium.org/developers/how-tos/trace-event-profiling-tool">Chrome Tracing</a>.</p><pre class="m-code"><span class="n">tf</span><span class="o">::</span><span class="n">Taskflow</span><span class="w"> </span><span class="n">taskflow</span><span class="p">;</span>
|
|
<span class="n">tf</span><span class="o">::</span><span class="n">Executor</span><span class="w"> </span><span class="n">executor</span><span class="p">;</span>
|
|
|
|
<span class="c1">// insert tasks into taskflow</span>
|
|
<span class="c1">// ...</span>
|
|
<span class="w"> </span>
|
|
<span class="c1">// create a custom observer</span>
|
|
<span class="n">std</span><span class="o">::</span><span class="n">shared_ptr</span><span class="o"><</span><span class="n">tf</span><span class="o">::</span><span class="n">ChromeObserver</span><span class="o">></span><span class="w"> </span><span class="n">observer</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">executor</span><span class="p">.</span><span class="n">make_observer</span><span class="o"><</span><span class="n">tf</span><span class="o">::</span><span class="n">ChromeObserver</span><span class="o">></span><span class="p">();</span>
|
|
|
|
<span class="c1">// run the taskflow</span>
|
|
<span class="n">executor</span><span class="p">.</span><span class="n">run</span><span class="p">(</span><span class="n">taskflow</span><span class="p">).</span><span class="n">wait</span><span class="p">();</span>
|
|
|
|
<span class="c1">// dump the thread activities to a chrome-tracing format.</span>
|
|
<span class="n">observer</span><span class="o">-></span><span class="n">dump</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">cout</span><span class="p">);</span></pre>
|
|
<section id="base-classes">
|
|
<h2><a href="#base-classes">Base classes</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
class <a href="classtf_1_1ObserverInterface.html" class="m-doc">ObserverInterface</a>
|
|
</dt>
|
|
<dd>class to derive an executor observer</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="pub-methods">
|
|
<h2><a href="#pub-methods">Public functions</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a5df3852d8525cabafee696d5f77b3fd7">
|
|
<span class="m-doc-wrap-bumper">void <a href="#a5df3852d8525cabafee696d5f77b3fd7" class="m-doc-self">dump</a>(</span><span class="m-doc-wrap"><a href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" class="m-doc-external">std::<wbr />ostream</a>& ostream) const</span>
|
|
</dt>
|
|
<dd>dumps the timelines into a <a href="https://www.chromium.org/developers/how-tos/trace-event-profiling-tool">Chrome Tracing</a> format through an output stream</dd>
|
|
<dt id="a414d60cee91db1d3924636fcea5f4ea7">
|
|
<span class="m-doc-wrap-bumper">auto <a href="#a414d60cee91db1d3924636fcea5f4ea7" class="m-doc-self">dump</a>(</span><span class="m-doc-wrap">) const -> <a href="http://en.cppreference.com/w/cpp/string/basic_string.html" class="m-doc-external">std::<wbr />string</a></span>
|
|
</dt>
|
|
<dd>dumps the timelines into a <a href="https://www.chromium.org/developers/how-tos/trace-event-profiling-tool">Chrome Tracing</a> format</dd>
|
|
<dt id="a3948e57186155a6934c100447cb9332d">
|
|
<span class="m-doc-wrap-bumper">void <a href="#a3948e57186155a6934c100447cb9332d" class="m-doc-self">clear</a>(</span><span class="m-doc-wrap">)</span>
|
|
</dt>
|
|
<dd>clears the timeline data</dd>
|
|
<dt id="a44032b7607de5dd929683739f4df9ef2">
|
|
<span class="m-doc-wrap-bumper">auto <a href="#a44032b7607de5dd929683739f4df9ef2" class="m-doc-self">num_tasks</a>(</span><span class="m-doc-wrap">) const -> size_t</span>
|
|
</dt>
|
|
<dd>queries the number of tasks observed</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="pri-methods">
|
|
<h2><a href="#pri-methods">Private functions</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">void <a href="#aa8d5d9c3d0de7e7006d27079d8eb3888" class="m-doc">set_up</a>(</span><span class="m-doc-wrap">size_t num_workers) <span class="m-label m-flat m-warning">final</span></span>
|
|
</dt>
|
|
<dd>constructor-like method to call when the executor observer is fully created</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">void <a href="#a6fa502ca5ef6bfb9d2168db190125855" class="m-doc">on_entry</a>(</span><span class="m-doc-wrap"><a href="classtf_1_1WorkerView.html" class="m-doc">WorkerView</a> wv,
|
|
<a href="classtf_1_1TaskView.html" class="m-doc">TaskView</a> task_view) <span class="m-label m-flat m-warning">final</span></span>
|
|
</dt>
|
|
<dd>method to call before a worker thread executes a closure</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">void <a href="#a62ae8c50814d285d29e50a322461a803" class="m-doc">on_exit</a>(</span><span class="m-doc-wrap"><a href="classtf_1_1WorkerView.html" class="m-doc">WorkerView</a> wv,
|
|
<a href="classtf_1_1TaskView.html" class="m-doc">TaskView</a> task_view) <span class="m-label m-flat m-warning">final</span></span>
|
|
</dt>
|
|
<dd>method to call after a worker thread executed a closure</dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
<h2>Function documentation</h2>
|
|
<section class="m-doc-details" id="aa8d5d9c3d0de7e7006d27079d8eb3888"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">void tf::<wbr />ChromeObserver::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa8d5d9c3d0de7e7006d27079d8eb3888" class="m-doc-self">set_up</a>(</span><span class="m-doc-wrap">size_t num_workers) <span class="m-label m-warning">final</span> <span class="m-label m-danger">private</span></span></span>
|
|
</h3>
|
|
<p>constructor-like method to call when the executor observer is fully created</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">num_workers</td>
|
|
<td>the number of the worker threads in the executor</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a6fa502ca5ef6bfb9d2168db190125855"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">void tf::<wbr />ChromeObserver::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a6fa502ca5ef6bfb9d2168db190125855" class="m-doc-self">on_entry</a>(</span><span class="m-doc-wrap"><a href="classtf_1_1WorkerView.html" class="m-doc">WorkerView</a> wv,
|
|
<a href="classtf_1_1TaskView.html" class="m-doc">TaskView</a> task_view) <span class="m-label m-warning">final</span> <span class="m-label m-danger">private</span></span></span>
|
|
</h3>
|
|
<p>method to call before a worker thread executes a closure</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">wv</td>
|
|
<td>an immutable view of this worker thread</td>
|
|
</tr>
|
|
<tr>
|
|
<td>task_view</td>
|
|
<td>a constant wrapper object to the task</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a62ae8c50814d285d29e50a322461a803"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">void tf::<wbr />ChromeObserver::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a62ae8c50814d285d29e50a322461a803" class="m-doc-self">on_exit</a>(</span><span class="m-doc-wrap"><a href="classtf_1_1WorkerView.html" class="m-doc">WorkerView</a> wv,
|
|
<a href="classtf_1_1TaskView.html" class="m-doc">TaskView</a> task_view) <span class="m-label m-warning">final</span> <span class="m-label m-danger">private</span></span></span>
|
|
</h3>
|
|
<p>method to call after a worker thread executed a closure</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">wv</td>
|
|
<td>an immutable view of this worker thread</td>
|
|
</tr>
|
|
<tr>
|
|
<td>task_view</td>
|
|
<td>a constant wrapper object to the task</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div></section>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</article></main>
|
|
<div class="m-doc-search" id="search">
|
|
<a href="#!" onclick="return hideSearch()"></a>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-m-8 m-push-m-2">
|
|
<div class="m-doc-search-header m-text m-small">
|
|
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
|
<div id="search-symbolcount">…</div>
|
|
</div>
|
|
<div class="m-doc-search-content">
|
|
<form>
|
|
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
|
</form>
|
|
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
|
<div id="search-help" class="m-text m-dim m-text-center">
|
|
<p class="m-noindent">Search for symbols, directories, files, pages or
|
|
modules. You can omit any prefix from the symbol or file path; adding a
|
|
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
|
directory.</p>
|
|
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
|
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
|
<span class="m-label m-dim">Enter</span> to go.
|
|
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
|
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
|
</div>
|
|
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
|
<ul id="search-results"></ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src="search-v2.js"></script>
|
|
<script src="searchdata-v2.js" async="async"></script>
|
|
<footer><nav>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<p>Taskflow handbook is part of the <a href="https://taskflow.github.io">Taskflow project</a>, copyright © <a href="https://tsung-wei-huang.github.io/">Dr. Tsung-Wei Huang</a>, 2018–2024.<br />Generated by <a href="https://doxygen.org/">Doxygen</a> 1.9.1 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></footer>
|
|
</body>
|
|
</html>
|