blob: 948f5bc1c9c088c0a3ac2ab3d01fc92bb0995e4e [file] [log] [blame] [edit]
<!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: src/apps/lwiperf/lwiperf.c 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>
<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">&#160;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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('lwiperf_8c.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="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">lwiperf.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="lwiperf_8h.html">lwip/apps/lwiperf.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="tcp_8h.html">lwip/tcp.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="sys_8h.html">lwip/sys.h</a>&quot;</code><br />
<code>#include &lt;string.h&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__lwiperf__settings.html">_lwiperf_settings</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__lwiperf__state__tcp.html">_lwiperf_state_tcp</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a646d7e0b37c5cefdd6eef38a3fba4673" id="r_a646d7e0b37c5cefdd6eef38a3fba4673"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a646d7e0b37c5cefdd6eef38a3fba4673">LWIPERF_TCP_MAX_IDLE_SEC</a>&#160;&#160;&#160;10U</td></tr>
<tr class="separator:a646d7e0b37c5cefdd6eef38a3fba4673"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1351e47d0bdb7d0fe0efaf9f1b2b0f7a" id="r_a1351e47d0bdb7d0fe0efaf9f1b2b0f7a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1351e47d0bdb7d0fe0efaf9f1b2b0f7a">LWIPERF_SERVER_IP_TYPE</a>&#160;&#160;&#160;<a class="el" href="group__ipaddr.html#ggaf2142f0dfdcc938e2db16aa745ed585cac6b2c99cf920e08efcb55dc40e42944e">IPADDR_TYPE_ANY</a></td></tr>
<tr class="separator:a1351e47d0bdb7d0fe0efaf9f1b2b0f7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af51dcfc53fe575411c26e18963f1b902" id="r_af51dcfc53fe575411c26e18963f1b902"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af51dcfc53fe575411c26e18963f1b902">LWIPERF_CHECK_RX_DATA</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:af51dcfc53fe575411c26e18963f1b902"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a1e652bca1f12cfe6187a567d6b3be6a2" id="r_a1e652bca1f12cfe6187a567d6b3be6a2"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__lwiperf__settings.html">_lwiperf_settings</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1e652bca1f12cfe6187a567d6b3be6a2">lwiperf_settings_t</a></td></tr>
<tr class="separator:a1e652bca1f12cfe6187a567d6b3be6a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96ae8ebbc5d13657a641ed174ae22e5b" id="r_a96ae8ebbc5d13657a641ed174ae22e5b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__lwiperf__state__tcp.html">_lwiperf_state_tcp</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a96ae8ebbc5d13657a641ed174ae22e5b">lwiperf_state_tcp_t</a></td></tr>
<tr class="separator:a96ae8ebbc5d13657a641ed174ae22e5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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 *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iperf.html#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">&#160;</td></tr>
<tr class="memitem:ga6932fe36fa6fbc7081ad317b71d87bec" id="r_ga6932fe36fa6fbc7081ad317b71d87bec"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iperf.html#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">&#160;</td></tr>
<tr class="memitem:ga8106ed0805f2dc2b1d92e2f5b420f456" id="r_ga8106ed0805f2dc2b1d92e2f5b420f456"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iperf.html#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">&#160;</td></tr>
<tr class="memitem:ga1088722d967f0f465d45fd3b15dde445" id="r_ga1088722d967f0f465d45fd3b15dde445"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iperf.html#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">&#160;</td></tr>
<tr class="memitem:gac51c9c44a38bfa1140bd44b793a0a004" id="r_gac51c9c44a38bfa1140bd44b793a0a004"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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">Macro Definition Documentation</h2>
<a id="af51dcfc53fe575411c26e18963f1b902" name="af51dcfc53fe575411c26e18963f1b902"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af51dcfc53fe575411c26e18963f1b902">&#9670;&#160;</a></span>LWIPERF_CHECK_RX_DATA</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LWIPERF_CHECK_RX_DATA&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>If this is 1, check that received data has the correct format </p>
</div>
</div>
<a id="a1351e47d0bdb7d0fe0efaf9f1b2b0f7a" name="a1351e47d0bdb7d0fe0efaf9f1b2b0f7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1351e47d0bdb7d0fe0efaf9f1b2b0f7a">&#9670;&#160;</a></span>LWIPERF_SERVER_IP_TYPE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LWIPERF_SERVER_IP_TYPE&#160;&#160;&#160;<a class="el" href="group__ipaddr.html#ggaf2142f0dfdcc938e2db16aa745ed585cac6b2c99cf920e08efcb55dc40e42944e">IPADDR_TYPE_ANY</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Change this if you don't want to lwiperf to listen to any IP version </p>
</div>
</div>
<a id="a646d7e0b37c5cefdd6eef38a3fba4673" name="a646d7e0b37c5cefdd6eef38a3fba4673"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a646d7e0b37c5cefdd6eef38a3fba4673">&#9670;&#160;</a></span>LWIPERF_TCP_MAX_IDLE_SEC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LWIPERF_TCP_MAX_IDLE_SEC&#160;&#160;&#160;10U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specify the idle timeout (in seconds) after that the test fails </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a1e652bca1f12cfe6187a567d6b3be6a2" name="a1e652bca1f12cfe6187a567d6b3be6a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e652bca1f12cfe6187a567d6b3be6a2">&#9670;&#160;</a></span>lwiperf_settings_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct__lwiperf__settings.html">_lwiperf_settings</a> <a class="el" href="#a1e652bca1f12cfe6187a567d6b3be6a2">lwiperf_settings_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>This is the Iperf settings struct sent from the client </p>
</div>
</div>
<a id="a96ae8ebbc5d13657a641ed174ae22e5b" name="a96ae8ebbc5d13657a641ed174ae22e5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96ae8ebbc5d13657a641ed174ae22e5b">&#9670;&#160;</a></span>lwiperf_state_tcp_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct__lwiperf__state__tcp.html">_lwiperf_state_tcp</a> <a class="el" href="#a96ae8ebbc5d13657a641ed174ae22e5b">lwiperf_state_tcp_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Connection handle for a TCP iperf session </p>
</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_53adf0b982dc8545998aae3f283a5a58.html">apps</a></li><li class="navelem"><a class="el" href="dir_4b846c6b6971d2800eff93d75504accd.html">lwiperf</a></li><li class="navelem"><a class="el" href="lwiperf_8c.html">lwiperf.c</a></li>
<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>