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_ping_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__ping__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_ping_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 ping results. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00439">439</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:a08eecf62bce1dadc956d69d838990e25"><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__ping__status.html#a08eecf62bce1dadc956d69d838990e25">receiver_addr</a></td></tr>
|
|
<tr class="memdesc:a08eecf62bce1dadc956d69d838990e25"><td class="mdescLeft"> </td><td class="mdescRight">IP address of the device receiving the ping requests. <a href="structstruct__ping__status.html#a08eecf62bce1dadc956d69d838990e25">More...</a><br /></td></tr>
|
|
<tr class="separator:a08eecf62bce1dadc956d69d838990e25"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7030c49b084df5406252798a9f14cd00"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__ping__status.html#a7030c49b084df5406252798a9f14cd00">total_count</a></td></tr>
|
|
<tr class="memdesc:a7030c49b084df5406252798a9f14cd00"><td class="mdescLeft"> </td><td class="mdescRight">Total number of requests sent. <a href="structstruct__ping__status.html#a7030c49b084df5406252798a9f14cd00">More...</a><br /></td></tr>
|
|
<tr class="separator:a7030c49b084df5406252798a9f14cd00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1b9895522c68bcb049eb4b11a3c183a"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__ping__status.html#ad1b9895522c68bcb049eb4b11a3c183a">recv_count</a></td></tr>
|
|
<tr class="memdesc:ad1b9895522c68bcb049eb4b11a3c183a"><td class="mdescLeft"> </td><td class="mdescRight">The number of ping responses received. <a href="structstruct__ping__status.html#ad1b9895522c68bcb049eb4b11a3c183a">More...</a><br /></td></tr>
|
|
<tr class="separator:ad1b9895522c68bcb049eb4b11a3c183a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53c4d5f5efe6e397effa29972b2d1169"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__ping__status.html#a53c4d5f5efe6e397effa29972b2d1169">min_time_ms</a></td></tr>
|
|
<tr class="memdesc:a53c4d5f5efe6e397effa29972b2d1169"><td class="mdescLeft"> </td><td class="mdescRight">The minimum latency in ms between request sent and response received. <a href="structstruct__ping__status.html#a53c4d5f5efe6e397effa29972b2d1169">More...</a><br /></td></tr>
|
|
<tr class="separator:a53c4d5f5efe6e397effa29972b2d1169"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9391646295b6c202a210ff7d5234b373"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__ping__status.html#a9391646295b6c202a210ff7d5234b373">avg_time_ms</a></td></tr>
|
|
<tr class="memdesc:a9391646295b6c202a210ff7d5234b373"><td class="mdescLeft"> </td><td class="mdescRight">The average latency in ms between request sent and response received. <a href="structstruct__ping__status.html#a9391646295b6c202a210ff7d5234b373">More...</a><br /></td></tr>
|
|
<tr class="separator:a9391646295b6c202a210ff7d5234b373"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf699134ad881b685447793f8934205e"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__ping__status.html#adf699134ad881b685447793f8934205e">max_time_ms</a></td></tr>
|
|
<tr class="memdesc:adf699134ad881b685447793f8934205e"><td class="mdescLeft"> </td><td class="mdescRight">The maximum latency in ms between request sent and response received. <a href="structstruct__ping__status.html#adf699134ad881b685447793f8934205e">More...</a><br /></td></tr>
|
|
<tr class="separator:adf699134ad881b685447793f8934205e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8467c6051f1b0c08e4cdc2b2abbb76ce"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__ping__status.html#a8467c6051f1b0c08e4cdc2b2abbb76ce">session_id</a></td></tr>
|
|
<tr class="memdesc:a8467c6051f1b0c08e4cdc2b2abbb76ce"><td class="mdescLeft"> </td><td class="mdescRight">Stores non-zero session ID whilst ping session is running. <a href="structstruct__ping__status.html#a8467c6051f1b0c08e4cdc2b2abbb76ce">More...</a><br /></td></tr>
|
|
<tr class="separator:a8467c6051f1b0c08e4cdc2b2abbb76ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a9391646295b6c202a210ff7d5234b373" name="a9391646295b6c202a210ff7d5234b373"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9391646295b6c202a210ff7d5234b373">◆ </a></span>avg_time_ms</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t struct_ping_status::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="mmagic__controller_8h_source.html#l00450">450</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adf699134ad881b685447793f8934205e" name="adf699134ad881b685447793f8934205e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adf699134ad881b685447793f8934205e">◆ </a></span>max_time_ms</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t struct_ping_status::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="mmagic__controller_8h_source.html#l00452">452</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a53c4d5f5efe6e397effa29972b2d1169" name="a53c4d5f5efe6e397effa29972b2d1169"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a53c4d5f5efe6e397effa29972b2d1169">◆ </a></span>min_time_ms</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t struct_ping_status::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="mmagic__controller_8h_source.html#l00448">448</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a08eecf62bce1dadc956d69d838990e25" name="a08eecf62bce1dadc956d69d838990e25"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a08eecf62bce1dadc956d69d838990e25">◆ </a></span>receiver_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_ping_status::receiver_addr</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>IP address of the device receiving the ping requests. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00442">442</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad1b9895522c68bcb049eb4b11a3c183a" name="ad1b9895522c68bcb049eb4b11a3c183a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad1b9895522c68bcb049eb4b11a3c183a">◆ </a></span>recv_count</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t struct_ping_status::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="mmagic__controller_8h_source.html#l00446">446</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8467c6051f1b0c08e4cdc2b2abbb76ce" name="a8467c6051f1b0c08e4cdc2b2abbb76ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8467c6051f1b0c08e4cdc2b2abbb76ce">◆ </a></span>session_id</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t struct_ping_status::session_id</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Stores non-zero session ID whilst ping session is running. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00454">454</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7030c49b084df5406252798a9f14cd00" name="a7030c49b084df5406252798a9f14cd00"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7030c49b084df5406252798a9f14cd00">◆ </a></span>total_count</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t struct_ping_status::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="mmagic__controller_8h_source.html#l00444">444</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__ping__status.html">struct_ping_status</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|