<!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">
<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.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UbixOS: include/net/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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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">UbixOS
 <span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',false,false,'search.php','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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d0/d83/lwiperf_8h.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<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 "lwip/opt.h"</code><br />
<code>#include "lwip/ip_addr.h"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for lwiperf.h:</div>
<div class="dyncontent">
<div class="center"><img src="../../dd/dc9/lwiperf_8h__incl.png" border="0" usemap="#include_2net_2apps_2lwiperf_8h" alt=""/></div>
<map name="include_2net_2apps_2lwiperf_8h" id="include_2net_2apps_2lwiperf_8h">
<area shape="rect" title=" " alt="" coords="16,5,184,32"/>
<area shape="rect" title=" " alt="" coords="5,80,83,107"/>
<area shape="rect" title=" " alt="" coords="107,80,208,107"/>
</map>
</div>
</div>
<p><a href="../../d0/d83/lwiperf_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a911cc7e298ab38433bd4a4980cdcad15"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d83/lwiperf_8h.html#a911cc7e298ab38433bd4a4980cdcad15">LWIPERF_TCP_PORT_DEFAULT</a>   5001</td></tr>
<tr class="separator:a911cc7e298ab38433bd4a4980cdcad15"><td class="memSeparator" colspan="2"> </td></tr>
</table><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="../../d0/d83/lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a>) (void *arg, enum <a class="el" href="../../d0/d83/lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6">lwiperf_report_type</a> report_type, <a class="el" href="../../d6/d92/cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="../../de/df7/ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> *local_addr, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> local_port, <a class="el" href="../../d6/d92/cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="../../de/df7/ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> *remote_addr, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> remote_port, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> bytes_transferred, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> ms_duration, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> 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="../../d0/d83/lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6">lwiperf_report_type</a> { <br />
  <a class="el" href="../../d0/d83/lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6aa52255236ad2983346311ce7f28210e5">LWIPERF_TCP_DONE_SERVER</a>,
<a class="el" href="../../d0/d83/lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6a4f9bde0cad305eaab25d2c1d0196677b">LWIPERF_TCP_DONE_CLIENT</a>,
<a class="el" href="../../d0/d83/lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6abee2bf6da51a0845c15ac52b280203cb">LWIPERF_TCP_ABORTED_LOCAL</a>,
<a class="el" href="../../d0/d83/lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6adda7e5dbaf1e04eb04ec0fd2b05584a5">LWIPERF_TCP_ABORTED_LOCAL_DATAERROR</a>,
<br />
  <a class="el" href="../../d0/d83/lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6a3d4e1f5742d80aeafb6b22aa74d93e40">LWIPERF_TCP_ABORTED_LOCAL_TXERROR</a>,
<a class="el" href="../../d0/d83/lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6ae664c0f987584f07fb0f6f8896aada0d">LWIPERF_TCP_ABORTED_REMOTE</a>
<br />
}</td></tr>
<tr class="separator:ab72a2d205e43d5243a291f937bbc24d6"><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:ac51c9c44a38bfa1140bd44b793a0a004"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d83/lwiperf_8h.html#ac51c9c44a38bfa1140bd44b793a0a004">lwiperf_abort</a> (void *lwiperf_session)</td></tr>
<tr class="separator:ac51c9c44a38bfa1140bd44b793a0a004"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad97bf77057e7f96d6d8def812deea202"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d83/lwiperf_8h.html#ad97bf77057e7f96d6d8def812deea202">lwiperf_start_tcp_server</a> (<a class="el" href="../../d6/d92/cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="../../de/df7/ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> *local_addr, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> local_port, <a class="el" href="../../d0/d83/lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a> report_fn, void *report_arg)</td></tr>
<tr class="separator:ad97bf77057e7f96d6d8def812deea202"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1f30a02b86c4dd3d47810cd493baf26"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d83/lwiperf_8h.html#ae1f30a02b86c4dd3d47810cd493baf26">lwiperf_start_tcp_server_default</a> (<a class="el" href="../../d0/d83/lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a> report_fn, void *report_arg)</td></tr>
<tr class="separator:ae1f30a02b86c4dd3d47810cd493baf26"><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>
<p class="definition">Definition in file <a class="el" href="../../d0/d83/lwiperf_8h_source.html">lwiperf.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a911cc7e298ab38433bd4a4980cdcad15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a911cc7e298ab38433bd4a4980cdcad15">◆ </a></span>LWIPERF_TCP_PORT_DEFAULT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LWIPERF_TCP_PORT_DEFAULT   5001</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d0/d83/lwiperf_8h_source.html#l00047">47</a> of file <a class="el" href="../../d0/d83/lwiperf_8h_source.html">lwiperf.h</a>.</p>
</div>
</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="../../d0/d83/lwiperf_8h.html#ab72a2d205e43d5243a291f937bbc24d6">lwiperf_report_type</a> report_type, <a class="el" href="../../d6/d92/cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="../../de/df7/ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> *local_addr, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> local_port, <a class="el" href="../../d6/d92/cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="../../de/df7/ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> *remote_addr, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> remote_port, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> bytes_transferred, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> ms_duration, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> 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>
<p class="definition">Definition at line <a class="el" href="../../d0/d83/lwiperf_8h_source.html#l00069">69</a> of file <a class="el" href="../../d0/d83/lwiperf_8h_source.html">lwiperf.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<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="../../d0/d83/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>
<p class="definition">Definition at line <a class="el" href="../../d0/d83/lwiperf_8h_source.html#l00050">50</a> of file <a class="el" href="../../d0/d83/lwiperf_8h_source.html">lwiperf.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ac51c9c44a38bfa1140bd44b793a0a004"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac51c9c44a38bfa1140bd44b793a0a004">◆ </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"><em>lwiperf_session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad97bf77057e7f96d6d8def812deea202"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad97bf77057e7f96d6d8def812deea202">◆ </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"><a class="el" href="../../d6/d92/cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="../../de/df7/ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> * </td>
<td class="paramname"><em>local_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td>
<td class="paramname"><em>local_port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d0/d83/lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a> </td>
<td class="paramname"><em>report_fn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>report_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae1f30a02b86c4dd3d47810cd493baf26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1f30a02b86c4dd3d47810cd493baf26">◆ </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="../../d0/d83/lwiperf_8h.html#a248ea47a58a14c6aecf6525217a812fd">lwiperf_report_fn</a> </td>
<td class="paramname"><em>report_fn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>report_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_2fa1ed3146d6c2b96c5cfe4341985326.html">net</a></li><li class="navelem"><a class="el" href="../../dir_7d55327bc30028744823fa5bbef34552.html">apps</a></li><li class="navelem"><a class="el" href="../../d0/d83/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.16 </li>
</ul>
</div>
</body>
</html>
