| <!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>lwIP: src/include/lwip/apps/lwiperf.h File 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">lwIP |
|  <span id="projectnumber">2.1.2</span> |
| </div> |
| <div id="projectbrief">Lightweight IP stack</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('lwiperf_8h.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="#typedef-members">Typedefs</a> | |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">lwiperf.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="textblock"><code>#include "<a class="el" href="opt_8h.html">lwip/opt.h</a>"</code><br /> |
| <code>#include "<a class="el" href="ip__addr_8h.html">lwip/ip_addr.h</a>"</code><br /> |
| </div><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> |
| Typedefs</h2></td></tr> |
| <tr class="memitem:a248ea47a58a14c6aecf6525217a812fd"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a>) (void *arg, enum <a class="el" href="lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6">lwiperf_report_type</a> report_type, const <a class="el" href="group__ipaddr.html#ga16ef96d6cde029029bbf47fee35fd67a">ip_addr_t</a> *local_addr, u16_t local_port, const <a class="el" href="group__ipaddr.html#ga16ef96d6cde029029bbf47fee35fd67a">ip_addr_t</a> *remote_addr, u16_t remote_port, u32_t bytes_transferred, u32_t ms_duration, u32_t bandwidth_kbitpsec)</td></tr> |
| <tr class="separator:a248ea47a58a14c6aecf6525217a812fd"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> |
| Enumerations</h2></td></tr> |
| <tr class="memitem:ab72a2d205e43d5243a291f937bbc24d6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6">lwiperf_report_type</a> { <br /> |
|   <a class="el" href="lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6aa52255236ad2983346311ce7f28210e5">LWIPERF_TCP_DONE_SERVER</a>, |
| <a class="el" href="lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6a4f9bde0cad305eaab25d2c1d0196677b">LWIPERF_TCP_DONE_CLIENT</a>, |
| <a class="el" href="lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6abee2bf6da51a0845c15ac52b280203cb">LWIPERF_TCP_ABORTED_LOCAL</a>, |
| <a class="el" href="lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6adda7e5dbaf1e04eb04ec0fd2b05584a5">LWIPERF_TCP_ABORTED_LOCAL_DATAERROR</a>, |
| <br /> |
|   <a class="el" href="lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6a3d4e1f5742d80aeafb6b22aa74d93e40">LWIPERF_TCP_ABORTED_LOCAL_TXERROR</a>, |
| <a class="el" href="lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6ae664c0f987584f07fb0f6f8896aada0d">LWIPERF_TCP_ABORTED_REMOTE</a> |
| <br /> |
| }</td></tr> |
| <tr class="separator:ab72a2d205e43d5243a291f937bbc24d6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab3280e56eb41bd6f698a20843573f76c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="lwiperf_8h.html#ab3280e56eb41bd6f698a20843573f76c">lwiperf_client_type</a> { <a class="el" href="lwiperf_8h.html#ab3280e56eb41bd6f698a20843573f76cae1862655ebaaea2e7e0261dff0173110">LWIPERF_CLIENT</a>, |
| <a class="el" href="lwiperf_8h.html#ab3280e56eb41bd6f698a20843573f76cab0381feca6655968e7380622e7a63ede">LWIPERF_DUAL</a>, |
| <a class="el" href="lwiperf_8h.html#ab3280e56eb41bd6f698a20843573f76caccdab7ee6e1b0981861e66f0755f7964">LWIPERF_TRADEOFF</a> |
| }</td></tr> |
| <tr class="separator:ab3280e56eb41bd6f698a20843573f76c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:gad97bf77057e7f96d6d8def812deea202"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iperf.html#gad97bf77057e7f96d6d8def812deea202">lwiperf_start_tcp_server</a> (const <a class="el" href="group__ipaddr.html#ga16ef96d6cde029029bbf47fee35fd67a">ip_addr_t</a> *local_addr, u16_t local_port, <a class="el" href="lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a> report_fn, void *report_arg)</td></tr> |
| <tr class="separator:gad97bf77057e7f96d6d8def812deea202"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae1f30a02b86c4dd3d47810cd493baf26"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iperf.html#gae1f30a02b86c4dd3d47810cd493baf26">lwiperf_start_tcp_server_default</a> (<a class="el" href="lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a> report_fn, void *report_arg)</td></tr> |
| <tr class="separator:gae1f30a02b86c4dd3d47810cd493baf26"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad8317f52289d8bb12a14627cd177a565"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iperf.html#gad8317f52289d8bb12a14627cd177a565">lwiperf_start_tcp_client</a> (const <a class="el" href="group__ipaddr.html#ga16ef96d6cde029029bbf47fee35fd67a">ip_addr_t</a> *remote_addr, u16_t remote_port, enum <a class="el" href="lwiperf_8h.html#ab3280e56eb41bd6f698a20843573f76c">lwiperf_client_type</a> type, <a class="el" href="lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a> report_fn, void *report_arg)</td></tr> |
| <tr class="separator:gad8317f52289d8bb12a14627cd177a565"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga85a487cf8ecbd0999382c9bff375d0da"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iperf.html#ga85a487cf8ecbd0999382c9bff375d0da">lwiperf_start_tcp_client_default</a> (const <a class="el" href="group__ipaddr.html#ga16ef96d6cde029029bbf47fee35fd67a">ip_addr_t</a> *remote_addr, <a class="el" href="lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a> report_fn, void *report_arg)</td></tr> |
| <tr class="separator:ga85a487cf8ecbd0999382c9bff375d0da"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gac51c9c44a38bfa1140bd44b793a0a004"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iperf.html#gac51c9c44a38bfa1140bd44b793a0a004">lwiperf_abort</a> (void *lwiperf_session)</td></tr> |
| <tr class="separator:gac51c9c44a38bfa1140bd44b793a0a004"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>lwIP iPerf server implementation </p> |
| </div><h2 class="groupheader">Typedef Documentation</h2> |
| <a id="a248ea47a58a14c6aecf6525217a812fd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a248ea47a58a14c6aecf6525217a812fd">◆ </a></span>lwiperf_report_fn</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef void(* lwiperf_report_fn) (void *arg, enum <a class="el" href="lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6">lwiperf_report_type</a> report_type, const <a class="el" href="group__ipaddr.html#ga16ef96d6cde029029bbf47fee35fd67a">ip_addr_t</a> *local_addr, u16_t local_port, const <a class="el" href="group__ipaddr.html#ga16ef96d6cde029029bbf47fee35fd67a">ip_addr_t</a> *remote_addr, u16_t remote_port, u32_t bytes_transferred, u32_t ms_duration, u32_t bandwidth_kbitpsec)</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Prototype of a report function that is called when a session is finished. This report function can show the test results. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">report_type</td><td>contains the test result </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Enumeration Type Documentation</h2> |
| <a id="ab3280e56eb41bd6f698a20843573f76c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab3280e56eb41bd6f698a20843573f76c">◆ </a></span>lwiperf_client_type</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="lwiperf_8h.html#ab3280e56eb41bd6f698a20843573f76c">lwiperf_client_type</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Control </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab3280e56eb41bd6f698a20843573f76cae1862655ebaaea2e7e0261dff0173110"></a>LWIPERF_CLIENT </td><td class="fielddoc"><p>Unidirectional tx only test </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="ab3280e56eb41bd6f698a20843573f76cab0381feca6655968e7380622e7a63ede"></a>LWIPERF_DUAL </td><td class="fielddoc"><p>Do a bidirectional test simultaneously </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="ab3280e56eb41bd6f698a20843573f76caccdab7ee6e1b0981861e66f0755f7964"></a>LWIPERF_TRADEOFF </td><td class="fielddoc"><p>Do a bidirectional test individually </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <a id="ab72a2d205e43d5243a291f937bbc24d6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab72a2d205e43d5243a291f937bbc24d6">◆ </a></span>lwiperf_report_type</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6">lwiperf_report_type</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>lwIPerf test results </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab72a2d205e43d5243a291f937bbc24d6aa52255236ad2983346311ce7f28210e5"></a>LWIPERF_TCP_DONE_SERVER </td><td class="fielddoc"><p>The server side test is done </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="ab72a2d205e43d5243a291f937bbc24d6a4f9bde0cad305eaab25d2c1d0196677b"></a>LWIPERF_TCP_DONE_CLIENT </td><td class="fielddoc"><p>The client side test is done </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="ab72a2d205e43d5243a291f937bbc24d6abee2bf6da51a0845c15ac52b280203cb"></a>LWIPERF_TCP_ABORTED_LOCAL </td><td class="fielddoc"><p>Local error lead to test abort </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="ab72a2d205e43d5243a291f937bbc24d6adda7e5dbaf1e04eb04ec0fd2b05584a5"></a>LWIPERF_TCP_ABORTED_LOCAL_DATAERROR </td><td class="fielddoc"><p>Data check error lead to test abort </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="ab72a2d205e43d5243a291f937bbc24d6a3d4e1f5742d80aeafb6b22aa74d93e40"></a>LWIPERF_TCP_ABORTED_LOCAL_TXERROR </td><td class="fielddoc"><p>Transmit error lead to test abort </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="ab72a2d205e43d5243a291f937bbc24d6ae664c0f987584f07fb0f6f8896aada0d"></a>LWIPERF_TCP_ABORTED_REMOTE </td><td class="fielddoc"><p>Remote side aborted the test </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| </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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_4e6b3cf33a61b6caac9c8ac30c866f37.html">lwip</a></li><li class="navelem"><a class="el" href="dir_f9284811ac594eafdc3134d5f8b945cb.html">apps</a></li><li class="navelem"><a class="el" href="lwiperf_8h.html">lwiperf.h</a></li> |
| <li class="footer">Generated 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> |
