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
14 KiB
HTML
267 lines
14 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: mmping_stats 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('structmmping__stats.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">mmping_stats Struct Reference<div class="ingroups"><a class="el" href="group__MMAPP.html">Application Layer Protocol APIs</a> » <a class="el" href="group__MMPING.html">Morse Micro Ping</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 ping results. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00104">104</a> of file <a class="el" href="mmping_8h_source.html">mmping.h</a>.</p>
|
|
</div>
|
|
<p><code>#include <<a class="el" href="mmping_8h_source.html">mmping.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:a94e7885b3ae5b0af01b6100ad83552b2"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmping__stats.html#a94e7885b3ae5b0af01b6100ad83552b2">ping_receiver</a> [<a class="el" href="group__MMPING.html#ga3172770a93cb8d1efe18b8481e5a3426">MMPING_IPADDR_MAXLEN</a>]</td></tr>
|
|
<tr class="memdesc:a94e7885b3ae5b0af01b6100ad83552b2"><td class="mdescLeft"> </td><td class="mdescRight">String representation of the IP address of the ping receiver. <a href="structmmping__stats.html#a94e7885b3ae5b0af01b6100ad83552b2">More...</a><br /></td></tr>
|
|
<tr class="separator:a94e7885b3ae5b0af01b6100ad83552b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac0e9f186176040005e9e20587804ae9"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmping__stats.html#aac0e9f186176040005e9e20587804ae9">ping_total_count</a></td></tr>
|
|
<tr class="memdesc:aac0e9f186176040005e9e20587804ae9"><td class="mdescLeft"> </td><td class="mdescRight">Total number of requests sent. <a href="structmmping__stats.html#aac0e9f186176040005e9e20587804ae9">More...</a><br /></td></tr>
|
|
<tr class="separator:aac0e9f186176040005e9e20587804ae9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99f43c99407e8f484a4c0f07d7067f27"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmping__stats.html#a99f43c99407e8f484a4c0f07d7067f27">ping_recv_count</a></td></tr>
|
|
<tr class="memdesc:a99f43c99407e8f484a4c0f07d7067f27"><td class="mdescLeft"> </td><td class="mdescRight">The number of ping responses received. <a href="structmmping__stats.html#a99f43c99407e8f484a4c0f07d7067f27">More...</a><br /></td></tr>
|
|
<tr class="separator:a99f43c99407e8f484a4c0f07d7067f27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a220dba7086369431ff399d85067b0c10"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmping__stats.html#a220dba7086369431ff399d85067b0c10">ping_min_time_ms</a></td></tr>
|
|
<tr class="memdesc:a220dba7086369431ff399d85067b0c10"><td class="mdescLeft"> </td><td class="mdescRight">The minimum latency in ms between request sent and response received. <a href="structmmping__stats.html#a220dba7086369431ff399d85067b0c10">More...</a><br /></td></tr>
|
|
<tr class="separator:a220dba7086369431ff399d85067b0c10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0797b21e379629d9c358c78a76dfb939"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmping__stats.html#a0797b21e379629d9c358c78a76dfb939">ping_avg_time_ms</a></td></tr>
|
|
<tr class="memdesc:a0797b21e379629d9c358c78a76dfb939"><td class="mdescLeft"> </td><td class="mdescRight">The average latency in ms between request sent and response received. <a href="structmmping__stats.html#a0797b21e379629d9c358c78a76dfb939">More...</a><br /></td></tr>
|
|
<tr class="separator:a0797b21e379629d9c358c78a76dfb939"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82cfd7e01e5031020d254ca4ed35c885"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmping__stats.html#a82cfd7e01e5031020d254ca4ed35c885">ping_max_time_ms</a></td></tr>
|
|
<tr class="memdesc:a82cfd7e01e5031020d254ca4ed35c885"><td class="mdescLeft"> </td><td class="mdescRight">The maximum latency in ms between request sent and response received. <a href="structmmping__stats.html#a82cfd7e01e5031020d254ca4ed35c885">More...</a><br /></td></tr>
|
|
<tr class="separator:a82cfd7e01e5031020d254ca4ed35c885"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a193d5696c875124b580b520cba8a5e06"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmping__stats.html#a193d5696c875124b580b520cba8a5e06">ping_is_running</a></td></tr>
|
|
<tr class="memdesc:a193d5696c875124b580b520cba8a5e06"><td class="mdescLeft"> </td><td class="mdescRight">Stores the ping running status. <a href="structmmping__stats.html#a193d5696c875124b580b520cba8a5e06">More...</a><br /></td></tr>
|
|
<tr class="separator:a193d5696c875124b580b520cba8a5e06"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a0797b21e379629d9c358c78a76dfb939" name="a0797b21e379629d9c358c78a76dfb939"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0797b21e379629d9c358c78a76dfb939">◆ </a></span>ping_avg_time_ms</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmping_stats::ping_avg_time_ms</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The average latency in ms between request sent and response received. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00115">115</a> of file <a class="el" href="mmping_8h_source.html">mmping.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a193d5696c875124b580b520cba8a5e06" name="a193d5696c875124b580b520cba8a5e06"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a193d5696c875124b580b520cba8a5e06">◆ </a></span>ping_is_running</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool mmping_stats::ping_is_running</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Stores the ping running status. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00119">119</a> of file <a class="el" href="mmping_8h_source.html">mmping.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a82cfd7e01e5031020d254ca4ed35c885" name="a82cfd7e01e5031020d254ca4ed35c885"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a82cfd7e01e5031020d254ca4ed35c885">◆ </a></span>ping_max_time_ms</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmping_stats::ping_max_time_ms</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The maximum latency in ms between request sent and response received. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00117">117</a> of file <a class="el" href="mmping_8h_source.html">mmping.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a220dba7086369431ff399d85067b0c10" name="a220dba7086369431ff399d85067b0c10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a220dba7086369431ff399d85067b0c10">◆ </a></span>ping_min_time_ms</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmping_stats::ping_min_time_ms</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The minimum latency in ms between request sent and response received. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00113">113</a> of file <a class="el" href="mmping_8h_source.html">mmping.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a94e7885b3ae5b0af01b6100ad83552b2" name="a94e7885b3ae5b0af01b6100ad83552b2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a94e7885b3ae5b0af01b6100ad83552b2">◆ </a></span>ping_receiver</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char mmping_stats::ping_receiver[<a class="el" href="group__MMPING.html#ga3172770a93cb8d1efe18b8481e5a3426">MMPING_IPADDR_MAXLEN</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>String representation of the IP address of the ping receiver. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00107">107</a> of file <a class="el" href="mmping_8h_source.html">mmping.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a99f43c99407e8f484a4c0f07d7067f27" name="a99f43c99407e8f484a4c0f07d7067f27"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99f43c99407e8f484a4c0f07d7067f27">◆ </a></span>ping_recv_count</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmping_stats::ping_recv_count</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The number of ping responses received. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00111">111</a> of file <a class="el" href="mmping_8h_source.html">mmping.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac0e9f186176040005e9e20587804ae9" name="aac0e9f186176040005e9e20587804ae9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac0e9f186176040005e9e20587804ae9">◆ </a></span>ping_total_count</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmping_stats::ping_total_count</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Total number of requests sent. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00109">109</a> of file <a class="el" href="mmping_8h_source.html">mmping.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="mmping_8h_source.html">mmping.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="structmmping__stats.html">mmping_stats</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|