Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 753560b55dbf6656389b95efc8d4df07ac43cc9a / . / Documentation / classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml
blob: d213ce5888a1ea59ad63b138a21b3287d4170f59 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!-- Copyright (c) 2020 ARM Limited. -->
2<!-- -->
3<!-- SPDX-License-Identifier: MIT -->
4<!-- -->
5<!-- HTML header for doxygen 1.8.13-->
6<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml">
8<head>
9<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10<meta http-equiv="X-UA-Compatible" content="IE=9"/>
11<meta name="generator" content="Doxygen 1.8.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: IProfilingConnection Class Reference</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">20.02</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#pub-methods">Public Member Functions</a> &#124;
99<a href="classarmnn_1_1profiling_1_1_i_profiling_connection-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">IProfilingConnection Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><code>#include &lt;<a class="el" href="_i_profiling_connection_8hpp_source.xhtml">IProfilingConnection.hpp</a>&gt;</code></p>
106<div class="dynheader">
107Inheritance diagram for IProfilingConnection:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1profiling_1_1_i_profiling_connection.png" usemap="#IProfilingConnection_map" alt=""/>
111 <map id="IProfilingConnection_map" name="IProfilingConnection_map">
112<area href="classarmnn_1_1profiling_1_1_file_only_profiling_connection.xhtml" alt="FileOnlyProfilingConnection" shape="rect" coords="0,56,247,80"/>
113<area href="classarmnn_1_1profiling_1_1_mock_profiling_connection.xhtml" alt="MockProfilingConnection" shape="rect" coords="257,56,504,80"/>
114<area href="classarmnn_1_1profiling_1_1_profiling_connection_dump_to_file_decorator.xhtml" alt="ProfilingConnectionDumpToFileDecorator" shape="rect" coords="514,56,761,80"/>
115<area href="classarmnn_1_1profiling_1_1_socket_profiling_connection.xhtml" alt="SocketProfilingConnection" shape="rect" coords="771,56,1018,80"/>
116<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml" alt="TestProfilingConnectionBase" shape="rect" coords="1028,56,1275,80"/>
117<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_armnn_error.xhtml" alt="TestProfilingConnectionArmnnError" shape="rect" coords="771,112,1018,136"/>
118<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_bad_ack_packet.xhtml" alt="TestProfilingConnectionBadAckPacket" shape="rect" coords="1028,112,1275,136"/>
119<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_timeout_error.xhtml" alt="TestProfilingConnectionTimeoutError" shape="rect" coords="1285,112,1532,136"/>
120</map>
121 </div></div>
122<table class="memberdecls">
123<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
124Public Member Functions</h2></td></tr>
125<tr class="memitem:a8c5a75b8ee005a7aa9391f3991480d74"><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_profiling_connection.xhtml#a8c5a75b8ee005a7aa9391f3991480d74">~IProfilingConnection</a> ()</td></tr>
126<tr class="separator:a8c5a75b8ee005a7aa9391f3991480d74"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:a8a3511046982c64efa3e3833d749e5ef"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml#a8a3511046982c64efa3e3833d749e5ef">IsOpen</a> () const =0</td></tr>
128<tr class="separator:a8a3511046982c64efa3e3833d749e5ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
129<tr class="memitem:aacb6d0e5e6d570cdc2b0da14c3921ff0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml#aacb6d0e5e6d570cdc2b0da14c3921ff0">Close</a> ()=0</td></tr>
130<tr class="separator:aacb6d0e5e6d570cdc2b0da14c3921ff0"><td class="memSeparator" colspan="2">&#160;</td></tr>
131<tr class="memitem:ac78c6bd1a545934a805c88194214b09d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml#ac78c6bd1a545934a805c88194214b09d">WritePacket</a> (const unsigned char *buffer, uint32_t length)=0</td></tr>
132<tr class="separator:ac78c6bd1a545934a805c88194214b09d"><td class="memSeparator" colspan="2">&#160;</td></tr>
133<tr class="memitem:a935e16d85893a31f23cd78e47b85466d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarmnn_1_1profiling_1_1_packet.xhtml">Packet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml#a935e16d85893a31f23cd78e47b85466d">ReadPacket</a> (uint32_t timeout)=0</td></tr>
134<tr class="separator:a935e16d85893a31f23cd78e47b85466d"><td class="memSeparator" colspan="2">&#160;</td></tr>
135</table>
136<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
137<div class="textblock">
138<p class="definition">Definition at line <a class="el" href="_i_profiling_connection_8hpp_source.xhtml#l00018">18</a> of file <a class="el" href="_i_profiling_connection_8hpp_source.xhtml">IProfilingConnection.hpp</a>.</p>
139</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
140<a id="a8c5a75b8ee005a7aa9391f3991480d74"></a>
141<h2 class="memtitle"><span class="permalink"><a href="#a8c5a75b8ee005a7aa9391f3991480d74">&#9670;&nbsp;</a></span>~IProfilingConnection()</h2>
142
143<div class="memitem">
144<div class="memproto">
145<table class="mlabels">
146 <tr>
147 <td class="mlabels-left">
148 <table class="memname">
149 <tr>
150 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml">IProfilingConnection</a> </td>
151 <td>(</td>
152 <td class="paramname"></td><td>)</td>
153 <td></td>
154 </tr>
155 </table>
156 </td>
157 <td class="mlabels-right">
158<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
159 </tr>
160</table>
161</div><div class="memdoc">
162
163<p class="definition">Definition at line <a class="el" href="_i_profiling_connection_8hpp_source.xhtml#l00021">21</a> of file <a class="el" href="_i_profiling_connection_8hpp_source.xhtml">IProfilingConnection.hpp</a>.</p>
164
165<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml#aacb6d0e5e6d570cdc2b0da14c3921ff0">IProfilingConnection::Close()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml#a8a3511046982c64efa3e3833d749e5ef">IProfilingConnection::IsOpen()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml#a935e16d85893a31f23cd78e47b85466d">IProfilingConnection::ReadPacket()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml#ac78c6bd1a545934a805c88194214b09d">IProfilingConnection::WritePacket()</a>.</p>
166<div class="fragment"><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{}</div></div><!-- fragment -->
167</div>
168</div>
169<h2 class="groupheader">Member Function Documentation</h2>
170<a id="aacb6d0e5e6d570cdc2b0da14c3921ff0"></a>
171<h2 class="memtitle"><span class="permalink"><a href="#aacb6d0e5e6d570cdc2b0da14c3921ff0">&#9670;&nbsp;</a></span>Close()</h2>
172
173<div class="memitem">
174<div class="memproto">
175<table class="mlabels">
176 <tr>
177 <td class="mlabels-left">
178 <table class="memname">
179 <tr>
180 <td class="memname">virtual void Close </td>
181 <td>(</td>
182 <td class="paramname"></td><td>)</td>
183 <td></td>
184 </tr>
185 </table>
186 </td>
187 <td class="mlabels-right">
188<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
189 </tr>
190</table>
191</div><div class="memdoc">
192
193<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml#a0f9aecd570c4e5e6d41337f0e2f1adf5">TestProfilingConnectionBase</a>, <a class="el" href="classarmnn_1_1profiling_1_1_mock_profiling_connection.xhtml#a0f9aecd570c4e5e6d41337f0e2f1adf5">MockProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_file_only_profiling_connection.xhtml#a0f9aecd570c4e5e6d41337f0e2f1adf5">FileOnlyProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_dump_to_file_decorator.xhtml#a0f9aecd570c4e5e6d41337f0e2f1adf5">ProfilingConnectionDumpToFileDecorator</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_socket_profiling_connection.xhtml#a29dc6798f18d73abd4ba8e4910f6831f">SocketProfilingConnection</a>.</p>
194
195<p class="reference">Referenced by <a class="el" href="_i_profiling_connection_8hpp_source.xhtml#l00021">IProfilingConnection::~IProfilingConnection()</a>.</p>
196
197</div>
198</div>
199<a id="a8a3511046982c64efa3e3833d749e5ef"></a>
200<h2 class="memtitle"><span class="permalink"><a href="#a8a3511046982c64efa3e3833d749e5ef">&#9670;&nbsp;</a></span>IsOpen()</h2>
201
202<div class="memitem">
203<div class="memproto">
204<table class="mlabels">
205 <tr>
206 <td class="mlabels-left">
207 <table class="memname">
208 <tr>
209 <td class="memname">virtual bool IsOpen </td>
210 <td>(</td>
211 <td class="paramname"></td><td>)</td>
212 <td> const</td>
213 </tr>
214 </table>
215 </td>
216 <td class="mlabels-right">
217<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
218 </tr>
219</table>
220</div><div class="memdoc">
221
222<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml#a91bdc9d5497d47f5d707418beb83b140">TestProfilingConnectionBase</a>, <a class="el" href="classarmnn_1_1profiling_1_1_mock_profiling_connection.xhtml#a91bdc9d5497d47f5d707418beb83b140">MockProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_file_only_profiling_connection.xhtml#a91bdc9d5497d47f5d707418beb83b140">FileOnlyProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_dump_to_file_decorator.xhtml#a91bdc9d5497d47f5d707418beb83b140">ProfilingConnectionDumpToFileDecorator</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_socket_profiling_connection.xhtml#aaca9d54975c036540e7e5299a0c6df7a">SocketProfilingConnection</a>.</p>
223
224<p class="reference">Referenced by <a class="el" href="_send_thread_8cpp_source.xhtml#l00081">SendThread::Stop()</a>, <a class="el" href="_command_handler_8cpp_source.xhtml#l00034">CommandHandler::Stop()</a>, and <a class="el" href="_i_profiling_connection_8hpp_source.xhtml#l00021">IProfilingConnection::~IProfilingConnection()</a>.</p>
225
226</div>
227</div>
228<a id="a935e16d85893a31f23cd78e47b85466d"></a>
229<h2 class="memtitle"><span class="permalink"><a href="#a935e16d85893a31f23cd78e47b85466d">&#9670;&nbsp;</a></span>ReadPacket()</h2>
230
231<div class="memitem">
232<div class="memproto">
233<table class="mlabels">
234 <tr>
235 <td class="mlabels-left">
236 <table class="memname">
237 <tr>
238 <td class="memname">virtual <a class="el" href="classarmnn_1_1profiling_1_1_packet.xhtml">Packet</a> ReadPacket </td>
239 <td>(</td>
240 <td class="paramtype">uint32_t&#160;</td>
241 <td class="paramname"><em>timeout</em></td><td>)</td>
242 <td></td>
243 </tr>
244 </table>
245 </td>
246 <td class="mlabels-right">
247<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
248 </tr>
249</table>
250</div><div class="memdoc">
251
252<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_bad_ack_packet.xhtml#a1adbda8257d3a74a0566e0d8407ff458">TestProfilingConnectionBadAckPacket</a>, <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_armnn_error.xhtml#a1adbda8257d3a74a0566e0d8407ff458">TestProfilingConnectionArmnnError</a>, <a class="el" href="classarmnn_1_1profiling_1_1_mock_profiling_connection.xhtml#a1adbda8257d3a74a0566e0d8407ff458">MockProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_timeout_error.xhtml#a1adbda8257d3a74a0566e0d8407ff458">TestProfilingConnectionTimeoutError</a>, <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml#a1adbda8257d3a74a0566e0d8407ff458">TestProfilingConnectionBase</a>, <a class="el" href="classarmnn_1_1profiling_1_1_file_only_profiling_connection.xhtml#a1adbda8257d3a74a0566e0d8407ff458">FileOnlyProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_dump_to_file_decorator.xhtml#a1adbda8257d3a74a0566e0d8407ff458">ProfilingConnectionDumpToFileDecorator</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_socket_profiling_connection.xhtml#a15c46007b7627c887593d267023fbfa4">SocketProfilingConnection</a>.</p>
253
254<p class="reference">Referenced by <a class="el" href="_command_handler_8cpp_source.xhtml#l00034">CommandHandler::Stop()</a>, and <a class="el" href="_i_profiling_connection_8hpp_source.xhtml#l00021">IProfilingConnection::~IProfilingConnection()</a>.</p>
255
256</div>
257</div>
258<a id="ac78c6bd1a545934a805c88194214b09d"></a>
259<h2 class="memtitle"><span class="permalink"><a href="#ac78c6bd1a545934a805c88194214b09d">&#9670;&nbsp;</a></span>WritePacket()</h2>
260
261<div class="memitem">
262<div class="memproto">
263<table class="mlabels">
264 <tr>
265 <td class="mlabels-left">
266 <table class="memname">
267 <tr>
268 <td class="memname">virtual bool WritePacket </td>
269 <td>(</td>
270 <td class="paramtype">const unsigned char *&#160;</td>
271 <td class="paramname"><em>buffer</em>, </td>
272 </tr>
273 <tr>
274 <td class="paramkey"></td>
275 <td></td>
276 <td class="paramtype">uint32_t&#160;</td>
277 <td class="paramname"><em>length</em>&#160;</td>
278 </tr>
279 <tr>
280 <td></td>
281 <td>)</td>
282 <td></td><td></td>
283 </tr>
284 </table>
285 </td>
286 <td class="mlabels-right">
287<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
288 </tr>
289</table>
290</div><div class="memdoc">
291
292<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml#a42eb542b5a1d73d00c4ce474140bb78c">TestProfilingConnectionBase</a>, <a class="el" href="classarmnn_1_1profiling_1_1_mock_profiling_connection.xhtml#a42eb542b5a1d73d00c4ce474140bb78c">MockProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_file_only_profiling_connection.xhtml#a42eb542b5a1d73d00c4ce474140bb78c">FileOnlyProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_dump_to_file_decorator.xhtml#a42eb542b5a1d73d00c4ce474140bb78c">ProfilingConnectionDumpToFileDecorator</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_socket_profiling_connection.xhtml#a096549d574d3fc51e6948efd24988f3e">SocketProfilingConnection</a>.</p>
293
294<p class="reference">Referenced by <a class="el" href="_send_thread_8cpp_source.xhtml#l00081">SendThread::Stop()</a>, and <a class="el" href="_i_profiling_connection_8hpp_source.xhtml#l00021">IProfilingConnection::~IProfilingConnection()</a>.</p>
295
296</div>
297</div>
298<hr/>The documentation for this class was generated from the following file:<ul>
299<li>src/profiling/<a class="el" href="_i_profiling_connection_8hpp_source.xhtml">IProfilingConnection.hpp</a></li>
300</ul>
301</div><!-- contents -->
302</div><!-- doc-content -->
303<!-- start footer part -->
304<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
305 <ul>
306 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1profiling.xhtml">profiling</a></li><li class="navelem"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml">IProfilingConnection</a></li>
307 <li class="footer">Generated on Fri Mar 13 2020 16:09:21 for ArmNN by
308 <a href="http://www.doxygen.org/index.html">
309 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
310 </ul>
311</div>
312</body>
313</html>