diff options
author | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
---|---|---|
committer | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
commit | de36e4a9c299028e792c3a5bd99ad0816d806077 (patch) | |
tree | 6c71d89db68da1033bb422253cee2970580ed692 /Documentation/classarmnn_1_1profiling_1_1_i_profiling_connection.html | |
parent | 78b26f024641e763c7252198339c83bad8c0982f (diff) | |
download | armnn-de36e4a9c299028e792c3a5bd99ad0816d806077.tar.gz |
IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
Diffstat (limited to 'Documentation/classarmnn_1_1profiling_1_1_i_profiling_connection.html')
-rw-r--r-- | Documentation/classarmnn_1_1profiling_1_1_i_profiling_connection.html | 299 |
1 files changed, 299 insertions, 0 deletions
diff --git a/Documentation/classarmnn_1_1profiling_1_1_i_profiling_connection.html b/Documentation/classarmnn_1_1profiling_1_1_i_profiling_connection.html new file mode 100644 index 0000000000..879f402da1 --- /dev/null +++ b/Documentation/classarmnn_1_1profiling_1_1_i_profiling_connection.html @@ -0,0 +1,299 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: IProfilingConnection 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</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 style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">ArmNN +  <span id="projectnumber">NotReleased</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('classarmnn_1_1profiling_1_1_i_profiling_connection.html','');}); +</script> +<div id="doc-content"> +<!-- 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 class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarmnn_1_1profiling_1_1_i_profiling_connection-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">IProfilingConnection Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_i_profiling_connection_8hpp_source.html">IProfilingConnection.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for IProfilingConnection:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1profiling_1_1_i_profiling_connection.png" usemap="#IProfilingConnection_map" alt=""/> + <map id="IProfilingConnection_map" name="IProfilingConnection_map"> +<area href="classarmnn_1_1profiling_1_1_file_only_profiling_connection.html" alt="FileOnlyProfilingConnection" shape="rect" coords="0,56,247,80"/> +<area href="classarmnn_1_1profiling_1_1_mock_profiling_connection.html" alt="MockProfilingConnection" shape="rect" coords="257,56,504,80"/> +<area href="classarmnn_1_1profiling_1_1_profiling_connection_dump_to_file_decorator.html" alt="ProfilingConnectionDumpToFileDecorator" shape="rect" coords="514,56,761,80"/> +<area href="classarmnn_1_1profiling_1_1_socket_profiling_connection.html" alt="SocketProfilingConnection" shape="rect" coords="771,56,1018,80"/> +<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.html" alt="TestProfilingConnectionBase" shape="rect" coords="1028,56,1275,80"/> +<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_armnn_error.html" alt="TestProfilingConnectionArmnnError" shape="rect" coords="771,112,1018,136"/> +<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_bad_ack_packet.html" alt="TestProfilingConnectionBadAckPacket" shape="rect" coords="1028,112,1275,136"/> +<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_timeout_error.html" alt="TestProfilingConnectionTimeoutError" shape="rect" coords="1285,112,1532,136"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a8c5a75b8ee005a7aa9391f3991480d74"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.html#a8c5a75b8ee005a7aa9391f3991480d74">~IProfilingConnection</a> ()</td></tr> +<tr class="separator:a8c5a75b8ee005a7aa9391f3991480d74"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8a3511046982c64efa3e3833d749e5ef"><td class="memItemLeft" align="right" valign="top">virtual bool </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> +<tr class="separator:a8a3511046982c64efa3e3833d749e5ef"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aacb6d0e5e6d570cdc2b0da14c3921ff0"><td class="memItemLeft" align="right" valign="top">virtual void </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> +<tr class="separator:aacb6d0e5e6d570cdc2b0da14c3921ff0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac78c6bd1a545934a805c88194214b09d"><td class="memItemLeft" align="right" valign="top">virtual bool </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> +<tr class="separator:ac78c6bd1a545934a805c88194214b09d"><td class="memSeparator" colspan="2"> </td></tr> +<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> </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> +<tr class="separator:a935e16d85893a31f23cd78e47b85466d"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"> +<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> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a8c5a75b8ee005a7aa9391f3991480d74"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8c5a75b8ee005a7aa9391f3991480d74">◆ </a></span>~IProfilingConnection()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.html">IProfilingConnection</a> </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 class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<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> + +<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> +<div class="fragment"><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> {}</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="aacb6d0e5e6d570cdc2b0da14c3921ff0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aacb6d0e5e6d570cdc2b0da14c3921ff0">◆ </a></span>Close()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void Close </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<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> + +<p class="reference">Referenced by <a class="el" href="_i_profiling_connection_8hpp_source.html#l00021">IProfilingConnection::~IProfilingConnection()</a>.</p> + +</div> +</div> +<a id="a8a3511046982c64efa3e3833d749e5ef"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8a3511046982c64efa3e3833d749e5ef">◆ </a></span>IsOpen()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual bool IsOpen </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">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<a id="a935e16d85893a31f23cd78e47b85466d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a935e16d85893a31f23cd78e47b85466d">◆ </a></span>ReadPacket()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classarmnn_1_1profiling_1_1_packet.html">Packet</a> ReadPacket </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>timeout</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<a id="ac78c6bd1a545934a805c88194214b09d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac78c6bd1a545934a805c88194214b09d">◆ </a></span>WritePacket()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual bool WritePacket </td> + <td>(</td> + <td class="paramtype">const unsigned char * </td> + <td class="paramname"><em>buffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>length</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>src/profiling/<a class="el" href="_i_profiling_connection_8hpp_source.html">IProfilingConnection.hpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <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> + <li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |