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.
267 lines
15 KiB
HTML
267 lines
15 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: struct_iperf_status 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('structstruct__iperf__status.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">struct_iperf_status Struct Reference<div class="ingroups"><a class="el" href="group__MMAGIC.html">MMAGIC: CLI and Machine-to-Machine interface infrastructure</a> » <a class="el" href="group__MMAGIC__CONTROLLER.html">Morse M2M Interface Controller API</a> » <a class="el" href="group__MMAGIC__CONTROLLER__DATA__TYPES.html">Data types</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 >Data structure to store iperf results. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00458">458</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
</div>
|
|
<p><code>#include <<a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.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:ada18d4c71895e95735cebf6c41784901"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structstruct__ip__addr.html">struct_ip_addr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__iperf__status.html#ada18d4c71895e95735cebf6c41784901">remote_addr</a></td></tr>
|
|
<tr class="memdesc:ada18d4c71895e95735cebf6c41784901"><td class="mdescLeft"> </td><td class="mdescRight">IP address of the remote device. <a href="structstruct__iperf__status.html#ada18d4c71895e95735cebf6c41784901">More...</a><br /></td></tr>
|
|
<tr class="separator:ada18d4c71895e95735cebf6c41784901"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac84c0090db0d4319bbc2bb5ea85fee62"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__iperf__status.html#ac84c0090db0d4319bbc2bb5ea85fee62">remote_port</a></td></tr>
|
|
<tr class="memdesc:ac84c0090db0d4319bbc2bb5ea85fee62"><td class="mdescLeft"> </td><td class="mdescRight">Port number of the remote device. <a href="structstruct__iperf__status.html#ac84c0090db0d4319bbc2bb5ea85fee62">More...</a><br /></td></tr>
|
|
<tr class="separator:ac84c0090db0d4319bbc2bb5ea85fee62"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab095760373ac70a58308d421a508fddc"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structstruct__ip__addr.html">struct_ip_addr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__iperf__status.html#ab095760373ac70a58308d421a508fddc">local_addr</a></td></tr>
|
|
<tr class="memdesc:ab095760373ac70a58308d421a508fddc"><td class="mdescLeft"> </td><td class="mdescRight">IP address of the local device. <a href="structstruct__iperf__status.html#ab095760373ac70a58308d421a508fddc">More...</a><br /></td></tr>
|
|
<tr class="separator:ab095760373ac70a58308d421a508fddc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0cb16e264a79419032dad122e21177d1"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__iperf__status.html#a0cb16e264a79419032dad122e21177d1">local_port</a></td></tr>
|
|
<tr class="memdesc:a0cb16e264a79419032dad122e21177d1"><td class="mdescLeft"> </td><td class="mdescRight">Port number of the local device. <a href="structstruct__iperf__status.html#a0cb16e264a79419032dad122e21177d1">More...</a><br /></td></tr>
|
|
<tr class="separator:a0cb16e264a79419032dad122e21177d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c38f71ee2c913c749348bd36fad4d2a"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__iperf__status.html#a1c38f71ee2c913c749348bd36fad4d2a">bytes_transferred</a></td></tr>
|
|
<tr class="memdesc:a1c38f71ee2c913c749348bd36fad4d2a"><td class="mdescLeft"> </td><td class="mdescRight">The number of bytes of data transferred during the iperf test. <a href="structstruct__iperf__status.html#a1c38f71ee2c913c749348bd36fad4d2a">More...</a><br /></td></tr>
|
|
<tr class="separator:a1c38f71ee2c913c749348bd36fad4d2a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:addc610e21d82be0333733ac5ab26daf1"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__iperf__status.html#addc610e21d82be0333733ac5ab26daf1">duration_ms</a></td></tr>
|
|
<tr class="memdesc:addc610e21d82be0333733ac5ab26daf1"><td class="mdescLeft"> </td><td class="mdescRight">The duration of the iperf test in milliseconds. <a href="structstruct__iperf__status.html#addc610e21d82be0333733ac5ab26daf1">More...</a><br /></td></tr>
|
|
<tr class="separator:addc610e21d82be0333733ac5ab26daf1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9aaf550c13902930ebdfc9a1bb6fd6ea"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__iperf__status.html#a9aaf550c13902930ebdfc9a1bb6fd6ea">bandwidth_kbitpsec</a></td></tr>
|
|
<tr class="memdesc:a9aaf550c13902930ebdfc9a1bb6fd6ea"><td class="mdescLeft"> </td><td class="mdescRight">The average throughput in kbps. <a href="structstruct__iperf__status.html#a9aaf550c13902930ebdfc9a1bb6fd6ea">More...</a><br /></td></tr>
|
|
<tr class="separator:a9aaf550c13902930ebdfc9a1bb6fd6ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a9aaf550c13902930ebdfc9a1bb6fd6ea" name="a9aaf550c13902930ebdfc9a1bb6fd6ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9aaf550c13902930ebdfc9a1bb6fd6ea">◆ </a></span>bandwidth_kbitpsec</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t struct_iperf_status::bandwidth_kbitpsec</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The average throughput in kbps. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00473">473</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1c38f71ee2c913c749348bd36fad4d2a" name="a1c38f71ee2c913c749348bd36fad4d2a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1c38f71ee2c913c749348bd36fad4d2a">◆ </a></span>bytes_transferred</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint64_t struct_iperf_status::bytes_transferred</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The number of bytes of data transferred during the iperf test. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00469">469</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="addc610e21d82be0333733ac5ab26daf1" name="addc610e21d82be0333733ac5ab26daf1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#addc610e21d82be0333733ac5ab26daf1">◆ </a></span>duration_ms</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t struct_iperf_status::duration_ms</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The duration of the iperf test in milliseconds. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00471">471</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab095760373ac70a58308d421a508fddc" name="ab095760373ac70a58308d421a508fddc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab095760373ac70a58308d421a508fddc">◆ </a></span>local_addr</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct <a class="el" href="structstruct__ip__addr.html">struct_ip_addr</a> struct_iperf_status::local_addr</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>IP address of the local device. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00465">465</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0cb16e264a79419032dad122e21177d1" name="a0cb16e264a79419032dad122e21177d1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0cb16e264a79419032dad122e21177d1">◆ </a></span>local_port</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t struct_iperf_status::local_port</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Port number of the local device. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00467">467</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ada18d4c71895e95735cebf6c41784901" name="ada18d4c71895e95735cebf6c41784901"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ada18d4c71895e95735cebf6c41784901">◆ </a></span>remote_addr</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct <a class="el" href="structstruct__ip__addr.html">struct_ip_addr</a> struct_iperf_status::remote_addr</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>IP address of the remote device. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00461">461</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac84c0090db0d4319bbc2bb5ea85fee62" name="ac84c0090db0d4319bbc2bb5ea85fee62"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac84c0090db0d4319bbc2bb5ea85fee62">◆ </a></span>remote_port</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t struct_iperf_status::remote_port</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Port number of the remote device. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00463">463</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.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="structstruct__iperf__status.html">struct_iperf_status</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|