Use latest version of conf.d/templates submodule.
[apps/agl-service-unicens.git] / ucs2-lib / doc / html / group___g___u_c_s___n_e_t___t_y_p_e_s.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <title>UNICENS: Referred Types</title>
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link rel="shortcut icon" type="image/x-icon" href="favicon.ico">
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
12 <script type="text/javascript" src="resize.js"></script>
13 <script type="text/javascript" src="navtree.js"></script>
14 <script type="text/javascript">
15   $(document).ready(initResizable);
16 </script>
17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
18 <script type="text/javascript" src="search/search.js"></script>
19 <script type="text/javascript">
20   $(document).ready(function() { searchBox.OnSelectItem(0); });
21 </script>
22 <link href="style_html.css" rel="stylesheet" type="text/css" />
23 <link href="inic.css" rel="stylesheet" type="text/css"/>
24 </head>
25 <body>
26 <div class="GlobalWrapper">
27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
28 <div id="titlearea">
29 <table cellspacing="0" cellpadding="0">
30  <tbody>
31  <tr>
32   <td><a href="index.html"><img alt="Logo" src="logo.png"/></a></td>
33   <td>
34    <div id="projectname">UNICENS&#160;<span id="projectnumber">V2.1.0-3491</span></div>
35    <div id="projectbrief">User Manual and API Reference</div>
36     <div id="searchbox">        <div id="MSearchBox" class="MSearchBoxInactive">
37         <span class="left">
38           <img id="MSearchSelect" src="search/mag_sel.png"
39                onmouseover="return searchBox.OnSearchSelectShow()"
40                onmouseout="return searchBox.OnSearchSelectHide()"
41                alt=""/>
42           <input type="text" id="MSearchField" value="Search" accesskey="S"
43                onfocus="searchBox.OnSearchFieldFocus(true)" 
44                onblur="searchBox.OnSearchFieldFocus(false)" 
45                onkeyup="searchBox.OnSearchFieldChange(event)"/>
46           </span><span class="right">
47             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
48           </span>
49         </div>
50 </div>
51   </td>
52  </tr>
53  </tbody>
54 </table>
55 </div>
56 <!-- end header part -->
57 <!-- Generated by Doxygen 1.8.2 -->
58 <script type="text/javascript">
59 var searchBox = new SearchBox("searchBox", "search",false,'Search');
60 </script>
61 </div><!-- top -->
62 <div id="side-nav" class="ui-resizable side-nav-resizable">
63   <div id="nav-tree">
64     <div id="nav-tree-contents">
65       <div id="nav-sync" class="sync"></div>
66     </div>
67   </div>
68   <div id="splitbar" style="-moz-user-select:none;" 
69        class="ui-resizable-handle">
70   </div>
71 </div>
72 <script type="text/javascript">
73 $(document).ready(function(){initNavTree('group___g___u_c_s___n_e_t___t_y_p_e_s.html','');});
74 </script>
75 <div id="doc-content">
76 <!-- window showing the filter options -->
77 <div id="MSearchSelectWindow"
78      onmouseover="return searchBox.OnSearchSelectShow()"
79      onmouseout="return searchBox.OnSearchSelectHide()"
80      onkeydown="return searchBox.OnSearchSelectKey(event)">
81 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>
82
83 <!-- iframe showing the search results (closed by default) -->
84 <div id="MSearchResultsWindow">
85 <iframe src="javascript:void(0)" frameborder="0" 
86         name="MSearchResults" id="MSearchResults">
87 </iframe>
88 </div>
89
90 <div class="header">
91   <div class="summary">
92 <a href="#nested-classes">Data Structures</a> &#124;
93 <a href="#define-members">Macros</a> &#124;
94 <a href="#enum-members">Enumerations</a>  </div>
95   <div class="headertitle">
96 <div class="title">Referred Types</div>  </div>
97 <div class="ingroups"><a class="el" href="group___g___u_c_s___n_e_t.html">Network</a></div></div><!--header-->
98 <div class="contents">
99
100 <p>Provides network management functions.  
101 <a href="#details">More...</a></p>
102 <table class="memberdecls">
103 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
104 Data Structures</h2></td></tr>
105 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___network___status__t.html">Ucs_Network_Status_t</a></td></tr>
106 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure holds parameters for the notification of the Network Status.  <a href="struct_ucs___network___status__t.html#details">More...</a><br/></td></tr>
107 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
108 </table><table class="memberdecls">
109 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
110 Macros</h2></td></tr>
111 <tr class="memitem:ga5f170c3358fc47999f969ee868d113ef"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga5f170c3358fc47999f969ee868d113ef.html#ga5f170c3358fc47999f969ee868d113ef">UCS_NETWORK_EVENT_NCE</a>&#160;&#160;&#160;0x0001U</td></tr>
112 <tr class="memdesc:ga5f170c3358fc47999f969ee868d113ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bitmask used for network status event "Network Change Event".  <a href="#ga5f170c3358fc47999f969ee868d113ef"></a><br/></td></tr>
113 <tr class="separator:ga5f170c3358fc47999f969ee868d113ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
114 <tr class="memitem:gab6ef28648a40efb679babf0a7a5173e6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gab6ef28648a40efb679babf0a7a5173e6.html#gab6ef28648a40efb679babf0a7a5173e6">UCS_EXC_SIGNATURE_VERSION_LIMIT</a>&#160;&#160;&#160;1U</td></tr>
115 <tr class="memdesc:gab6ef28648a40efb679babf0a7a5173e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signature version limit of EXC commands. Denotes the maximum signature version number the INIC can handle.  <a href="#gab6ef28648a40efb679babf0a7a5173e6"></a><br/></td></tr>
116 <tr class="separator:gab6ef28648a40efb679babf0a7a5173e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
117 </table><table class="memberdecls">
118 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
119 Enumerations</h2></td></tr>
120 <tr class="memitem:ga779e730fce488874146678e0971f52a8"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga779e730fce488874146678e0971f52a8.html#ga779e730fce488874146678e0971f52a8">Ucs_Network_StatusMask_t</a> { <br/>
121 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga779e730fce488874146678e0971f52a8.html#gga779e730fce488874146678e0971f52a8a8ad2af6dd9a9c5358a8b743c1ada77cd">UCS_NW_M_EVENTS</a> = 0x01U, 
122 <br/>
123 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga779e730fce488874146678e0971f52a8.html#gga779e730fce488874146678e0971f52a8a707f78e3b7a58f4ce21f31da38e00573">UCS_NW_M_AVAIL</a> = 0x02U, 
124 <br/>
125 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga779e730fce488874146678e0971f52a8.html#gga779e730fce488874146678e0971f52a8a9c2971b3e618e402a6d5452dc1c30738">UCS_NW_M_AVAIL_INFO</a> = 0x04U, 
126 <br/>
127 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga779e730fce488874146678e0971f52a8.html#gga779e730fce488874146678e0971f52a8af36c80b9128eb740ebfca15dd7c7c6be">UCS_NW_M_AVAIL_TR_CAUSE</a> = 0x08U, 
128 <br/>
129 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga779e730fce488874146678e0971f52a8.html#gga779e730fce488874146678e0971f52a8ab698174c497186f8e738111f6d0a7036">UCS_NW_M_NODE_ADDR</a> = 0x10U, 
130 <br/>
131 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga779e730fce488874146678e0971f52a8.html#gga779e730fce488874146678e0971f52a8a89bb7ec3c55087159a8a19b5e9cc7fa0">UCS_NW_M_NODE_POS</a> = 0x20U, 
132 <br/>
133 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga779e730fce488874146678e0971f52a8.html#gga779e730fce488874146678e0971f52a8a043ec67877e6a38b5a13fb544681b767">UCS_NW_M_MAX_POS</a> = 0x40U, 
134 <br/>
135 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga779e730fce488874146678e0971f52a8.html#gga779e730fce488874146678e0971f52a8aa545cf71946b90b29bcf58581e8b1e2a">UCS_NW_M_PACKET_BW</a> = 0x80U
136 <br/>
137  }</td></tr>
138 <tr class="memdesc:ga779e730fce488874146678e0971f52a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the flags set in <code>change_mask</code> used by NetworkStatus.Status.  <a href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga779e730fce488874146678e0971f52a8.html#ga779e730fce488874146678e0971f52a8">More...</a><br/></td></tr>
139 <tr class="separator:ga779e730fce488874146678e0971f52a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:ga6b0bec2ae9e4d0fb93eefd65752f0c74"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga6b0bec2ae9e4d0fb93eefd65752f0c74.html#ga6b0bec2ae9e4d0fb93eefd65752f0c74">Ucs_Network_Availability_t</a> { <br/>
141 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga6b0bec2ae9e4d0fb93eefd65752f0c74.html#gga6b0bec2ae9e4d0fb93eefd65752f0c74afb1201dc3a998b9d4f9c48d5978d9ffc">UCS_NW_NOT_AVAILABLE</a> = 0x00U, 
142 <br/>
143 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga6b0bec2ae9e4d0fb93eefd65752f0c74.html#gga6b0bec2ae9e4d0fb93eefd65752f0c74a37fb322b410de335478f6bed31cd33f1">UCS_NW_AVAILABLE</a> = 0x01U
144 <br/>
145  }</td></tr>
146 <tr class="memdesc:ga6b0bec2ae9e4d0fb93eefd65752f0c74"><td class="mdescLeft">&#160;</td><td class="mdescRight">MOST Network Availability.  <a href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga6b0bec2ae9e4d0fb93eefd65752f0c74.html#ga6b0bec2ae9e4d0fb93eefd65752f0c74">More...</a><br/></td></tr>
147 <tr class="separator:ga6b0bec2ae9e4d0fb93eefd65752f0c74"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <tr class="memitem:gad5ed0387c3c156602826d50ce94c9df7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gad5ed0387c3c156602826d50ce94c9df7.html#gad5ed0387c3c156602826d50ce94c9df7">Ucs_Network_AvailInfo_t</a> { <br/>
149 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gad5ed0387c3c156602826d50ce94c9df7.html#ggad5ed0387c3c156602826d50ce94c9df7ace556bfc10aa45dcd561a6c75680e99e">UCS_NW_AVAIL_INFO_REGULAR</a> = 0x00U, 
150 <br/>
151 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gad5ed0387c3c156602826d50ce94c9df7.html#ggad5ed0387c3c156602826d50ce94c9df7a754bb411728af7ee41315b2257c9f409">UCS_NW_AVAIL_INFO_DIAGNOSIS</a> = 0x02U, 
152 <br/>
153 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gad5ed0387c3c156602826d50ce94c9df7.html#ggad5ed0387c3c156602826d50ce94c9df7a95e0a195f246b6c474781b42fda0e1cb">UCS_NW_AVAIL_INFO_FORCED_NA</a> = 0x06U, 
154 <br/>
155 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gad5ed0387c3c156602826d50ce94c9df7.html#ggad5ed0387c3c156602826d50ce94c9df7a1e35e06faaf9537517a3b77c172c9e6a">UCS_NW_AVAIL_INFO_UNSTABLE</a> = 0x10U, 
156 <br/>
157 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gad5ed0387c3c156602826d50ce94c9df7.html#ggad5ed0387c3c156602826d50ce94c9df7aac87fccc7041c51b30c04dbd42c963ba">UCS_NW_AVAIL_INFO_STABLE</a> = 0x11U
158 <br/>
159  }</td></tr>
160 <tr class="memdesc:gad5ed0387c3c156602826d50ce94c9df7"><td class="mdescLeft">&#160;</td><td class="mdescRight">MOST Network Availability Information.  <a href="group___g___u_c_s___n_e_t___t_y_p_e_s_gad5ed0387c3c156602826d50ce94c9df7.html#gad5ed0387c3c156602826d50ce94c9df7">More...</a><br/></td></tr>
161 <tr class="separator:gad5ed0387c3c156602826d50ce94c9df7"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="memitem:gab4ec40bf01de998abc4f2ae34c26ac46"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gab4ec40bf01de998abc4f2ae34c26ac46.html#gab4ec40bf01de998abc4f2ae34c26ac46">Ucs_Network_AvailTransCause_t</a> { <br/>
163 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gab4ec40bf01de998abc4f2ae34c26ac46.html#ggab4ec40bf01de998abc4f2ae34c26ac46a69da70cbc0d72fa912330df7d6f95805">UCS_NW_AV_TR_CA_CMD</a> = 0x00U, 
164 <br/>
165 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gab4ec40bf01de998abc4f2ae34c26ac46.html#ggab4ec40bf01de998abc4f2ae34c26ac46a6ac2248030e3550a61f1e296a2e5d735">UCS_NW_AV_TR_CA_RX_ACTIVITY</a> = 0x01U, 
166 <br/>
167 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gab4ec40bf01de998abc4f2ae34c26ac46.html#ggab4ec40bf01de998abc4f2ae34c26ac46a35193eafdb2690c7f1750e7e086528a0">UCS_NW_AV_TR_CA_NORMAL</a> = 0x10U, 
168 <br/>
169 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gab4ec40bf01de998abc4f2ae34c26ac46.html#ggab4ec40bf01de998abc4f2ae34c26ac46a5f2f79813d9cdc51a9b01baedcd115c7">UCS_NW_AV_TR_CA_ERR_SSO</a> = 0x11U, 
170 <br/>
171 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gab4ec40bf01de998abc4f2ae34c26ac46.html#ggab4ec40bf01de998abc4f2ae34c26ac46a26a6a280eb53c98f5bb0cc7f753608c0">UCS_NW_AV_TR_CA_ERR_CRIT_UNLOCK</a> = 0x12U, 
172 <br/>
173 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gab4ec40bf01de998abc4f2ae34c26ac46.html#ggab4ec40bf01de998abc4f2ae34c26ac46a163cc94df0ecbc01a5a0ad28ff0d2275">UCS_NW_AV_TR_CA_ERR_SYSTEM</a> = 0x13U, 
174 <br/>
175 &#160;&#160;<a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gab4ec40bf01de998abc4f2ae34c26ac46.html#ggab4ec40bf01de998abc4f2ae34c26ac46a6b7b5cef497a453a98714f09d4b037be">UCS_NW_AV_TR_CA_NO_TRANSITION</a> = 0xFFU
176 <br/>
177  }</td></tr>
178 <tr class="memdesc:gab4ec40bf01de998abc4f2ae34c26ac46"><td class="mdescLeft">&#160;</td><td class="mdescRight">MOST Network Availability Transition Cause.  <a href="group___g___u_c_s___n_e_t___t_y_p_e_s_gab4ec40bf01de998abc4f2ae34c26ac46.html#gab4ec40bf01de998abc4f2ae34c26ac46">More...</a><br/></td></tr>
179 <tr class="separator:gab4ec40bf01de998abc4f2ae34c26ac46"><td class="memSeparator" colspan="2">&#160;</td></tr>
180 </table>
181 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
182 <p>Provides network management functions. </p>
183 </div><!-- contents -->
184 </div><!-- doc-content -->
185 <!-- start footer part -->
186 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
187   <ul>
188     <li class="footer">&copy; 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li>
189   </ul>
190 </div>
191 </body>
192 <!--
193 Generated on Mon Apr 3 2017 13:52:59 for UNICENS by
194 Doxygen 1.8.2
195 -->
196 <script language="javascript">
197 <!--
198 $('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');
199 -->
200 </script>
201 </html>