Skip to content
Navigation Menu
{{ message }}
forked from taskflow/taskflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclasstf_1_1ObserverInterface.html
More file actions
273 lines (260 loc) · 12.6 KB
/
Copy pathclasstf_1_1ObserverInterface.html
File metadata and controls
273 lines (260 loc) · 12.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Taskflow Handbook</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link rel="icon" type="image/x-icon" href="favicon.ico" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://github.com/taskflow/taskflow">Taskflow</a>
 <span id="projectnumber">2.7.0-master-branch</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classtf_1_1ObserverInterface.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classtf_1_1ObserverInterface-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">tf::ObserverInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The interface class for creating an executor observer.
<a href="classtf_1_1ObserverInterface.html#details">More...</a></p>
<p><code>#include <<a class="el" href="observer_8hpp_source.html">observer.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for tf::ObserverInterface:</div>
<div class="dyncontent">
<div class="center"><img src="classtf_1_1ObserverInterface__inherit__graph.png" border="0" usemap="#tf_1_1ObserverInterface_inherit__map" alt="Inheritance graph"/></div>
<map name="tf_1_1ObserverInterface_inherit__map" id="tf_1_1ObserverInterface_inherit__map">
<area shape="rect" id="node2" href="classtf_1_1ChromeObserver.html" title="observer designed based on chrome tracing format " alt="" coords="5,79,144,104"/>
<area shape="rect" id="node3" href="classtf_1_1TFProfObserver.html" title="observer designed based on taskflow board format " alt="" coords="167,79,299,104"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adfd71c3af3ae2ea4f41eed26c1b6f604"><td class="memItemLeft" align="right" valign="top"><a id="adfd71c3af3ae2ea4f41eed26c1b6f604"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1ObserverInterface.html#adfd71c3af3ae2ea4f41eed26c1b6f604">~ObserverInterface</a> ()=default</td></tr>
<tr class="memdesc:adfd71c3af3ae2ea4f41eed26c1b6f604"><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor <br /></td></tr>
<tr class="separator:adfd71c3af3ae2ea4f41eed26c1b6f604"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41e6e62f12bf9d9dc4fa74632f6825d9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1ObserverInterface.html#a41e6e62f12bf9d9dc4fa74632f6825d9">set_up</a> (size_t num_workers)=0</td></tr>
<tr class="memdesc:a41e6e62f12bf9d9dc4fa74632f6825d9"><td class="mdescLeft"> </td><td class="mdescRight">constructor-like method to call when the executor observer is fully created <a href="#a41e6e62f12bf9d9dc4fa74632f6825d9">More...</a><br /></td></tr>
<tr class="separator:a41e6e62f12bf9d9dc4fa74632f6825d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa57654edd6d0fcf188a6064823f3048"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1ObserverInterface.html#afa57654edd6d0fcf188a6064823f3048">on_entry</a> (size_t worker_id, <a class="el" href="classtf_1_1TaskView.html">TaskView</a> task_view)=0</td></tr>
<tr class="memdesc:afa57654edd6d0fcf188a6064823f3048"><td class="mdescLeft"> </td><td class="mdescRight">method to call before a worker thread executes a closure <a href="#afa57654edd6d0fcf188a6064823f3048">More...</a><br /></td></tr>
<tr class="separator:afa57654edd6d0fcf188a6064823f3048"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8fcff02bfcea581d280e4de0247760d3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1ObserverInterface.html#a8fcff02bfcea581d280e4de0247760d3">on_exit</a> (size_t worker_id, <a class="el" href="classtf_1_1TaskView.html">TaskView</a> task_view)=0</td></tr>
<tr class="memdesc:a8fcff02bfcea581d280e4de0247760d3"><td class="mdescLeft"> </td><td class="mdescRight">method to call after a worker thread executed a closure <a href="#a8fcff02bfcea581d280e4de0247760d3">More...</a><br /></td></tr>
<tr class="separator:a8fcff02bfcea581d280e4de0247760d3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a763b2f90bc53f92d680a635fe28e858e"><td class="memItemLeft" align="right" valign="top"><a id="a763b2f90bc53f92d680a635fe28e858e"></a>
class </td><td class="memItemRight" valign="bottom"><b>Executor</b></td></tr>
<tr class="separator:a763b2f90bc53f92d680a635fe28e858e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The interface class for creating an executor observer. </p>
<p>The tf::ExecutorObserver class let users define methods to monitor the behaviors of an executor. This is particularly useful when you want to inspect the performance of an executor. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="afa57654edd6d0fcf188a6064823f3048"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa57654edd6d0fcf188a6064823f3048">◆ </a></span>on_entry()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void tf::ObserverInterface::on_entry </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>worker_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classtf_1_1TaskView.html">TaskView</a> </td>
<td class="paramname"><em>task_view</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>method to call before a worker thread executes a closure </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">worker_id</td><td>the id of this worker thread </td></tr>
<tr><td class="paramname">task_view</td><td>a constant wrapper object to the task </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8fcff02bfcea581d280e4de0247760d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fcff02bfcea581d280e4de0247760d3">◆ </a></span>on_exit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void tf::ObserverInterface::on_exit </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>worker_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classtf_1_1TaskView.html">TaskView</a> </td>
<td class="paramname"><em>task_view</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>method to call after a worker thread executed a closure </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">worker_id</td><td>the id of this worker thread </td></tr>
<tr><td class="paramname">task_view</td><td>a constant wrapper object to the task </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a41e6e62f12bf9d9dc4fa74632f6825d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41e6e62f12bf9d9dc4fa74632f6825d9">◆ </a></span>set_up()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void tf::ObserverInterface::set_up </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>num_workers</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>constructor-like method to call when the executor observer is fully created </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">num_workers</td><td>the number of the worker threads in the executor </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="observer_8hpp_source.html">observer.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>tf</b></li><li class="navelem"><a class="el" href="classtf_1_1ObserverInterface.html">ObserverInterface</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
You can’t perform that action at this time.