blob: 8bf545e3deda236906a895bc613c4b580de41f05 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>ArmNN: BufferManager Class Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<link href="doxygen.css" rel="stylesheet" type="text/css" />
23</head>
24<body>
25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26<div id="titlearea">
27<table cellspacing="0" cellpadding="0">
28 <tbody>
29 <tr style="height: 56px;">
30 <td id="projectalign" style="padding-left: 0.5em;">
31 <div id="projectname">ArmNN
32 &#160;<span id="projectnumber">NotReleased</span>
33 </div>
34 </td>
35 </tr>
36 </tbody>
37</table>
38</div>
39<!-- end header part -->
40<!-- Generated by Doxygen 1.8.13 -->
41<script type="text/javascript">
42var searchBox = new SearchBox("searchBox", "search",false,'Search');
43</script>
44<script type="text/javascript" src="menudata.js"></script>
45<script type="text/javascript" src="menu.js"></script>
46<script type="text/javascript">
47$(function() {
48 initMenu('',true,false,'search.php','Search');
49 $(document).ready(function() { init_search(); });
50});
51</script>
52<div id="main-nav"></div>
53</div><!-- top -->
54<div id="side-nav" class="ui-resizable side-nav-resizable">
55 <div id="nav-tree">
56 <div id="nav-tree-contents">
57 <div id="nav-sync" class="sync"></div>
58 </div>
59 </div>
60 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle">
62 </div>
63</div>
64<script type="text/javascript">
65$(document).ready(function(){initNavTree('classarmnn_1_1profiling_1_1_buffer_manager.html','');});
66</script>
67<div id="doc-content">
68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73</div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
80</div>
81
82<div class="header">
83 <div class="summary">
84<a href="#pub-methods">Public Member Functions</a> &#124;
85<a href="classarmnn_1_1profiling_1_1_buffer_manager-members.html">List of all members</a> </div>
86 <div class="headertitle">
87<div class="title">BufferManager Class Reference</div> </div>
88</div><!--header-->
89<div class="contents">
90
91<p><code>#include &lt;<a class="el" href="_buffer_manager_8hpp_source.html">BufferManager.hpp</a>&gt;</code></p>
92<div class="dynheader">
93Inheritance diagram for BufferManager:</div>
94<div class="dyncontent">
95 <div class="center">
96 <img src="classarmnn_1_1profiling_1_1_buffer_manager.png" usemap="#BufferManager_map" alt=""/>
97 <map id="BufferManager_map" name="BufferManager_map">
98<area href="classarmnn_1_1profiling_1_1_i_buffer_manager.html" alt="IBufferManager" shape="rect" coords="0,0,101,24"/>
99</map>
100 </div></div>
101<table class="memberdecls">
102<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
103Public Member Functions</h2></td></tr>
104<tr class="memitem:a0aee89a45e5c21933b2f16b46bec25e3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html#a0aee89a45e5c21933b2f16b46bec25e3">BufferManager</a> (unsigned int numberOfBuffers=5, unsigned int maxPacketSize=4096)</td></tr>
105<tr class="separator:a0aee89a45e5c21933b2f16b46bec25e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
106<tr class="memitem:a8224229b6953f986d6fb2d4d00fe6ee2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html#a8224229b6953f986d6fb2d4d00fe6ee2">~BufferManager</a> ()</td></tr>
107<tr class="separator:a8224229b6953f986d6fb2d4d00fe6ee2"><td class="memSeparator" colspan="2">&#160;</td></tr>
108<tr class="memitem:ac3f43b4dd3fafd6b13342acc2263bbb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html#ac3f43b4dd3fafd6b13342acc2263bbb4">Reserve</a> (unsigned int requestedSize, unsigned int &amp;reservedSize) override</td></tr>
109<tr class="separator:ac3f43b4dd3fafd6b13342acc2263bbb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<tr class="memitem:a372de693ad40b3f42839c8ec6ac845f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html#a372de693ad40b3f42839c8ec6ac845f4">Reset</a> ()</td></tr>
111<tr class="separator:a372de693ad40b3f42839c8ec6ac845f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
112<tr class="memitem:a183eaa37ccd326bd82179bed901c7122"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html#a183eaa37ccd326bd82179bed901c7122">Commit</a> (<a class="el" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> &amp;packetBuffer, unsigned int size, bool notifyConsumer=<a class="el" href="_ref_layer_tests_8cpp.html#a37f1c3ccc9fc906be85185350dd83d48">true</a>) override</td></tr>
113<tr class="separator:a183eaa37ccd326bd82179bed901c7122"><td class="memSeparator" colspan="2">&#160;</td></tr>
114<tr class="memitem:a226108649851aa1b1a8168560c5228b5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html#a226108649851aa1b1a8168560c5228b5">Release</a> (<a class="el" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> &amp;packetBuffer) override</td></tr>
115<tr class="separator:a226108649851aa1b1a8168560c5228b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
116<tr class="memitem:abce8709dc1b666a26f427ba7ff08b737"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html#abce8709dc1b666a26f427ba7ff08b737">GetReadableBuffer</a> () override</td></tr>
117<tr class="separator:abce8709dc1b666a26f427ba7ff08b737"><td class="memSeparator" colspan="2">&#160;</td></tr>
118<tr class="memitem:ae717263b3243e9f88f4caea6d31b0652"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html#ae717263b3243e9f88f4caea6d31b0652">MarkRead</a> (<a class="el" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> &amp;packetBuffer) override</td></tr>
119<tr class="separator:ae717263b3243e9f88f4caea6d31b0652"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:ad675ff4e9053375bd41d0aad6b3bbb63"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html#ad675ff4e9053375bd41d0aad6b3bbb63">SetConsumer</a> (<a class="el" href="classarmnn_1_1profiling_1_1_i_consumer.html">IConsumer</a> *consumer) override</td></tr>
121<tr class="separator:ad675ff4e9053375bd41d0aad6b3bbb63"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:af22fdc7450c285c4d7449425c8fe994f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html#af22fdc7450c285c4d7449425c8fe994f">FlushReadList</a> () override</td></tr>
123<tr class="memdesc:af22fdc7450c285c4d7449425c8fe994f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notify the Consumer buffer can be read. <a href="#af22fdc7450c285c4d7449425c8fe994f">More...</a><br /></td></tr>
124<tr class="separator:af22fdc7450c285c4d7449425c8fe994f"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<tr class="inherit_header pub_methods_classarmnn_1_1profiling_1_1_i_buffer_manager"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1profiling_1_1_i_buffer_manager')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.html">IBufferManager</a></td></tr>
126<tr class="memitem:a18c16b4ff70efb2663a4c4c1144babee inherit pub_methods_classarmnn_1_1profiling_1_1_i_buffer_manager"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.html#a18c16b4ff70efb2663a4c4c1144babee">~IBufferManager</a> ()</td></tr>
127<tr class="separator:a18c16b4ff70efb2663a4c4c1144babee inherit pub_methods_classarmnn_1_1profiling_1_1_i_buffer_manager"><td class="memSeparator" colspan="2">&#160;</td></tr>
128</table>
129<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
130<div class="textblock">
131<p class="definition">Definition at line <a class="el" href="_buffer_manager_8hpp_source.html#l00021">21</a> of file <a class="el" href="_buffer_manager_8hpp_source.html">BufferManager.hpp</a>.</p>
132</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
133<a id="a0aee89a45e5c21933b2f16b46bec25e3"></a>
134<h2 class="memtitle"><span class="permalink"><a href="#a0aee89a45e5c21933b2f16b46bec25e3">&#9670;&nbsp;</a></span>BufferManager()</h2>
135
136<div class="memitem">
137<div class="memproto">
138 <table class="memname">
139 <tr>
140 <td class="memname"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html">BufferManager</a> </td>
141 <td>(</td>
142 <td class="paramtype">unsigned int&#160;</td>
143 <td class="paramname"><em>numberOfBuffers</em> = <code>5</code>, </td>
144 </tr>
145 <tr>
146 <td class="paramkey"></td>
147 <td></td>
148 <td class="paramtype">unsigned int&#160;</td>
149 <td class="paramname"><em>maxPacketSize</em> = <code>4096</code>&#160;</td>
150 </tr>
151 <tr>
152 <td></td>
153 <td>)</td>
154 <td></td><td></td>
155 </tr>
156 </table>
157</div><div class="memdoc">
158
159<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.html#l00015">15</a> of file <a class="el" href="_buffer_manager_8cpp_source.html">BufferManager.cpp</a>.</p>
160<div class="fragment"><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; : m_MaxBufferSize(maxPacketSize),</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; m_NumberOfBuffers(numberOfBuffers)</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;{</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <a class="code" href="namespacearmnn_utils_1_1_sockets.html#a248c764067ee60c03ee370784c49f353">Initialize</a>();</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;}</div><div class="ttc" id="namespacearmnn_utils_1_1_sockets_html_a248c764067ee60c03ee370784c49f353"><div class="ttname"><a href="namespacearmnn_utils_1_1_sockets.html#a248c764067ee60c03ee370784c49f353">armnnUtils::Sockets::Initialize</a></div><div class="ttdeci">bool Initialize()</div><div class="ttdoc">Performs any required one-time setup. </div><div class="ttdef"><b>Definition:</b> <a href="_network_sockets_8cpp_source.html#l00018">NetworkSockets.cpp:18</a></div></div>
161</div><!-- fragment -->
162</div>
163</div>
164<a id="a8224229b6953f986d6fb2d4d00fe6ee2"></a>
165<h2 class="memtitle"><span class="permalink"><a href="#a8224229b6953f986d6fb2d4d00fe6ee2">&#9670;&nbsp;</a></span>~BufferManager()</h2>
166
167<div class="memitem">
168<div class="memproto">
169<table class="mlabels">
170 <tr>
171 <td class="mlabels-left">
172 <table class="memname">
173 <tr>
174 <td class="memname">~<a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html">BufferManager</a> </td>
175 <td>(</td>
176 <td class="paramname"></td><td>)</td>
177 <td></td>
178 </tr>
179 </table>
180 </td>
181 <td class="mlabels-right">
182<span class="mlabels"><span class="mlabel">inline</span></span> </td>
183 </tr>
184</table>
185</div><div class="memdoc">
186
187<p class="definition">Definition at line <a class="el" href="_buffer_manager_8hpp_source.html#l00026">26</a> of file <a class="el" href="_buffer_manager_8hpp_source.html">BufferManager.hpp</a>.</p>
188
189<p class="reference">References <a class="el" href="_buffer_manager_8cpp_source.html#l00043">BufferManager::Commit()</a>, <a class="el" href="_buffer_manager_8cpp_source.html#l00116">BufferManager::FlushReadList()</a>, <a class="el" href="_buffer_manager_8cpp_source.html#l00089">BufferManager::GetReadableBuffer()</a>, <a class="el" href="_buffer_manager_8cpp_source.html#l00102">BufferManager::MarkRead()</a>, <a class="el" href="_buffer_manager_8cpp_source.html#l00068">BufferManager::Release()</a>, <a class="el" href="_buffer_manager_8cpp_source.html#l00022">BufferManager::Reserve()</a>, <a class="el" href="_buffer_manager_8cpp_source.html#l00077">BufferManager::Reset()</a>, and <a class="el" href="_buffer_manager_8cpp_source.html#l00111">BufferManager::SetConsumer()</a>.</p>
190<div class="fragment"><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{}</div></div><!-- fragment -->
191</div>
192</div>
193<h2 class="groupheader">Member Function Documentation</h2>
194<a id="a183eaa37ccd326bd82179bed901c7122"></a>
195<h2 class="memtitle"><span class="permalink"><a href="#a183eaa37ccd326bd82179bed901c7122">&#9670;&nbsp;</a></span>Commit()</h2>
196
197<div class="memitem">
198<div class="memproto">
199<table class="mlabels">
200 <tr>
201 <td class="mlabels-left">
202 <table class="memname">
203 <tr>
204 <td class="memname">void Commit </td>
205 <td>(</td>
206 <td class="paramtype"><a class="el" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> &amp;&#160;</td>
207 <td class="paramname"><em>packetBuffer</em>, </td>
208 </tr>
209 <tr>
210 <td class="paramkey"></td>
211 <td></td>
212 <td class="paramtype">unsigned int&#160;</td>
213 <td class="paramname"><em>size</em>, </td>
214 </tr>
215 <tr>
216 <td class="paramkey"></td>
217 <td></td>
218 <td class="paramtype">bool&#160;</td>
219 <td class="paramname"><em>notifyConsumer</em> = <code><a class="el" href="_ref_layer_tests_8cpp.html#a37f1c3ccc9fc906be85185350dd83d48">true</a></code>&#160;</td>
220 </tr>
221 <tr>
222 <td></td>
223 <td>)</td>
224 <td></td><td></td>
225 </tr>
226 </table>
227 </td>
228 <td class="mlabels-right">
229<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
230 </tr>
231</table>
232</div><div class="memdoc">
233
234<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.html#ad0faa8a317506b2e72252f087c7f3c46">IBufferManager</a>.</p>
235
236<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.html#l00043">43</a> of file <a class="el" href="_buffer_manager_8cpp_source.html">BufferManager.cpp</a>.</p>
237
238<p class="reference">References <a class="el" href="_buffer_manager_8cpp_source.html#l00116">BufferManager::FlushReadList()</a>.</p>
239
240<p class="reference">Referenced by <a class="el" href="_buffer_tests_8cpp_source.html#l00217">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_buffer_manager_8hpp_source.html#l00026">BufferManager::~BufferManager()</a>.</p>
241<div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;{</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; std::unique_lock&lt;std::mutex&gt; readableListLock(m_ReadableMutex, std::defer_lock);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; packetBuffer-&gt;Commit(size);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; readableListLock.lock();</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; m_ReadableList.push_back(std::move(packetBuffer));</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; readableListLock.unlock();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">if</span> (notifyConsumer)</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.html#af22fdc7450c285c4d7449425c8fe994f">FlushReadList</a>();</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;}</div><div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_html_af22fdc7450c285c4d7449425c8fe994f"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.html#af22fdc7450c285c4d7449425c8fe994f">armnn::profiling::BufferManager::FlushReadList</a></div><div class="ttdeci">void FlushReadList() override</div><div class="ttdoc">Notify the Consumer buffer can be read. </div><div class="ttdef"><b>Definition:</b> <a href="_buffer_manager_8cpp_source.html#l00116">BufferManager.cpp:116</a></div></div>
242</div><!-- fragment -->
243</div>
244</div>
245<a id="af22fdc7450c285c4d7449425c8fe994f"></a>
246<h2 class="memtitle"><span class="permalink"><a href="#af22fdc7450c285c4d7449425c8fe994f">&#9670;&nbsp;</a></span>FlushReadList()</h2>
247
248<div class="memitem">
249<div class="memproto">
250<table class="mlabels">
251 <tr>
252 <td class="mlabels-left">
253 <table class="memname">
254 <tr>
255 <td class="memname">void FlushReadList </td>
256 <td>(</td>
257 <td class="paramname"></td><td>)</td>
258 <td></td>
259 </tr>
260 </table>
261 </td>
262 <td class="mlabels-right">
263<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
264 </tr>
265</table>
266</div><div class="memdoc">
267
268<p>Notify the Consumer buffer can be read. </p>
269
270<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.html#abb12c72b032fda64ab5a596f5e49fc56">IBufferManager</a>.</p>
271
272<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.html#l00116">116</a> of file <a class="el" href="_buffer_manager_8cpp_source.html">BufferManager.cpp</a>.</p>
273
274<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_consumer.html#a4b4fe1cfea0198d9defd88178f073365">IConsumer::SetReadyToRead()</a>.</p>
275
276<p class="reference">Referenced by <a class="el" href="_buffer_manager_8cpp_source.html#l00043">BufferManager::Commit()</a>, and <a class="el" href="_buffer_manager_8hpp_source.html#l00026">BufferManager::~BufferManager()</a>.</p>
277<div class="fragment"><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;{</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="comment">// notify consumer that packet is ready to read</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordflow">if</span> (m_Consumer != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; {</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; m_Consumer-&gt;<a class="code" href="classarmnn_1_1profiling_1_1_i_consumer.html#a4b4fe1cfea0198d9defd88178f073365">SetReadyToRead</a>();</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; }</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;}</div><div class="ttc" id="classarmnn_1_1profiling_1_1_i_consumer_html_a4b4fe1cfea0198d9defd88178f073365"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_consumer.html#a4b4fe1cfea0198d9defd88178f073365">armnn::profiling::IConsumer::SetReadyToRead</a></div><div class="ttdeci">virtual void SetReadyToRead()=0</div><div class="ttdoc">Set a &quot;ready to read&quot; flag in the buffer to notify the reading thread to start reading it...</div></div>
278</div><!-- fragment -->
279</div>
280</div>
281<a id="abce8709dc1b666a26f427ba7ff08b737"></a>
282<h2 class="memtitle"><span class="permalink"><a href="#abce8709dc1b666a26f427ba7ff08b737">&#9670;&nbsp;</a></span>GetReadableBuffer()</h2>
283
284<div class="memitem">
285<div class="memproto">
286<table class="mlabels">
287 <tr>
288 <td class="mlabels-left">
289 <table class="memname">
290 <tr>
291 <td class="memname"><a class="el" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> GetReadableBuffer </td>
292 <td>(</td>
293 <td class="paramname"></td><td>)</td>
294 <td></td>
295 </tr>
296 </table>
297 </td>
298 <td class="mlabels-right">
299<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
300 </tr>
301</table>
302</div><div class="memdoc">
303
304<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.html#acc2e97eddda6324261ba202634cc8ef8">IBufferManager</a>.</p>
305
306<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.html#l00089">89</a> of file <a class="el" href="_buffer_manager_8cpp_source.html">BufferManager.cpp</a>.</p>
307
308<p class="reference">Referenced by <a class="el" href="_runtime_tests_8cpp_source.html#l00340">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_profiling_test_utils_8cpp_source.html#l00355">VerifyPostOptimisationStructureTestImpl()</a>, and <a class="el" href="_buffer_manager_8hpp_source.html#l00026">BufferManager::~BufferManager()</a>.</p>
309<div class="fragment"><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;{</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; std::unique_lock&lt;std::mutex&gt; readableListLock(m_ReadableMutex);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">if</span> (!m_ReadableList.empty())</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <a class="code" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> buffer = std::move(m_ReadableList.back());</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; m_ReadableList.pop_back();</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; readableListLock.unlock();</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">return</span> buffer;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; }</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;}</div><div class="ttc" id="namespacearmnn_1_1profiling_html_a14328d977cec3abadcfd5935f04f3409"><div class="ttname"><a href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">armnn::profiling::IPacketBufferPtr</a></div><div class="ttdeci">std::unique_ptr&lt; IPacketBuffer &gt; IPacketBufferPtr</div><div class="ttdef"><b>Definition:</b> <a href="_i_packet_buffer_8hpp_source.html#l00040">IPacketBuffer.hpp:40</a></div></div>
310</div><!-- fragment -->
311</div>
312</div>
313<a id="ae717263b3243e9f88f4caea6d31b0652"></a>
314<h2 class="memtitle"><span class="permalink"><a href="#ae717263b3243e9f88f4caea6d31b0652">&#9670;&nbsp;</a></span>MarkRead()</h2>
315
316<div class="memitem">
317<div class="memproto">
318<table class="mlabels">
319 <tr>
320 <td class="mlabels-left">
321 <table class="memname">
322 <tr>
323 <td class="memname">void MarkRead </td>
324 <td>(</td>
325 <td class="paramtype"><a class="el" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> &amp;&#160;</td>
326 <td class="paramname"><em>packetBuffer</em></td><td>)</td>
327 <td></td>
328 </tr>
329 </table>
330 </td>
331 <td class="mlabels-right">
332<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
333 </tr>
334</table>
335</div><div class="memdoc">
336
337<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.html#a033cae4e6d00fc1958f79f09216a3437">IBufferManager</a>.</p>
338
339<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.html#l00102">102</a> of file <a class="el" href="_buffer_manager_8cpp_source.html">BufferManager.cpp</a>.</p>
340
341<p class="reference">Referenced by <a class="el" href="_runtime_tests_8cpp_source.html#l00381">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_profiling_test_utils_8cpp_source.html#l00355">VerifyPostOptimisationStructureTestImpl()</a>, and <a class="el" href="_buffer_manager_8hpp_source.html#l00026">BufferManager::~BufferManager()</a>.</p>
342<div class="fragment"><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;{</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; std::unique_lock&lt;std::mutex&gt; availableListLock(m_AvailableMutex, std::defer_lock);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; packetBuffer-&gt;MarkRead();</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; availableListLock.lock();</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; m_AvailableList.push_back(std::move(packetBuffer));</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; availableListLock.unlock();</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;}</div></div><!-- fragment -->
343</div>
344</div>
345<a id="a226108649851aa1b1a8168560c5228b5"></a>
346<h2 class="memtitle"><span class="permalink"><a href="#a226108649851aa1b1a8168560c5228b5">&#9670;&nbsp;</a></span>Release()</h2>
347
348<div class="memitem">
349<div class="memproto">
350<table class="mlabels">
351 <tr>
352 <td class="mlabels-left">
353 <table class="memname">
354 <tr>
355 <td class="memname">void Release </td>
356 <td>(</td>
357 <td class="paramtype"><a class="el" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> &amp;&#160;</td>
358 <td class="paramname"><em>packetBuffer</em></td><td>)</td>
359 <td></td>
360 </tr>
361 </table>
362 </td>
363 <td class="mlabels-right">
364<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
365 </tr>
366</table>
367</div><div class="memdoc">
368
369<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.html#a3712fbb9506d016ac2ed7d56b8788a16">IBufferManager</a>.</p>
370
371<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.html#l00068">68</a> of file <a class="el" href="_buffer_manager_8cpp_source.html">BufferManager.cpp</a>.</p>
372
373<p class="reference">Referenced by <a class="el" href="_buffer_tests_8cpp_source.html#l00185">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_buffer_manager_8hpp_source.html#l00026">BufferManager::~BufferManager()</a>.</p>
374<div class="fragment"><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;{</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; std::unique_lock&lt;std::mutex&gt; availableListLock(m_AvailableMutex, std::defer_lock);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; packetBuffer-&gt;Release();</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; availableListLock.lock();</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; m_AvailableList.push_back(std::move(packetBuffer));</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; availableListLock.unlock();</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;}</div></div><!-- fragment -->
375</div>
376</div>
377<a id="ac3f43b4dd3fafd6b13342acc2263bbb4"></a>
378<h2 class="memtitle"><span class="permalink"><a href="#ac3f43b4dd3fafd6b13342acc2263bbb4">&#9670;&nbsp;</a></span>Reserve()</h2>
379
380<div class="memitem">
381<div class="memproto">
382<table class="mlabels">
383 <tr>
384 <td class="mlabels-left">
385 <table class="memname">
386 <tr>
387 <td class="memname"><a class="el" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> Reserve </td>
388 <td>(</td>
389 <td class="paramtype">unsigned int&#160;</td>
390 <td class="paramname"><em>requestedSize</em>, </td>
391 </tr>
392 <tr>
393 <td class="paramkey"></td>
394 <td></td>
395 <td class="paramtype">unsigned int &amp;&#160;</td>
396 <td class="paramname"><em>reservedSize</em>&#160;</td>
397 </tr>
398 <tr>
399 <td></td>
400 <td>)</td>
401 <td></td><td></td>
402 </tr>
403 </table>
404 </td>
405 <td class="mlabels-right">
406<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
407 </tr>
408</table>
409</div><div class="memdoc">
410
411<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.html#a49c88b0e052621f30462c3bdbf3e4a7a">IBufferManager</a>.</p>
412
413<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.html#l00022">22</a> of file <a class="el" href="_buffer_manager_8cpp_source.html">BufferManager.cpp</a>.</p>
414
415<p class="reference">Referenced by <a class="el" href="_buffer_tests_8cpp_source.html#l00116">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_buffer_manager_8hpp_source.html#l00026">BufferManager::~BufferManager()</a>.</p>
416<div class="fragment"><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; reservedSize = 0;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; std::unique_lock&lt;std::mutex&gt; availableListLock(m_AvailableMutex, std::defer_lock);</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">if</span> (requestedSize &gt; m_MaxBufferSize)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; }</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; availableListLock.lock();</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">if</span> (m_AvailableList.empty())</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; availableListLock.unlock();</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; }</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> buffer = std::move(m_AvailableList.back());</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; m_AvailableList.pop_back();</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; availableListLock.unlock();</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; reservedSize = requestedSize;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> buffer;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;}</div><div class="ttc" id="namespacearmnn_1_1profiling_html_a14328d977cec3abadcfd5935f04f3409"><div class="ttname"><a href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">armnn::profiling::IPacketBufferPtr</a></div><div class="ttdeci">std::unique_ptr&lt; IPacketBuffer &gt; IPacketBufferPtr</div><div class="ttdef"><b>Definition:</b> <a href="_i_packet_buffer_8hpp_source.html#l00040">IPacketBuffer.hpp:40</a></div></div>
417</div><!-- fragment -->
418</div>
419</div>
420<a id="a372de693ad40b3f42839c8ec6ac845f4"></a>
421<h2 class="memtitle"><span class="permalink"><a href="#a372de693ad40b3f42839c8ec6ac845f4">&#9670;&nbsp;</a></span>Reset()</h2>
422
423<div class="memitem">
424<div class="memproto">
425 <table class="memname">
426 <tr>
427 <td class="memname">void Reset </td>
428 <td>(</td>
429 <td class="paramname"></td><td>)</td>
430 <td></td>
431 </tr>
432 </table>
433</div><div class="memdoc">
434
435<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.html#l00077">77</a> of file <a class="el" href="_buffer_manager_8cpp_source.html">BufferManager.cpp</a>.</p>
436
437<p class="reference">Referenced by <a class="el" href="_profiling_service_8cpp_source.html#l00290">ProfilingService::GetSendTimelinePacket()</a>, and <a class="el" href="_buffer_manager_8hpp_source.html#l00026">BufferManager::~BufferManager()</a>.</p>
438<div class="fragment"><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;{</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="comment">//This method should only be called once all threads have been joined</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; std::lock_guard&lt;std::mutex&gt; readableListLock(m_ReadableMutex);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; std::lock_guard&lt;std::mutex&gt; availableListLock(m_AvailableMutex);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; m_AvailableList.clear();</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; m_ReadableList.clear();</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <a class="code" href="namespacearmnn_utils_1_1_sockets.html#a248c764067ee60c03ee370784c49f353">Initialize</a>();</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;}</div><div class="ttc" id="namespacearmnn_utils_1_1_sockets_html_a248c764067ee60c03ee370784c49f353"><div class="ttname"><a href="namespacearmnn_utils_1_1_sockets.html#a248c764067ee60c03ee370784c49f353">armnnUtils::Sockets::Initialize</a></div><div class="ttdeci">bool Initialize()</div><div class="ttdoc">Performs any required one-time setup. </div><div class="ttdef"><b>Definition:</b> <a href="_network_sockets_8cpp_source.html#l00018">NetworkSockets.cpp:18</a></div></div>
439</div><!-- fragment -->
440</div>
441</div>
442<a id="ad675ff4e9053375bd41d0aad6b3bbb63"></a>
443<h2 class="memtitle"><span class="permalink"><a href="#ad675ff4e9053375bd41d0aad6b3bbb63">&#9670;&nbsp;</a></span>SetConsumer()</h2>
444
445<div class="memitem">
446<div class="memproto">
447<table class="mlabels">
448 <tr>
449 <td class="mlabels-left">
450 <table class="memname">
451 <tr>
452 <td class="memname">void SetConsumer </td>
453 <td>(</td>
454 <td class="paramtype"><a class="el" href="classarmnn_1_1profiling_1_1_i_consumer.html">IConsumer</a> *&#160;</td>
455 <td class="paramname"><em>consumer</em></td><td>)</td>
456 <td></td>
457 </tr>
458 </table>
459 </td>
460 <td class="mlabels-right">
461<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
462 </tr>
463</table>
464</div><div class="memdoc">
465<p>Set Consumer on the buffer manager to be notified when there is a Commit Can only be one consumer </p>
466
467<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.html#a2d5f60e55b59ae8667ff593b5bfc5deb">IBufferManager</a>.</p>
468
469<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.html#l00111">111</a> of file <a class="el" href="_buffer_manager_8cpp_source.html">BufferManager.cpp</a>.</p>
470
471<p class="reference">Referenced by <a class="el" href="_buffer_manager_8hpp_source.html#l00026">BufferManager::~BufferManager()</a>.</p>
472<div class="fragment"><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;{</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; m_Consumer = consumer;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;}</div></div><!-- fragment -->
473</div>
474</div>
475<hr/>The documentation for this class was generated from the following files:<ul>
476<li>src/profiling/<a class="el" href="_buffer_manager_8hpp_source.html">BufferManager.hpp</a></li>
477<li>src/profiling/<a class="el" href="_buffer_manager_8cpp_source.html">BufferManager.cpp</a></li>
478</ul>
479</div><!-- contents -->
480</div><!-- doc-content -->
481<!-- start footer part -->
482<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
483 <ul>
484 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1profiling.html">profiling</a></li><li class="navelem"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.html">BufferManager</a></li>
485 <li class="footer">Generated on Fri Mar 13 2020 16:07:05 for ArmNN by
486 <a href="http://www.doxygen.org/index.html">
487 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
488 </ul>
489</div>
490</body>
491</html>