taskflow/docs/classtf_1_1ObserverInterface.html at task_isolation · ModuleWorks/taskflow · GitHub

History

255 lines (249 loc) · 20.3 KB

Raw

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

<!DOCTYPE html>

<head>

<title>tf::ObserverInterface class | Taskflow QuickStart</title>

</head>

<body>

<a href="https://taskflow.github.io"><img src="taskflow_logo.png" alt="" />Taskflow</a> | <a href="index.html" class="m-thin">QuickStart</a>

</svg></a>

</div>

<li><a href="pages.html">Handbook</a></li>

<li><a href="namespaces.html">Namespaces</a></li>

</ol>

<li><a href="annotated.html">Classes</a></li>

<li><a href="files.html">Files</a></li>

</svg></a></li>

</ol>

</div>

</nav></header>

<h1>

<a href="namespacetf.html">tf</a>::ObserverInterface class

<div class="m-doc-include m-code m-inverted m-text-right">#include <a class="cpf" href="observer_8hpp.html"><taskflow/core/observer.hpp></a></div>

</h1>

class to derive an executor observer

<h3>Contents</h3>

<ul>

<li>

Reference

<ul>

<li><a href="#derived-classes">Derived classes</a></li>

<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>

<li><a href="#pub-methods">Public functions</a></li>

</ul>

</li>

</ul>

</nav>

The <a href="classtf_1_1ObserverInterface.html" class="m-doc">tf::ObserverInterface</a> class allows users to define custom methods to monitor the behaviors of an executor. This is particularly useful when you want to inspect the performance of an executor and visualize when each thread participates in the execution of a task. To prevent users from direct access to the internal threads and tasks, <a href="classtf_1_1ObserverInterface.html" class="m-doc">tf::ObserverInterface</a> provides immutable wrappers, <a href="classtf_1_1WorkerView.html" class="m-doc">tf::WorkerView</a> and <a href="classtf_1_1TaskView.html" class="m-doc">tf::TaskView</a>, over workers and tasks.Please refer to <a href="classtf_1_1WorkerView.html" class="m-doc">tf::WorkerView</a> and <a href="classtf_1_1TaskView.html" class="m-doc">tf::TaskView</a> for details.Example usage:<pre class="m-code">struct MyObserver : public tf::ObserverInterface {

MyObserver(const std::string& name) {

std::cout << "constructing observer " << name << '\n';

}

void set_up(size_t num_workers) override final {

std::cout << "setting up observer with " << num_workers << " workers\n";

}

void on_entry(WorkerView w, tf::TaskView tv) override final {

std::ostringstream oss;

oss << "worker " << w.id() << " ready to run " << tv.name() << '\n';

}

void on_exit(WorkerView w, tf::TaskView tv) override final {

std::ostringstream oss;

oss << "worker " << w.id() << " finished running " << tv.name() << '\n';

}

};

tf::Taskflow taskflow;

tf::Executor executor;

// insert tasks into taskflow

// ...

// create a custom observer

std::shared_ptr<MyObserver> observer = executor.make_observer<MyObserver>("MyObserver");

// run the taskflow

executor.run(taskflow).wait();</pre>

<h2><a href="#derived-classes">Derived classes</a></h2>

<dt>

class <a href="classtf_1_1ChromeObserver.html" class="m-doc">ChromeObserver</a>

</dt>

<dd>class to create an observer based on Chrome tracing format</dd>

<dt>

class <a href="classtf_1_1TFProfObserver.html" class="m-doc">TFProfObserver</a>

</dt>

<dd>class to create an observer based on the built-in taskflow profiler format</dd>

</dl>

</section>

<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>

<a href="#adfd71c3af3ae2ea4f41eed26c1b6f604" class="m-doc-self">~ObserverInterface</a>() defaulted virtual

</dt>

<dd>virtual destructor</dd>

</dl>

</section>

<h2><a href="#pub-methods">Public functions</a></h2>

<dt>

void <a href="#a41e6e62f12bf9d9dc4fa74632f6825d9" class="m-doc">set_up</a>(size_t num_workers) pure virtual

</dt>

<dd>constructor-like method to call when the executor observer is fully created</dd>

<dt>

void <a href="#a8225fcacb03089677a1efc4b16b734cc" class="m-doc">on_entry</a>(<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) pure virtual

</dt>

<dd>method to call before a worker thread executes a closure</dd>

<dt>

void <a href="#aa22f5378154653f08d9a58326bda4754" class="m-doc">on_exit</a>(<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) pure virtual

</dt>

<dd>method to call after a worker thread executed a closure</dd>

</dl>

</section>

<h2>Function documentation</h2>

<h3>

void tf::ObserverInterface::<a href="#a41e6e62f12bf9d9dc4fa74632f6825d9" class="m-doc-self">set_up</a>(size_t num_workers) pure virtual

</h3>

constructor-like method to call when the executor observer is fully created

<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>

<h3>

void tf::ObserverInterface::<a href="#a8225fcacb03089677a1efc4b16b734cc" class="m-doc-self">on_entry</a>(<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) pure virtual

</h3>

method to call before a worker thread executes a closure

<thead>

<tr><th colspan="2">Parameters</th></tr>

</thead>

<tbody>

<tr>

<td>an immutable view of this worker thread</td>

</tr>

<tr>

<td>a constant wrapper object to the task</td>

</tr>

</tbody>

</table>

</div></section>

<h3>

void tf::ObserverInterface::<a href="#aa22f5378154653f08d9a58326bda4754" class="m-doc-self">on_exit</a>(<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) pure virtual

</h3>

method to call after a worker thread executed a closure

<thead>

<tr><th colspan="2">Parameters</th></tr>

</thead>

<tbody>

<tr>

<td>an immutable view of this worker thread</td>

</tr>

<tr>

<td>a constant wrapper object to the task</td>

</tr>

</tbody>

</table>

</div></section>

</section>

</div>

</article></main>

<div>Tab / T to search, Esc to close</div>

</div>

<form>

</form>

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.

Use ↓

/ ↑ to navigate through the list,

Enter to go.

Tab autocompletes common prefix, you can

copy a link to the result using ⌘

L while ⌘

M produces a Markdown link.

</div>

<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>

</div>

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–2025. Generated by <a href="https://doxygen.org/">Doxygen</a> 1.12.0 and <a href="https://mcss.mosra.cz/">m.css</a>.

</div>

</nav></footer>

</body>

</html>

taskflow/docs/classtf_1_1ObserverInterface.html at task_isolation · ModuleWorks/taskflow · GitHub

Expand file tree

Breadcrumbs

classtf_1_1ObserverInterface.html

Latest commit

History

Breadcrumbs

classtf_1_1ObserverInterface.html

File metadata and controls