-
Notifications
You must be signed in to change notification settings - Fork 0
/
classapf_1_1CommandQueue.html
452 lines (402 loc) · 24.7 KB
/
classapf_1_1CommandQueue.html
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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audio Processing Framework (APF): apf::CommandQueue Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></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 id="projectrow">
<td id="projectalign">
<div id="projectname">Audio Processing Framework (APF)<span id="projectnumber"> version 0.5.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceapf.html">apf</a></li><li class="navelem"><a class="el" href="classapf_1_1CommandQueue.html">CommandQueue</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="classapf_1_1CommandQueue-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">apf::CommandQueue Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Manage command queue from non-realtime thread to realtime thread.
<a href="classapf_1_1CommandQueue.html#details">More...</a></p>
<p><code>#include <<a class="el" href="commandqueue_8h_source.html">apf/commandqueue.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for apf::CommandQueue:</div>
<div class="dyncontent">
<div class="center"><img src="classapf_1_1CommandQueue__inherit__graph.png" border="0" usemap="#aapf_1_1CommandQueue_inherit__map" alt="Inheritance graph"/></div>
<map name="aapf_1_1CommandQueue_inherit__map" id="aapf_1_1CommandQueue_inherit__map">
<area shape="rect" title="Manage command queue from non-realtime thread to realtime thread." alt="" coords="5,80,164,107"/>
<area shape="rect" href="classapf_1_1NonCopyable.html" title="Classes derived from this class cannot be copied (but still moved)." alt="" coords="16,5,153,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structapf_1_1CommandQueue_1_1Command.html">Command</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Abstract base class for realtime commands. <a href="structapf_1_1CommandQueue_1_1Command.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CommandQueue_1_1WaitCommand.html">WaitCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Dummy command to synchronize with non-realtime thread. <a href="classapf_1_1CommandQueue_1_1WaitCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions to be called from the non-realtime thread</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p >If there are multiple non-realtime threads, access has to be locked! </p>
</div></td></tr>
<tr class="memitem:ab7b9f265d73394689c9b49a2af1c3041"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CommandQueue.html#ab7b9f265d73394689c9b49a2af1c3041">CommandQueue</a> (size_t size)</td></tr>
<tr class="memdesc:ab7b9f265d73394689c9b49a2af1c3041"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classapf_1_1CommandQueue.html#ab7b9f265d73394689c9b49a2af1c3041">More...</a><br /></td></tr>
<tr class="separator:ab7b9f265d73394689c9b49a2af1c3041"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1360a2b4dc81ca2e5f2874220d8141ee"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CommandQueue.html#a1360a2b4dc81ca2e5f2874220d8141ee">~CommandQueue</a> ()</td></tr>
<tr class="memdesc:a1360a2b4dc81ca2e5f2874220d8141ee"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classapf_1_1CommandQueue.html#a1360a2b4dc81ca2e5f2874220d8141ee">More...</a><br /></td></tr>
<tr class="separator:a1360a2b4dc81ca2e5f2874220d8141ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92b0905481ebf76fa36f397ed75bca3a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CommandQueue.html#a92b0905481ebf76fa36f397ed75bca3a">push</a> (<a class="el" href="structapf_1_1CommandQueue_1_1Command.html">Command</a> *cmd)</td></tr>
<tr class="memdesc:a92b0905481ebf76fa36f397ed75bca3a"><td class="mdescLeft"> </td><td class="mdescRight">Push a command to be executed in the realtime thread. <a href="classapf_1_1CommandQueue.html#a92b0905481ebf76fa36f397ed75bca3a">More...</a><br /></td></tr>
<tr class="separator:a92b0905481ebf76fa36f397ed75bca3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abba1fd9f34193fa20ae71802fa654c03"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CommandQueue.html#abba1fd9f34193fa20ae71802fa654c03">wait</a> ()</td></tr>
<tr class="memdesc:abba1fd9f34193fa20ae71802fa654c03"><td class="mdescLeft"> </td><td class="mdescRight">Wait for realtime thread. <a href="classapf_1_1CommandQueue.html#abba1fd9f34193fa20ae71802fa654c03">More...</a><br /></td></tr>
<tr class="separator:abba1fd9f34193fa20ae71802fa654c03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1803ff624ffb7042e7932ee2d1c21c20"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CommandQueue.html#a1803ff624ffb7042e7932ee2d1c21c20">cleanup_commands</a> ()</td></tr>
<tr class="memdesc:a1803ff624ffb7042e7932ee2d1c21c20"><td class="mdescLeft"> </td><td class="mdescRight">Clean up all commands in the cleanup-queue. <a href="classapf_1_1CommandQueue.html#a1803ff624ffb7042e7932ee2d1c21c20">More...</a><br /></td></tr>
<tr class="separator:a1803ff624ffb7042e7932ee2d1c21c20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30768993e12bf22e2b951bad51565844"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CommandQueue.html#a30768993e12bf22e2b951bad51565844">deactivate</a> ()</td></tr>
<tr class="memdesc:a30768993e12bf22e2b951bad51565844"><td class="mdescLeft"> </td><td class="mdescRight">Deactivate queue; process following commands in the non-realtime thread. <a href="classapf_1_1CommandQueue.html#a30768993e12bf22e2b951bad51565844">More...</a><br /></td></tr>
<tr class="separator:a30768993e12bf22e2b951bad51565844"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae27ff38977fdc52d26caa0e81300b69d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CommandQueue.html#ae27ff38977fdc52d26caa0e81300b69d">reactivate</a> ()</td></tr>
<tr class="memdesc:ae27ff38977fdc52d26caa0e81300b69d"><td class="mdescLeft"> </td><td class="mdescRight">Re-activate queue. <a href="classapf_1_1CommandQueue.html#ae27ff38977fdc52d26caa0e81300b69d">More...</a><br /></td></tr>
<tr class="separator:ae27ff38977fdc52d26caa0e81300b69d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader">Functions to be called from the realtime thread</h2></td></tr>
<tr class="memitem:a23b7d6c38defaa954f1b8351158b9de4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CommandQueue.html#a23b7d6c38defaa954f1b8351158b9de4">process_commands</a> ()</td></tr>
<tr class="memdesc:a23b7d6c38defaa954f1b8351158b9de4"><td class="mdescLeft"> </td><td class="mdescRight">Execute all commands in the queue. <a href="classapf_1_1CommandQueue.html#a23b7d6c38defaa954f1b8351158b9de4">More...</a><br /></td></tr>
<tr class="separator:a23b7d6c38defaa954f1b8351158b9de4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed2d8571a7594a80d5fbcac0a33a4efb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CommandQueue.html#aed2d8571a7594a80d5fbcac0a33a4efb">commands_available</a> () const</td></tr>
<tr class="memdesc:aed2d8571a7594a80d5fbcac0a33a4efb"><td class="mdescLeft"> </td><td class="mdescRight">Check if commands are available. <a href="classapf_1_1CommandQueue.html#aed2d8571a7594a80d5fbcac0a33a4efb">More...</a><br /></td></tr>
<tr class="separator:aed2d8571a7594a80d5fbcac0a33a4efb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Manage command queue from non-realtime thread to realtime thread. </p>
<p >Commands can be added in the non-realtime thread with <a class="el" href="classapf_1_1CommandQueue.html#a92b0905481ebf76fa36f397ed75bca3a" title="Push a command to be executed in the realtime thread.">push()</a>.</p>
<p >Commands are executed when <a class="el" href="classapf_1_1CommandQueue.html#a23b7d6c38defaa954f1b8351158b9de4" title="Execute all commands in the queue.">process_commands()</a> is called from the realtime thread. </p>
<p class="definition">Definition at line <a class="el" href="commandqueue_8h_source.html#l00048">48</a> of file <a class="el" href="commandqueue_8h_source.html">commandqueue.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab7b9f265d73394689c9b49a2af1c3041" name="ab7b9f265d73394689c9b49a2af1c3041"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7b9f265d73394689c9b49a2af1c3041">◆ </a></span>CommandQueue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">apf::CommandQueue::CommandQueue </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>maximum number of commands in queue. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="commandqueue_8h_source.html#l00088">88</a> of file <a class="el" href="commandqueue_8h_source.html">commandqueue.h</a>.</p>
</div>
</div>
<a id="a1360a2b4dc81ca2e5f2874220d8141ee" name="a1360a2b4dc81ca2e5f2874220d8141ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1360a2b4dc81ca2e5f2874220d8141ee">◆ </a></span>~CommandQueue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">apf::CommandQueue::~CommandQueue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<dl class="section attention"><dt>Attention</dt><dd>Commands in the cleanup queue are cleaned up, but commands in the process queue are ignored and their memory is not freed! </dd></dl>
<p class="definition">Definition at line <a class="el" href="commandqueue_8h_source.html#l00097">97</a> of file <a class="el" href="commandqueue_8h_source.html">commandqueue.h</a>.</p>
<p class="reference">References <a class="el" href="commandqueue_8h_source.html#l00110">cleanup_commands()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a92b0905481ebf76fa36f397ed75bca3a" name="a92b0905481ebf76fa36f397ed75bca3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92b0905481ebf76fa36f397ed75bca3a">◆ </a></span>push()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void apf::CommandQueue::push </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structapf_1_1CommandQueue_1_1Command.html">Command</a> * </td>
<td class="paramname"><em>cmd</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Push a command to be executed in the realtime thread. </p>
<p >The command will be cleaned up when it comes back from the realtime thread. If the <a class="el" href="classapf_1_1CommandQueue.html" title="Manage command queue from non-realtime thread to realtime thread.">CommandQueue</a> is inactive, the command is not queued but executed and cleaned up immediately. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cmd</td><td>The command to be executed. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="commandqueue_8h_source.html#l00192">192</a> of file <a class="el" href="commandqueue_8h_source.html">commandqueue.h</a>.</p>
<p class="reference">References <a class="el" href="commandqueue_8h_source.html#l00110">cleanup_commands()</a>, and <a class="el" href="structapf_1_1CommandQueue_1_1Command.html#a49a784a8d8d88103d66e4bfe0df02202">apf::CommandQueue::Command::execute()</a>.</p>
<p class="reference">Referenced by <a class="el" href="commandqueue_8h_source.html#l00219">wait()</a>.</p>
</div>
</div>
<a id="abba1fd9f34193fa20ae71802fa654c03" name="abba1fd9f34193fa20ae71802fa654c03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abba1fd9f34193fa20ae71802fa654c03">◆ </a></span>wait()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void apf::CommandQueue::wait </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait for realtime thread. </p>
<p >Push an empty command and wait for its return. </p>
<p class="definition">Definition at line <a class="el" href="commandqueue_8h_source.html#l00219">219</a> of file <a class="el" href="commandqueue_8h_source.html">commandqueue.h</a>.</p>
<p class="reference">References <a class="el" href="commandqueue_8h_source.html#l00110">cleanup_commands()</a>, and <a class="el" href="commandqueue_8h_source.html#l00192">push()</a>.</p>
</div>
</div>
<a id="a1803ff624ffb7042e7932ee2d1c21c20" name="a1803ff624ffb7042e7932ee2d1c21c20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1803ff624ffb7042e7932ee2d1c21c20">◆ </a></span>cleanup_commands()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void apf::CommandQueue::cleanup_commands </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clean up all commands in the cleanup-queue. </p>
<dl class="section note"><dt>Note</dt><dd>This function must be called from the non-realtime thread. </dd></dl>
<p class="definition">Definition at line <a class="el" href="commandqueue_8h_source.html#l00110">110</a> of file <a class="el" href="commandqueue_8h_source.html">commandqueue.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="commandqueue_8h_source.html#l00121">deactivate()</a>, <a class="el" href="commandqueue_8h_source.html#l00192">push()</a>, <a class="el" href="commandqueue_8h_source.html#l00129">reactivate()</a>, <a class="el" href="commandqueue_8h_source.html#l00219">wait()</a>, and <a class="el" href="commandqueue_8h_source.html#l00097">~CommandQueue()</a>.</p>
</div>
</div>
<a id="a30768993e12bf22e2b951bad51565844" name="a30768993e12bf22e2b951bad51565844"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30768993e12bf22e2b951bad51565844">◆ </a></span>deactivate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool apf::CommandQueue::deactivate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deactivate queue; process following commands in the non-realtime thread. </p>
<dl class="section return"><dt>Returns</dt><dd><b>true</b> on success </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The queue must be empty. If not, the queue is <em>not</em> deactivated and <b>false</b> is returned. </dd></dl>
<p class="definition">Definition at line <a class="el" href="commandqueue_8h_source.html#l00121">121</a> of file <a class="el" href="commandqueue_8h_source.html">commandqueue.h</a>.</p>
<p class="reference">References <a class="el" href="commandqueue_8h_source.html#l00110">cleanup_commands()</a>.</p>
<p class="reference">Referenced by <a class="el" href="mimoprocessor_8h_source.html#l00451">apf::MimoProcessor< Derived, interface_policy, query_policy >::MimoProcessor()</a>.</p>
</div>
</div>
<a id="ae27ff38977fdc52d26caa0e81300b69d" name="ae27ff38977fdc52d26caa0e81300b69d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae27ff38977fdc52d26caa0e81300b69d">◆ </a></span>reactivate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void apf::CommandQueue::reactivate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Re-activate queue. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classapf_1_1CommandQueue.html#a30768993e12bf22e2b951bad51565844" title="Deactivate queue; process following commands in the non-realtime thread.">deactivate()</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="commandqueue_8h_source.html#l00129">129</a> of file <a class="el" href="commandqueue_8h_source.html">commandqueue.h</a>.</p>
<p class="reference">References <a class="el" href="commandqueue_8h_source.html#l00110">cleanup_commands()</a>.</p>
</div>
</div>
<a id="a23b7d6c38defaa954f1b8351158b9de4" name="a23b7d6c38defaa954f1b8351158b9de4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23b7d6c38defaa954f1b8351158b9de4">◆ </a></span>process_commands()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void apf::CommandQueue::process_commands </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute all commands in the queue. </p>
<p >After execution, the commands are queued for cleanup in the non-realtime thread. </p><dl class="section note"><dt>Note</dt><dd>This function must be called from the realtime thread. </dd></dl>
<p class="definition">Definition at line <a class="el" href="commandqueue_8h_source.html#l00145">145</a> of file <a class="el" href="commandqueue_8h_source.html">commandqueue.h</a>.</p>
<p class="reference">References <a class="el" href="structapf_1_1CommandQueue_1_1Command.html#a49a784a8d8d88103d66e4bfe0df02202">apf::CommandQueue::Command::execute()</a>.</p>
</div>
</div>
<a id="aed2d8571a7594a80d5fbcac0a33a4efb" name="aed2d8571a7594a80d5fbcac0a33a4efb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed2d8571a7594a80d5fbcac0a33a4efb">◆ </a></span>commands_available()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool apf::CommandQueue::commands_available </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if commands are available. </p>
<dl class="section return"><dt>Returns</dt><dd><b>true</b> if commands are available. </dd></dl>
<p class="definition">Definition at line <a class="el" href="commandqueue_8h_source.html#l00161">161</a> of file <a class="el" href="commandqueue_8h_source.html">commandqueue.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>apf/<a class="el" href="commandqueue_8h_source.html">commandqueue.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>