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_ip_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__ip__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_ip_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 >Structure to contain the current IP status. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00420">420</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:a853ba425fefb062a2b944c8f3ea9f34f"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__MMAGIC__CONTROLLER__DATA__TYPES.html#ga1692061985bc1a94d4a15a880aaeb95f">mmagic_ip_link_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__ip__status.html#a853ba425fefb062a2b944c8f3ea9f34f">link_state</a></td></tr>
|
|
<tr class="memdesc:a853ba425fefb062a2b944c8f3ea9f34f"><td class="mdescLeft"> </td><td class="mdescRight">Current link state. <a href="structstruct__ip__status.html#a853ba425fefb062a2b944c8f3ea9f34f">More...</a><br /></td></tr>
|
|
<tr class="separator:a853ba425fefb062a2b944c8f3ea9f34f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a80065d95c094632b334de3176fa1dd25"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structstruct__ip__status.html#a80065d95c094632b334de3176fa1dd25">dhcp_enabled</a></td></tr>
|
|
<tr class="memdesc:a80065d95c094632b334de3176fa1dd25"><td class="mdescLeft"> </td><td class="mdescRight">Whether or not dhcp is enabled. <a href="structstruct__ip__status.html#a80065d95c094632b334de3176fa1dd25">More...</a><br /></td></tr>
|
|
<tr class="separator:a80065d95c094632b334de3176fa1dd25"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e64c74413fb38a8ff49c4d8e968c0c0"><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__ip__status.html#a4e64c74413fb38a8ff49c4d8e968c0c0">ip_addr</a></td></tr>
|
|
<tr class="memdesc:a4e64c74413fb38a8ff49c4d8e968c0c0"><td class="mdescLeft"> </td><td class="mdescRight">Current IP address. <a href="structstruct__ip__status.html#a4e64c74413fb38a8ff49c4d8e968c0c0">More...</a><br /></td></tr>
|
|
<tr class="separator:a4e64c74413fb38a8ff49c4d8e968c0c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4631a21169958449d81305374292b1d5"><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__ip__status.html#a4631a21169958449d81305374292b1d5">netmask</a></td></tr>
|
|
<tr class="memdesc:a4631a21169958449d81305374292b1d5"><td class="mdescLeft"> </td><td class="mdescRight">Current IP network mask. <a href="structstruct__ip__status.html#a4631a21169958449d81305374292b1d5">More...</a><br /></td></tr>
|
|
<tr class="separator:a4631a21169958449d81305374292b1d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89f4848895dfc72817fbbaecfcd1141b"><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__ip__status.html#a89f4848895dfc72817fbbaecfcd1141b">gateway</a></td></tr>
|
|
<tr class="memdesc:a89f4848895dfc72817fbbaecfcd1141b"><td class="mdescLeft"> </td><td class="mdescRight">Current IP gateway. <a href="structstruct__ip__status.html#a89f4848895dfc72817fbbaecfcd1141b">More...</a><br /></td></tr>
|
|
<tr class="separator:a89f4848895dfc72817fbbaecfcd1141b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a040324259da7652fe44771f0f0f81878"><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__ip__status.html#a040324259da7652fe44771f0f0f81878">broadcast</a></td></tr>
|
|
<tr class="memdesc:a040324259da7652fe44771f0f0f81878"><td class="mdescLeft"> </td><td class="mdescRight">Current broadcast IP address. <a href="structstruct__ip__status.html#a040324259da7652fe44771f0f0f81878">More...</a><br /></td></tr>
|
|
<tr class="separator:a040324259da7652fe44771f0f0f81878"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1115f8776039e587f43b193c92ad6a9b"><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__ip__status.html#a1115f8776039e587f43b193c92ad6a9b">dns_servers</a> [2]</td></tr>
|
|
<tr class="memdesc:a1115f8776039e587f43b193c92ad6a9b"><td class="mdescLeft"> </td><td class="mdescRight">DNS server IP addresses. <a href="structstruct__ip__status.html#a1115f8776039e587f43b193c92ad6a9b">More...</a><br /></td></tr>
|
|
<tr class="separator:a1115f8776039e587f43b193c92ad6a9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a040324259da7652fe44771f0f0f81878" name="a040324259da7652fe44771f0f0f81878"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a040324259da7652fe44771f0f0f81878">◆ </a></span>broadcast</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_ip_status::broadcast</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Current broadcast IP address. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00433">433</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a80065d95c094632b334de3176fa1dd25" name="a80065d95c094632b334de3176fa1dd25"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a80065d95c094632b334de3176fa1dd25">◆ </a></span>dhcp_enabled</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool struct_ip_status::dhcp_enabled</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Whether or not dhcp is enabled. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00425">425</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1115f8776039e587f43b193c92ad6a9b" name="a1115f8776039e587f43b193c92ad6a9b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1115f8776039e587f43b193c92ad6a9b">◆ </a></span>dns_servers</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_ip_status::dns_servers[2]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>DNS server IP addresses. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00435">435</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a89f4848895dfc72817fbbaecfcd1141b" name="a89f4848895dfc72817fbbaecfcd1141b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a89f4848895dfc72817fbbaecfcd1141b">◆ </a></span>gateway</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_ip_status::gateway</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Current IP gateway. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00431">431</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4e64c74413fb38a8ff49c4d8e968c0c0" name="a4e64c74413fb38a8ff49c4d8e968c0c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e64c74413fb38a8ff49c4d8e968c0c0">◆ </a></span>ip_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_ip_status::ip_addr</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Current IP address. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00427">427</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a853ba425fefb062a2b944c8f3ea9f34f" name="a853ba425fefb062a2b944c8f3ea9f34f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a853ba425fefb062a2b944c8f3ea9f34f">◆ </a></span>link_state</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__MMAGIC__CONTROLLER__DATA__TYPES.html#ga1692061985bc1a94d4a15a880aaeb95f">mmagic_ip_link_state</a> struct_ip_status::link_state</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Current link state. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00423">423</a> of file <a class="el" href="mmagic__controller_8h_source.html">mmagic_controller.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4631a21169958449d81305374292b1d5" name="a4631a21169958449d81305374292b1d5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4631a21169958449d81305374292b1d5">◆ </a></span>netmask</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_ip_status::netmask</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Current IP network mask. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic__controller_8h_source.html#l00429">429</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__ip__status.html">struct_ip_status</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|