Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / e09fc820968ee4de20df60e371088582a710bad0 / . / Documentation / classarmnn_1_1profiling_1_1_i_profiling_connection.html
blob: 879f402da1df87454393b606ba1a890650123e3c [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!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: IProfilingConnection 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_i_profiling_connection.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_i_profiling_connection-members.html">List of all members</a> </div>
86 <div class="headertitle">
87<div class="title">IProfilingConnection Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
88</div><!--header-->
89<div class="contents">
90
91<p><code>#include &lt;<a class="el" href="_i_profiling_connection_8hpp_source.html">IProfilingConnection.hpp</a>&gt;</code></p>
92<div class="dynheader">
93Inheritance diagram for IProfilingConnection:</div>
94<div class="dyncontent">
95 <div class="center">
96 <img src="classarmnn_1_1profiling_1_1_i_profiling_connection.png" usemap="#IProfilingConnection_map" alt=""/>
97 <map id="IProfilingConnection_map" name="IProfilingConnection_map">
98<area href="classarmnn_1_1profiling_1_1_file_only_profiling_connection.html" alt="FileOnlyProfilingConnection" shape="rect" coords="0,56,247,80"/>
99<area href="classarmnn_1_1profiling_1_1_mock_profiling_connection.html" alt="MockProfilingConnection" shape="rect" coords="257,56,504,80"/>
100<area href="classarmnn_1_1profiling_1_1_profiling_connection_dump_to_file_decorator.html" alt="ProfilingConnectionDumpToFileDecorator" shape="rect" coords="514,56,761,80"/>
101<area href="classarmnn_1_1profiling_1_1_socket_profiling_connection.html" alt="SocketProfilingConnection" shape="rect" coords="771,56,1018,80"/>
102<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.html" alt="TestProfilingConnectionBase" shape="rect" coords="1028,56,1275,80"/>
103<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_armnn_error.html" alt="TestProfilingConnectionArmnnError" shape="rect" coords="771,112,1018,136"/>
104<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_bad_ack_packet.html" alt="TestProfilingConnectionBadAckPacket" shape="rect" coords="1028,112,1275,136"/>
105<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_timeout_error.html" alt="TestProfilingConnectionTimeoutError" shape="rect" coords="1285,112,1532,136"/>
106</map>
107 </div></div>
108<table class="memberdecls">
109<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
110Public Member Functions</h2></td></tr>
111<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.html#a8c5a75b8ee005a7aa9391f3991480d74">~IProfilingConnection</a> ()</td></tr>
112<tr class="separator:a8c5a75b8ee005a7aa9391f3991480d74"><td class="memSeparator" colspan="2">&#160;</td></tr>
113<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.html#a8a3511046982c64efa3e3833d749e5ef">IsOpen</a> () const =0</td></tr>
114<tr class="separator:a8a3511046982c64efa3e3833d749e5ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<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.html#aacb6d0e5e6d570cdc2b0da14c3921ff0">Close</a> ()=0</td></tr>
116<tr class="separator:aacb6d0e5e6d570cdc2b0da14c3921ff0"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<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.html#ac78c6bd1a545934a805c88194214b09d">WritePacket</a> (const unsigned char *buffer, uint32_t length)=0</td></tr>
118<tr class="separator:ac78c6bd1a545934a805c88194214b09d"><td class="memSeparator" colspan="2">&#160;</td></tr>
119<tr class="memitem:a935e16d85893a31f23cd78e47b85466d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarmnn_1_1profiling_1_1_packet.html">Packet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.html#a935e16d85893a31f23cd78e47b85466d">ReadPacket</a> (uint32_t timeout)=0</td></tr>
120<tr class="separator:a935e16d85893a31f23cd78e47b85466d"><td class="memSeparator" colspan="2">&#160;</td></tr>
121</table>
122<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
123<div class="textblock">
124<p class="definition">Definition at line <a class="el" href="_i_profiling_connection_8hpp_source.html#l00018">18</a> of file <a class="el" href="_i_profiling_connection_8hpp_source.html">IProfilingConnection.hpp</a>.</p>
125</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
126<a id="a8c5a75b8ee005a7aa9391f3991480d74"></a>
127<h2 class="memtitle"><span class="permalink"><a href="#a8c5a75b8ee005a7aa9391f3991480d74">&#9670;&nbsp;</a></span>~IProfilingConnection()</h2>
128
129<div class="memitem">
130<div class="memproto">
131<table class="mlabels">
132 <tr>
133 <td class="mlabels-left">
134 <table class="memname">
135 <tr>
136 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.html">IProfilingConnection</a> </td>
137 <td>(</td>
138 <td class="paramname"></td><td>)</td>
139 <td></td>
140 </tr>
141 </table>
142 </td>
143 <td class="mlabels-right">
144<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
145 </tr>
146</table>
147</div><div class="memdoc">
148
149<p class="definition">Definition at line <a class="el" href="_i_profiling_connection_8hpp_source.html#l00021">21</a> of file <a class="el" href="_i_profiling_connection_8hpp_source.html">IProfilingConnection.hpp</a>.</p>
150
151<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.html#aacb6d0e5e6d570cdc2b0da14c3921ff0">IProfilingConnection::Close()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.html#a8a3511046982c64efa3e3833d749e5ef">IProfilingConnection::IsOpen()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.html#a935e16d85893a31f23cd78e47b85466d">IProfilingConnection::ReadPacket()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.html#ac78c6bd1a545934a805c88194214b09d">IProfilingConnection::WritePacket()</a>.</p>
152<div class="fragment"><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{}</div></div><!-- fragment -->
153</div>
154</div>
155<h2 class="groupheader">Member Function Documentation</h2>
156<a id="aacb6d0e5e6d570cdc2b0da14c3921ff0"></a>
157<h2 class="memtitle"><span class="permalink"><a href="#aacb6d0e5e6d570cdc2b0da14c3921ff0">&#9670;&nbsp;</a></span>Close()</h2>
158
159<div class="memitem">
160<div class="memproto">
161<table class="mlabels">
162 <tr>
163 <td class="mlabels-left">
164 <table class="memname">
165 <tr>
166 <td class="memname">virtual void Close </td>
167 <td>(</td>
168 <td class="paramname"></td><td>)</td>
169 <td></td>
170 </tr>
171 </table>
172 </td>
173 <td class="mlabels-right">
174<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
175 </tr>
176</table>
177</div><div class="memdoc">
178
179<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.html#a0f9aecd570c4e5e6d41337f0e2f1adf5">TestProfilingConnectionBase</a>, <a class="el" href="classarmnn_1_1profiling_1_1_mock_profiling_connection.html#a0f9aecd570c4e5e6d41337f0e2f1adf5">MockProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_file_only_profiling_connection.html#a0f9aecd570c4e5e6d41337f0e2f1adf5">FileOnlyProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_dump_to_file_decorator.html#a0f9aecd570c4e5e6d41337f0e2f1adf5">ProfilingConnectionDumpToFileDecorator</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_socket_profiling_connection.html#a29dc6798f18d73abd4ba8e4910f6831f">SocketProfilingConnection</a>.</p>
180
181<p class="reference">Referenced by <a class="el" href="_i_profiling_connection_8hpp_source.html#l00021">IProfilingConnection::~IProfilingConnection()</a>.</p>
182
183</div>
184</div>
185<a id="a8a3511046982c64efa3e3833d749e5ef"></a>
186<h2 class="memtitle"><span class="permalink"><a href="#a8a3511046982c64efa3e3833d749e5ef">&#9670;&nbsp;</a></span>IsOpen()</h2>
187
188<div class="memitem">
189<div class="memproto">
190<table class="mlabels">
191 <tr>
192 <td class="mlabels-left">
193 <table class="memname">
194 <tr>
195 <td class="memname">virtual bool IsOpen </td>
196 <td>(</td>
197 <td class="paramname"></td><td>)</td>
198 <td> const</td>
199 </tr>
200 </table>
201 </td>
202 <td class="mlabels-right">
203<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
204 </tr>
205</table>
206</div><div class="memdoc">
207
208<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.html#a91bdc9d5497d47f5d707418beb83b140">TestProfilingConnectionBase</a>, <a class="el" href="classarmnn_1_1profiling_1_1_mock_profiling_connection.html#a91bdc9d5497d47f5d707418beb83b140">MockProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_file_only_profiling_connection.html#a91bdc9d5497d47f5d707418beb83b140">FileOnlyProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_dump_to_file_decorator.html#a91bdc9d5497d47f5d707418beb83b140">ProfilingConnectionDumpToFileDecorator</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_socket_profiling_connection.html#aaca9d54975c036540e7e5299a0c6df7a">SocketProfilingConnection</a>.</p>
209
210<p class="reference">Referenced by <a class="el" href="_send_thread_8cpp_source.html#l00082">SendThread::Stop()</a>, <a class="el" href="_command_handler_8cpp_source.html#l00034">CommandHandler::Stop()</a>, and <a class="el" href="_i_profiling_connection_8hpp_source.html#l00021">IProfilingConnection::~IProfilingConnection()</a>.</p>
211
212</div>
213</div>
214<a id="a935e16d85893a31f23cd78e47b85466d"></a>
215<h2 class="memtitle"><span class="permalink"><a href="#a935e16d85893a31f23cd78e47b85466d">&#9670;&nbsp;</a></span>ReadPacket()</h2>
216
217<div class="memitem">
218<div class="memproto">
219<table class="mlabels">
220 <tr>
221 <td class="mlabels-left">
222 <table class="memname">
223 <tr>
224 <td class="memname">virtual <a class="el" href="classarmnn_1_1profiling_1_1_packet.html">Packet</a> ReadPacket </td>
225 <td>(</td>
226 <td class="paramtype">uint32_t&#160;</td>
227 <td class="paramname"><em>timeout</em></td><td>)</td>
228 <td></td>
229 </tr>
230 </table>
231 </td>
232 <td class="mlabels-right">
233<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
234 </tr>
235</table>
236</div><div class="memdoc">
237
238<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_bad_ack_packet.html#a1adbda8257d3a74a0566e0d8407ff458">TestProfilingConnectionBadAckPacket</a>, <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_armnn_error.html#a1adbda8257d3a74a0566e0d8407ff458">TestProfilingConnectionArmnnError</a>, <a class="el" href="classarmnn_1_1profiling_1_1_mock_profiling_connection.html#a1adbda8257d3a74a0566e0d8407ff458">MockProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_timeout_error.html#a1adbda8257d3a74a0566e0d8407ff458">TestProfilingConnectionTimeoutError</a>, <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.html#a1adbda8257d3a74a0566e0d8407ff458">TestProfilingConnectionBase</a>, <a class="el" href="classarmnn_1_1profiling_1_1_file_only_profiling_connection.html#a1adbda8257d3a74a0566e0d8407ff458">FileOnlyProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_dump_to_file_decorator.html#a1adbda8257d3a74a0566e0d8407ff458">ProfilingConnectionDumpToFileDecorator</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_socket_profiling_connection.html#a15c46007b7627c887593d267023fbfa4">SocketProfilingConnection</a>.</p>
239
240<p class="reference">Referenced by <a class="el" href="_command_handler_8cpp_source.html#l00034">CommandHandler::Stop()</a>, and <a class="el" href="_i_profiling_connection_8hpp_source.html#l00021">IProfilingConnection::~IProfilingConnection()</a>.</p>
241
242</div>
243</div>
244<a id="ac78c6bd1a545934a805c88194214b09d"></a>
245<h2 class="memtitle"><span class="permalink"><a href="#ac78c6bd1a545934a805c88194214b09d">&#9670;&nbsp;</a></span>WritePacket()</h2>
246
247<div class="memitem">
248<div class="memproto">
249<table class="mlabels">
250 <tr>
251 <td class="mlabels-left">
252 <table class="memname">
253 <tr>
254 <td class="memname">virtual bool WritePacket </td>
255 <td>(</td>
256 <td class="paramtype">const unsigned char *&#160;</td>
257 <td class="paramname"><em>buffer</em>, </td>
258 </tr>
259 <tr>
260 <td class="paramkey"></td>
261 <td></td>
262 <td class="paramtype">uint32_t&#160;</td>
263 <td class="paramname"><em>length</em>&#160;</td>
264 </tr>
265 <tr>
266 <td></td>
267 <td>)</td>
268 <td></td><td></td>
269 </tr>
270 </table>
271 </td>
272 <td class="mlabels-right">
273<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
274 </tr>
275</table>
276</div><div class="memdoc">
277
278<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.html#a42eb542b5a1d73d00c4ce474140bb78c">TestProfilingConnectionBase</a>, <a class="el" href="classarmnn_1_1profiling_1_1_mock_profiling_connection.html#a42eb542b5a1d73d00c4ce474140bb78c">MockProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_file_only_profiling_connection.html#a42eb542b5a1d73d00c4ce474140bb78c">FileOnlyProfilingConnection</a>, <a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_dump_to_file_decorator.html#a42eb542b5a1d73d00c4ce474140bb78c">ProfilingConnectionDumpToFileDecorator</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_socket_profiling_connection.html#a096549d574d3fc51e6948efd24988f3e">SocketProfilingConnection</a>.</p>
279
280<p class="reference">Referenced by <a class="el" href="_send_thread_8cpp_source.html#l00082">SendThread::Stop()</a>, and <a class="el" href="_i_profiling_connection_8hpp_source.html#l00021">IProfilingConnection::~IProfilingConnection()</a>.</p>
281
282</div>
283</div>
284<hr/>The documentation for this class was generated from the following file:<ul>
285<li>src/profiling/<a class="el" href="_i_profiling_connection_8hpp_source.html">IProfilingConnection.hpp</a></li>
286</ul>
287</div><!-- contents -->
288</div><!-- doc-content -->
289<!-- start footer part -->
290<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
291 <ul>
292 <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_i_profiling_connection.html">IProfilingConnection</a></li>
293 <li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN by
294 <a href="http://www.doxygen.org/index.html">
295 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
296 </ul>
297</div>
298</body>
299</html>