| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.12.0"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>lwIP: Iperf server</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> |
| <script type="text/javascript" src="clipboard.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="cookie.js"></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 id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">lwIP<span id="projectnumber"> 2.1.3</span> |
| </div> |
| <div id="projectbrief">Lightweight IP stack</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.12.0 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { codefold.init(0); }); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search',true); |
| $(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </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"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function(){initNavTree('group__iperf.html',''); initResizable(true); }); |
| /* @license-end */ |
| </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"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"><div class="title">Iperf server<div class="ingroups"><a class="el" href="group__apps.html">Applications</a></div></div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:gad4c93f3e77140ef2966a291e564d67c5" id="r_gad4c93f3e77140ef2966a291e564d67c5"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad4c93f3e77140ef2966a291e564d67c5">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:gad4c93f3e77140ef2966a291e564d67c5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga6932fe36fa6fbc7081ad317b71d87bec" id="r_ga6932fe36fa6fbc7081ad317b71d87bec"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6932fe36fa6fbc7081ad317b71d87bec">lwiperf_start_tcp_server</a> (const <a class="el" href="group__ipaddr.html#ga335a8c9df66319e88a1a529047ce0a1e">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:ga6932fe36fa6fbc7081ad317b71d87bec"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga8106ed0805f2dc2b1d92e2f5b420f456" id="r_ga8106ed0805f2dc2b1d92e2f5b420f456"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8106ed0805f2dc2b1d92e2f5b420f456">lwiperf_start_tcp_client_default</a> (const <a class="el" href="group__ipaddr.html#ga335a8c9df66319e88a1a529047ce0a1e">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:ga8106ed0805f2dc2b1d92e2f5b420f456"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga1088722d967f0f465d45fd3b15dde445" id="r_ga1088722d967f0f465d45fd3b15dde445"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1088722d967f0f465d45fd3b15dde445">lwiperf_start_tcp_client</a> (const <a class="el" href="group__ipaddr.html#ga335a8c9df66319e88a1a529047ce0a1e">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:ga1088722d967f0f465d45fd3b15dde445"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gac51c9c44a38bfa1140bd44b793a0a004" id="r_gac51c9c44a38bfa1140bd44b793a0a004"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#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> |
| <p>This is a simple performance measuring client/server to check your bandwith using iPerf2 on a PC as server/client. It is currently a minimal implementation providing a TCP client/server only.</p> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="gac51c9c44a38bfa1140bd44b793a0a004" name="gac51c9c44a38bfa1140bd44b793a0a004"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gac51c9c44a38bfa1140bd44b793a0a004">◆ </a></span>lwiperf_abort()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void lwiperf_abort </td> |
| <td>(</td> |
| <td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>lwiperf_session</em></span></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Abort an iperf session (handle returned by lwiperf_start_tcp_server*()) </p> |
| |
| </div> |
| </div> |
| <a id="ga1088722d967f0f465d45fd3b15dde445" name="ga1088722d967f0f465d45fd3b15dde445"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga1088722d967f0f465d45fd3b15dde445">◆ </a></span>lwiperf_start_tcp_client()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void * lwiperf_start_tcp_client </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="group__ipaddr.html#ga335a8c9df66319e88a1a529047ce0a1e">ip_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>remote_addr</em></span>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">u16_t</td> <td class="paramname"><span class="paramname"><em>remote_port</em></span>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">enum <a class="el" href="lwiperf_8h.html#ab3280e56eb41bd6f698a20843573f76c">lwiperf_client_type</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a></td> <td class="paramname"><span class="paramname"><em>report_fn</em></span>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>report_arg</em></span> )</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Start a TCP iperf client to a specific IP address and port.</p> |
| <dl class="section return"><dt>Returns</dt><dd>a connection handle that can be used to abort the client by calling <a class="el" href="#gac51c9c44a38bfa1140bd44b793a0a004">lwiperf_abort()</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga8106ed0805f2dc2b1d92e2f5b420f456" name="ga8106ed0805f2dc2b1d92e2f5b420f456"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga8106ed0805f2dc2b1d92e2f5b420f456">◆ </a></span>lwiperf_start_tcp_client_default()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void * lwiperf_start_tcp_client_default </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="group__ipaddr.html#ga335a8c9df66319e88a1a529047ce0a1e">ip_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>remote_addr</em></span>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a></td> <td class="paramname"><span class="paramname"><em>report_fn</em></span>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>report_arg</em></span> )</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Start a TCP iperf client to the default TCP port (5001).</p> |
| <dl class="section return"><dt>Returns</dt><dd>a connection handle that can be used to abort the client by calling <a class="el" href="#gac51c9c44a38bfa1140bd44b793a0a004">lwiperf_abort()</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga6932fe36fa6fbc7081ad317b71d87bec" name="ga6932fe36fa6fbc7081ad317b71d87bec"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6932fe36fa6fbc7081ad317b71d87bec">◆ </a></span>lwiperf_start_tcp_server()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void * lwiperf_start_tcp_server </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="group__ipaddr.html#ga335a8c9df66319e88a1a529047ce0a1e">ip_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>local_addr</em></span>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">u16_t</td> <td class="paramname"><span class="paramname"><em>local_port</em></span>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a></td> <td class="paramname"><span class="paramname"><em>report_fn</em></span>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>report_arg</em></span> )</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Start a TCP iperf server on a specific IP address and port and listen for incoming connections from iperf clients.</p> |
| <dl class="section return"><dt>Returns</dt><dd>a connection handle that can be used to abort the server by calling <a class="el" href="#gac51c9c44a38bfa1140bd44b793a0a004">lwiperf_abort()</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gad4c93f3e77140ef2966a291e564d67c5" name="gad4c93f3e77140ef2966a291e564d67c5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gad4c93f3e77140ef2966a291e564d67c5">◆ </a></span>lwiperf_start_tcp_server_default()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void * lwiperf_start_tcp_server_default </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a></td> <td class="paramname"><span class="paramname"><em>report_fn</em></span>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>report_arg</em></span> )</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Start a TCP iperf server on the default TCP port (5001) and listen for incoming connections from iperf clients.</p> |
| <dl class="section return"><dt>Returns</dt><dd>a connection handle that can be used to abort the server by calling <a class="el" href="#gac51c9c44a38bfa1140bd44b793a0a004">lwiperf_abort()</a> </dd></dl> |
| |
| </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="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |