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.
230 lines
13 KiB
HTML
230 lines
13 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_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('structmmping__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">mmping_args 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 >Ping request arguments data structure. </p>
|
|
<p >For forward compatibility this structure should be initialized using <code>MMPING_ARGS_DEFAULT</code>. For example:</p>
|
|
<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structmmping__args.html">mmping_args</a> args = <a class="code hl_define" href="group__MMPING.html#gacd81e1f6fad2ac9ee8fcecb82e590437">MMPING_ARGS_DEFAULT</a>;</div>
|
|
<div class="ttc" id="agroup__MMPING_html_gacd81e1f6fad2ac9ee8fcecb82e590437"><div class="ttname"><a href="group__MMPING.html#gacd81e1f6fad2ac9ee8fcecb82e590437">MMPING_ARGS_DEFAULT</a></div><div class="ttdeci">#define MMPING_ARGS_DEFAULT</div><div class="ttdoc">Initializer for mmping_args.</div><div class="ttdef"><b>Definition:</b> <a href="mmping_8h_source.html#l00095">mmping.h:95</a></div></div>
|
|
<div class="ttc" id="astructmmping__args_html"><div class="ttname"><a href="structmmping__args.html">mmping_args</a></div><div class="ttdoc">Ping request arguments data structure.</div><div class="ttdef"><b>Definition:</b> <a href="mmping_8h_source.html#l00076">mmping.h:77</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00076">76</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:ab50667bc56685a22ed7d8fb893049736"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmping__args.html#ab50667bc56685a22ed7d8fb893049736">ping_src</a> [<a class="el" href="group__MMPING.html#ga3172770a93cb8d1efe18b8481e5a3426">MMPING_IPADDR_MAXLEN</a>]</td></tr>
|
|
<tr class="memdesc:ab50667bc56685a22ed7d8fb893049736"><td class="mdescLeft"> </td><td class="mdescRight">String representation of the local IP address. <a href="structmmping__args.html#ab50667bc56685a22ed7d8fb893049736">More...</a><br /></td></tr>
|
|
<tr class="separator:ab50667bc56685a22ed7d8fb893049736"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd2723c539cf8520289525bbb56161c4"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmping__args.html#acd2723c539cf8520289525bbb56161c4">ping_target</a> [<a class="el" href="group__MMPING.html#ga3172770a93cb8d1efe18b8481e5a3426">MMPING_IPADDR_MAXLEN</a>]</td></tr>
|
|
<tr class="memdesc:acd2723c539cf8520289525bbb56161c4"><td class="mdescLeft"> </td><td class="mdescRight">String representation of the IP address of the ping target. <a href="structmmping__args.html#acd2723c539cf8520289525bbb56161c4">More...</a><br /></td></tr>
|
|
<tr class="separator:acd2723c539cf8520289525bbb56161c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad4dabb0a4f7279dc8e1620d241b7cd9e"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmping__args.html#ad4dabb0a4f7279dc8e1620d241b7cd9e">ping_interval_ms</a></td></tr>
|
|
<tr class="memdesc:ad4dabb0a4f7279dc8e1620d241b7cd9e"><td class="mdescLeft"> </td><td class="mdescRight">The time interval between ping requests (in milliseconds) <a href="structmmping__args.html#ad4dabb0a4f7279dc8e1620d241b7cd9e">More...</a><br /></td></tr>
|
|
<tr class="separator:ad4dabb0a4f7279dc8e1620d241b7cd9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff914d57288480b4de96de2483c48de3"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmping__args.html#aff914d57288480b4de96de2483c48de3">ping_count</a></td></tr>
|
|
<tr class="memdesc:aff914d57288480b4de96de2483c48de3"><td class="mdescLeft"> </td><td class="mdescRight">This specifies the number of ping requests to send before terminating the session. <a href="structmmping__args.html#aff914d57288480b4de96de2483c48de3">More...</a><br /></td></tr>
|
|
<tr class="separator:aff914d57288480b4de96de2483c48de3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a6c6f839b800682ca33696e4ddca195"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmping__args.html#a1a6c6f839b800682ca33696e4ddca195">ping_size</a></td></tr>
|
|
<tr class="memdesc:a1a6c6f839b800682ca33696e4ddca195"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the data packet size in bytes excluding 8 bytes ICMP header. <a href="structmmping__args.html#a1a6c6f839b800682ca33696e4ddca195">More...</a><br /></td></tr>
|
|
<tr class="separator:a1a6c6f839b800682ca33696e4ddca195"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="aff914d57288480b4de96de2483c48de3" name="aff914d57288480b4de96de2483c48de3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff914d57288480b4de96de2483c48de3">◆ </a></span>ping_count</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmping_args::ping_count</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This specifies the number of ping requests to send before terminating the session. </p>
|
|
<p >If this is zero or exceeds <a class="el" href="group__MMPING.html#ga254e66798de6a997c858735bd6e28fd7">MMPING_MAX_COUNT</a> then it it will be set to <a class="el" href="group__MMPING.html#ga254e66798de6a997c858735bd6e28fd7">MMPING_MAX_COUNT</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00089">89</a> of file <a class="el" href="mmping_8h_source.html">mmping.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad4dabb0a4f7279dc8e1620d241b7cd9e" name="ad4dabb0a4f7279dc8e1620d241b7cd9e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad4dabb0a4f7279dc8e1620d241b7cd9e">◆ </a></span>ping_interval_ms</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmping_args::ping_interval_ms</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The time interval between ping requests (in milliseconds) </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00083">83</a> of file <a class="el" href="mmping_8h_source.html">mmping.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1a6c6f839b800682ca33696e4ddca195" name="a1a6c6f839b800682ca33696e4ddca195"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1a6c6f839b800682ca33696e4ddca195">◆ </a></span>ping_size</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmping_args::ping_size</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Specifies the data packet size in bytes excluding 8 bytes ICMP header. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00091">91</a> of file <a class="el" href="mmping_8h_source.html">mmping.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab50667bc56685a22ed7d8fb893049736" name="ab50667bc56685a22ed7d8fb893049736"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab50667bc56685a22ed7d8fb893049736">◆ </a></span>ping_src</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char mmping_args::ping_src[<a class="el" href="group__MMPING.html#ga3172770a93cb8d1efe18b8481e5a3426">MMPING_IPADDR_MAXLEN</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>String representation of the local IP address. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00079">79</a> of file <a class="el" href="mmping_8h_source.html">mmping.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acd2723c539cf8520289525bbb56161c4" name="acd2723c539cf8520289525bbb56161c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acd2723c539cf8520289525bbb56161c4">◆ </a></span>ping_target</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char mmping_args::ping_target[<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 target. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmping_8h_source.html#l00081">81</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__args.html">mmping_args</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|