blob: dc0021e7b6b380055463f81516347a40afacabaa [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +01001<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: AsyncCallbackManager Class Reference</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.05</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('classarmnn_1_1experimental_1_1_async_callback_manager.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="summary">
96<a href="#pub-methods">Public Member Functions</a> &#124;
97<a href="classarmnn_1_1experimental_1_1_async_callback_manager-members.html">List of all members</a> </div>
98 <div class="headertitle">
99<div class="title">AsyncCallbackManager Class Reference</div> </div>
100</div><!--header-->
101<div class="contents">
102
103<p><code>#include &lt;<a class="el" href="_async_execution_callback_8hpp_source.html">AsyncExecutionCallback.hpp</a>&gt;</code></p>
104<table class="memberdecls">
105<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
106Public Member Functions</h2></td></tr>
107<tr class="memitem:a27aff9e4e5d9bce49988a2de6a1ebc59"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classarmnn_1_1experimental_1_1_async_execution_callback.html">AsyncExecutionCallback</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_async_callback_manager.html#a27aff9e4e5d9bce49988a2de6a1ebc59">GetNewCallback</a> ()</td></tr>
108<tr class="separator:a27aff9e4e5d9bce49988a2de6a1ebc59"><td class="memSeparator" colspan="2">&#160;</td></tr>
109<tr class="memitem:a9ee5b1dd7d3a6f619d2ed3d97d75d9b1"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classarmnn_1_1experimental_1_1_async_execution_callback.html">AsyncExecutionCallback</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_async_callback_manager.html#a9ee5b1dd7d3a6f619d2ed3d97d75d9b1">GetNotifiedCallback</a> ()</td></tr>
110<tr class="separator:a9ee5b1dd7d3a6f619d2ed3d97d75d9b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
111</table>
112<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
113<div class="textblock">
114<p class="definition">Definition at line <a class="el" href="_async_execution_callback_8hpp_source.html#l00075">75</a> of file <a class="el" href="_async_execution_callback_8hpp_source.html">AsyncExecutionCallback.hpp</a>.</p>
115</div><h2 class="groupheader">Member Function Documentation</h2>
116<a id="a27aff9e4e5d9bce49988a2de6a1ebc59"></a>
117<h2 class="memtitle"><span class="permalink"><a href="#a27aff9e4e5d9bce49988a2de6a1ebc59">&#9670;&nbsp;</a></span>GetNewCallback()</h2>
118
119<div class="memitem">
120<div class="memproto">
121 <table class="memname">
122 <tr>
123 <td class="memname">std::shared_ptr&lt; <a class="el" href="classarmnn_1_1experimental_1_1_async_execution_callback.html">AsyncExecutionCallback</a> &gt; GetNewCallback </td>
124 <td>(</td>
125 <td class="paramname"></td><td>)</td>
126 <td></td>
127 </tr>
128 </table>
129</div><div class="memdoc">
130
131<p class="definition">Definition at line <a class="el" href="_async_execution_callback_8cpp_source.html#l00048">48</a> of file <a class="el" href="_async_execution_callback_8cpp_source.html">AsyncExecutionCallback.cpp</a>.</p>
132<div class="fragment"><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;{</div>
133<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">auto</span> cb = std::make_unique&lt;AsyncExecutionCallback&gt;(m_NotificationQueue</div>
134<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;#<span class="keywordflow">if</span> !defined(ARMNN_DISABLE_THREADS)</div>
135<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; , m_Mutex</div>
136<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; , m_Condition</div>
137<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;#endif</div>
138<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; );</div>
139<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="namespacearmnn_1_1experimental.html#aeeb110875a2be4ca0c3595aaad6397fc">InferenceId</a> <span class="keywordtype">id</span> = cb-&gt;GetInferenceId();</div>
140<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; m_Callbacks.insert({id, std::move(cb)});</div>
141<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
142<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordflow">return</span> m_Callbacks.at(<span class="keywordtype">id</span>);</div>
143<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;}</div>
144</div><!-- fragment -->
145</div>
146</div>
147<a id="a9ee5b1dd7d3a6f619d2ed3d97d75d9b1"></a>
148<h2 class="memtitle"><span class="permalink"><a href="#a9ee5b1dd7d3a6f619d2ed3d97d75d9b1">&#9670;&nbsp;</a></span>GetNotifiedCallback()</h2>
149
150<div class="memitem">
151<div class="memproto">
152 <table class="memname">
153 <tr>
154 <td class="memname">std::shared_ptr&lt; <a class="el" href="classarmnn_1_1experimental_1_1_async_execution_callback.html">AsyncExecutionCallback</a> &gt; GetNotifiedCallback </td>
155 <td>(</td>
156 <td class="paramname"></td><td>)</td>
157 <td></td>
158 </tr>
159 </table>
160</div><div class="memdoc">
161
162<p class="definition">Definition at line <a class="el" href="_async_execution_callback_8cpp_source.html#l00062">62</a> of file <a class="el" href="_async_execution_callback_8cpp_source.html">AsyncExecutionCallback.cpp</a>.</p>
163<div class="fragment"><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;{</div>
164<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="preprocessor">#if !defined(ARMNN_DISABLE_THREADS)</span></div>
165<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; std::unique_lock&lt;std::mutex&gt; lock(m_Mutex);</div>
166<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
167<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; m_Condition.wait(lock, [<span class="keyword">this</span>] { <span class="keywordflow">return</span> !m_NotificationQueue.empty(); });</div>
168<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor">#endif</span></div>
169<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="namespacearmnn_1_1experimental.html#aeeb110875a2be4ca0c3595aaad6397fc">InferenceId</a> <span class="keywordtype">id</span> = m_NotificationQueue.front();</div>
170<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; m_NotificationQueue.pop();</div>
171<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
172<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; std::shared_ptr&lt;AsyncExecutionCallback&gt; callback = m_Callbacks.at(<span class="keywordtype">id</span>);</div>
173<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; m_Callbacks.erase(<span class="keywordtype">id</span>);</div>
174<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">return</span> callback;</div>
175<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;}</div>
176</div><!-- fragment -->
177</div>
178</div>
179<hr/>The documentation for this class was generated from the following files:<ul>
180<li>src/armnn/<a class="el" href="_async_execution_callback_8hpp_source.html">AsyncExecutionCallback.hpp</a></li>
181<li>src/armnn/<a class="el" href="_async_execution_callback_8cpp_source.html">AsyncExecutionCallback.cpp</a></li>
182</ul>
183</div><!-- contents -->
184</div><!-- doc-content -->
185<div class="ttc" id="anamespacearmnn_1_1experimental_html_aeeb110875a2be4ca0c3595aaad6397fc"><div class="ttname"><a href="namespacearmnn_1_1experimental.html#aeeb110875a2be4ca0c3595aaad6397fc">armnn::experimental::InferenceId</a></div><div class="ttdeci">uint64_t InferenceId</div><div class="ttdef"><b>Definition:</b> <a href="_async_execution_callback_8hpp_source.html#l00024">AsyncExecutionCallback.hpp:24</a></div></div>
186<!-- start footer part -->
187<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
188 <ul>
189 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1experimental.html">experimental</a></li><li class="navelem"><a class="el" href="classarmnn_1_1experimental_1_1_async_callback_manager.html">AsyncCallbackManager</a></li>
190 <li class="footer">Generated on Thu May 16 2024 09:32:00 for Arm NN by
191 <a href="http://www.doxygen.org/index.html">
192 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
193 </ul>
194</div>
195</body>
196</html>