mirror of
https://github.com/buildwithparallel/mm-iot-sdk
synced 2026-08-10 21:27:58 -04:00
4f4eb7fc7a
This commit introduces version 2.9.7 of the Morse Micro MM-IoT-SDK for ARM microcontroller base platforms.
295 lines
18 KiB
HTML
295 lines
18 KiB
HTML
<!-- HTML header for doxygen 1.8.17-->
|
|
<!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.9.4"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Morse Micro IoT SDK: mmiperf_client_args Struct 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>
|
|
<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" />
|
|
<link href="style.css" rel="stylesheet" type="text/css"/>
|
|
<link rel="shortcut icon" href="favicon.svg" />
|
|
</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="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Morse Micro IoT SDK
|
|
 <span id="projectnumber">2.9.7</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.4 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @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');
|
|
$(document).ready(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 */
|
|
$(document).ready(function(){initNavTree('structmmiperf__client__args.html',''); initResizable(); });
|
|
/* @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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle"><div class="title">mmiperf_client_args Struct Reference<div class="ingroups"><a class="el" href="group__MMAPP.html">Application Layer Protocol APIs</a> » <a class="el" href="group__MMIPERF.html">Morse Micro Iperf</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >Iperf client arguments data structure. </p>
|
|
<p >For forward compatibility this structure should be initialized using <code>MMIPERF_CLIENT_ARGS_DEFAULT</code>. For example:</p>
|
|
<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structmmiperf__client__args.html">mmiperf_client_args</a> args = <a class="code hl_define" href="group__MMIPERF.html#ga4f10814c20514ad3a82f6b084d11edc2">MMIPERF_CLIENT_ARGS_DEFAULT</a>;</div>
|
|
<div class="ttc" id="agroup__MMIPERF_html_ga4f10814c20514ad3a82f6b084d11edc2"><div class="ttname"><a href="group__MMIPERF.html#ga4f10814c20514ad3a82f6b084d11edc2">MMIPERF_CLIENT_ARGS_DEFAULT</a></div><div class="ttdeci">#define MMIPERF_CLIENT_ARGS_DEFAULT</div><div class="ttdoc">Initializer for mmiperf_client_args.</div><div class="ttdef"><b>Definition:</b> <a href="mmiperf_8h_source.html#l00181">mmiperf.h:181</a></div></div>
|
|
<div class="ttc" id="astructmmiperf__client__args_html"><div class="ttname"><a href="structmmiperf__client__args.html">mmiperf_client_args</a></div><div class="ttdoc">Iperf client arguments data structure.</div><div class="ttdef"><b>Definition:</b> <a href="mmiperf_8h_source.html#l00156">mmiperf.h:157</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="mmiperf_8h_source.html#l00156">156</a> of file <a class="el" href="mmiperf_8h_source.html">mmiperf.h</a>.</p>
|
|
</div>
|
|
<p><code>#include <<a class="el" href="mmiperf_8h_source.html">mmiperf.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a78d1873ae0c8e8effe45fa756ab5b849"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmiperf__client__args.html#a78d1873ae0c8e8effe45fa756ab5b849">server_addr</a> [<a class="el" href="group__MMIPERF.html#gacbd53afcfa9f34f8855320f0aad2d6a5">MMIPERF_IPADDR_MAXLEN</a>]</td></tr>
|
|
<tr class="memdesc:a78d1873ae0c8e8effe45fa756ab5b849"><td class="mdescLeft"> </td><td class="mdescRight">IP address of iperf server to communicate with (as a string). <a href="structmmiperf__client__args.html#a78d1873ae0c8e8effe45fa756ab5b849">More...</a><br /></td></tr>
|
|
<tr class="separator:a78d1873ae0c8e8effe45fa756ab5b849"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee5bfdde9ea2315b9729c76d358d820c"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmiperf__client__args.html#aee5bfdde9ea2315b9729c76d358d820c">server_port</a></td></tr>
|
|
<tr class="memdesc:aee5bfdde9ea2315b9729c76d358d820c"><td class="mdescLeft"> </td><td class="mdescRight">Port on iperf server to communicate with. <a href="structmmiperf__client__args.html#aee5bfdde9ea2315b9729c76d358d820c">More...</a><br /></td></tr>
|
|
<tr class="separator:aee5bfdde9ea2315b9729c76d358d820c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb868e8b77d18d5e29b83be85f002b92"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmiperf__client__args.html#acb868e8b77d18d5e29b83be85f002b92">target_bw</a></td></tr>
|
|
<tr class="memdesc:acb868e8b77d18d5e29b83be85f002b92"><td class="mdescLeft"> </td><td class="mdescRight">Bandwidth limit (in kbps) to communicate with (0 indicates no limit). <a href="structmmiperf__client__args.html#acb868e8b77d18d5e29b83be85f002b92">More...</a><br /></td></tr>
|
|
<tr class="separator:acb868e8b77d18d5e29b83be85f002b92"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7be8a86a6762930310832a680bc17f1e"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmiperf__client__args.html#a7be8a86a6762930310832a680bc17f1e">packet_size</a></td></tr>
|
|
<tr class="memdesc:a7be8a86a6762930310832a680bc17f1e"><td class="mdescLeft"> </td><td class="mdescRight">Packet size to use. <a href="structmmiperf__client__args.html#a7be8a86a6762930310832a680bc17f1e">More...</a><br /></td></tr>
|
|
<tr class="separator:a7be8a86a6762930310832a680bc17f1e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc821f1f8b906b475419389cb2ac6840"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmiperf__client__args.html#acc821f1f8b906b475419389cb2ac6840">amount</a></td></tr>
|
|
<tr class="memdesc:acc821f1f8b906b475419389cb2ac6840"><td class="mdescLeft"> </td><td class="mdescRight">If positive specifies how many bytes to transfer; if negative the absolute value specifies the duration of the test in hundredths of seconds. <a href="structmmiperf__client__args.html#acc821f1f8b906b475419389cb2ac6840">More...</a><br /></td></tr>
|
|
<tr class="separator:acc821f1f8b906b475419389cb2ac6840"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9466462cdbb2c82626450fccfd2c96a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MMIPERF.html#ga94a06d5ec557103dd3310e0c0a158583">mmiperf_report_fn</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmiperf__client__args.html#a9466462cdbb2c82626450fccfd2c96a4">report_fn</a></td></tr>
|
|
<tr class="memdesc:a9466462cdbb2c82626450fccfd2c96a4"><td class="mdescLeft"> </td><td class="mdescRight">Report callback function to invoke on completion/abort. <a href="structmmiperf__client__args.html#a9466462cdbb2c82626450fccfd2c96a4">More...</a><br /></td></tr>
|
|
<tr class="separator:a9466462cdbb2c82626450fccfd2c96a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad02cd0e9fea6f7f72594a1b9d1c36b41"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmiperf__client__args.html#ad02cd0e9fea6f7f72594a1b9d1c36b41">report_arg</a></td></tr>
|
|
<tr class="memdesc:ad02cd0e9fea6f7f72594a1b9d1c36b41"><td class="mdescLeft"> </td><td class="mdescRight">Opaque argument to pass to the report callback. <a href="structmmiperf__client__args.html#ad02cd0e9fea6f7f72594a1b9d1c36b41">More...</a><br /></td></tr>
|
|
<tr class="separator:ad02cd0e9fea6f7f72594a1b9d1c36b41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9b8e5d920fc9293340dde959d96ddde"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__MMIPERF.html#gaa1fc3bae5d5847c9e2d5a5a2a264a9da">iperf_version</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmiperf__client__args.html#ae9b8e5d920fc9293340dde959d96ddde">version</a></td></tr>
|
|
<tr class="memdesc:ae9b8e5d920fc9293340dde959d96ddde"><td class="mdescLeft"> </td><td class="mdescRight">Iperf version used to parse packet header. <a href="structmmiperf__client__args.html#ae9b8e5d920fc9293340dde959d96ddde">More...</a><br /></td></tr>
|
|
<tr class="separator:ae9b8e5d920fc9293340dde959d96ddde"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="acc821f1f8b906b475419389cb2ac6840" name="acc821f1f8b906b475419389cb2ac6840"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acc821f1f8b906b475419389cb2ac6840">◆ </a></span>amount</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32_t mmiperf_client_args::amount</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>If positive specifies how many bytes to transfer; if negative the absolute value specifies the duration of the test in hundredths of seconds. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmiperf_8h_source.html#l00171">171</a> of file <a class="el" href="mmiperf_8h_source.html">mmiperf.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7be8a86a6762930310832a680bc17f1e" name="a7be8a86a6762930310832a680bc17f1e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7be8a86a6762930310832a680bc17f1e">◆ </a></span>packet_size</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmiperf_client_args::packet_size</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Packet size to use. </p>
|
|
<p >Only applies to UDP iperf tests. When set to zero, appropriate value of <code>MMIPERF_DEFAULT_UDP_PACKET_SIZE_V4</code> or <code>MMIPERF_DEFAULT_UDP_PACKET_SIZE_V6</code> will be used depending on whether the given server_addr is <code>IPv4</code> or <code>IPv6</code> address. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmiperf_8h_source.html#l00168">168</a> of file <a class="el" href="mmiperf_8h_source.html">mmiperf.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad02cd0e9fea6f7f72594a1b9d1c36b41" name="ad02cd0e9fea6f7f72594a1b9d1c36b41"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad02cd0e9fea6f7f72594a1b9d1c36b41">◆ </a></span>report_arg</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* mmiperf_client_args::report_arg</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opaque argument to pass to the report callback. </p>
|
|
<p >May be <code>NULL</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmiperf_8h_source.html#l00175">175</a> of file <a class="el" href="mmiperf_8h_source.html">mmiperf.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9466462cdbb2c82626450fccfd2c96a4" name="a9466462cdbb2c82626450fccfd2c96a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9466462cdbb2c82626450fccfd2c96a4">◆ </a></span>report_fn</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__MMIPERF.html#ga94a06d5ec557103dd3310e0c0a158583">mmiperf_report_fn</a> mmiperf_client_args::report_fn</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Report callback function to invoke on completion/abort. </p>
|
|
<p >May be <code>NULL</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmiperf_8h_source.html#l00173">173</a> of file <a class="el" href="mmiperf_8h_source.html">mmiperf.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a78d1873ae0c8e8effe45fa756ab5b849" name="a78d1873ae0c8e8effe45fa756ab5b849"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78d1873ae0c8e8effe45fa756ab5b849">◆ </a></span>server_addr</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char mmiperf_client_args::server_addr[<a class="el" href="group__MMIPERF.html#gacbd53afcfa9f34f8855320f0aad2d6a5">MMIPERF_IPADDR_MAXLEN</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>IP address of iperf server to communicate with (as a string). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmiperf_8h_source.html#l00159">159</a> of file <a class="el" href="mmiperf_8h_source.html">mmiperf.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee5bfdde9ea2315b9729c76d358d820c" name="aee5bfdde9ea2315b9729c76d358d820c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee5bfdde9ea2315b9729c76d358d820c">◆ </a></span>server_port</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t mmiperf_client_args::server_port</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Port on iperf server to communicate with. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmiperf_8h_source.html#l00161">161</a> of file <a class="el" href="mmiperf_8h_source.html">mmiperf.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acb868e8b77d18d5e29b83be85f002b92" name="acb868e8b77d18d5e29b83be85f002b92"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acb868e8b77d18d5e29b83be85f002b92">◆ </a></span>target_bw</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmiperf_client_args::target_bw</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Bandwidth limit (in kbps) to communicate with (0 indicates no limit). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmiperf_8h_source.html#l00163">163</a> of file <a class="el" href="mmiperf_8h_source.html">mmiperf.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae9b8e5d920fc9293340dde959d96ddde" name="ae9b8e5d920fc9293340dde959d96ddde"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae9b8e5d920fc9293340dde959d96ddde">◆ </a></span>version</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__MMIPERF.html#gaa1fc3bae5d5847c9e2d5a5a2a264a9da">iperf_version</a> mmiperf_client_args::version</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Iperf version used to parse packet header. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmiperf_8h_source.html#l00177">177</a> of file <a class="el" href="mmiperf_8h_source.html">mmiperf.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="mmiperf_8h_source.html">mmiperf.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.17-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="structmmiperf__client__args.html">mmiperf_client_args</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|