ucs2-lib/doc/html/group___g___u_c_s___m_g_r.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: Manager</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___m_g_r.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="#typedef-members">Callback Functions</a> &#124;
  94 <a href="#enum-members">Enumerations</a>  </div>
  95   <div class="headertitle">
  96 <div class="title">Manager</div>  </div>
  97 </div><!--header-->
  98 <div class="contents">
  99
 100 <p>The Manager is responsible to force the network to available and handle NodeDiscovery and RoutingManagement by a default logic.
 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___mgr___init_data__t.html">Ucs_Mgr_InitData_t</a></td></tr>
 106 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The initialization data of the Manager.  <a href="struct_ucs___mgr___init_data__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="typedef-members"></a>
 110 Callback Functions</h2></td></tr>
 111 <tr class="memitem:gad54678ad2a4671ec224422a8647b20f6"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___m_g_r_gad54678ad2a4671ec224422a8647b20f6.html#gad54678ad2a4671ec224422a8647b20f6">Ucs_MgrReportCb_t</a> )(<a class="el" href="group___g___u_c_s___m_g_r_gab85aa9ce377050505124af5e9549e445.html#gab85aa9ce377050505124af5e9549e445">Ucs_MgrReport_t</a> code, uint16_t node_address, <a class="el" href="struct_ucs___rm___node__t.html">Ucs_Rm_Node_t</a> *node_ptr, void *user_ptr)</td></tr>
 112 <tr class="memdesc:gad54678ad2a4671ec224422a8647b20f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional callback function that reports events on ignored, welcomed and lost nodes.  <a href="#gad54678ad2a4671ec224422a8647b20f6"></a><br/></td></tr>
 113 <tr class="separator:gad54678ad2a4671ec224422a8647b20f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 114 </table><table class="memberdecls">
 115 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
 116 Enumerations</h2></td></tr>
 117 <tr class="memitem:gab85aa9ce377050505124af5e9549e445"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___m_g_r_gab85aa9ce377050505124af5e9549e445.html#gab85aa9ce377050505124af5e9549e445">Ucs_MgrReport_t</a> { <br/>
 118 &#160;&#160;<a class="el" href="group___g___u_c_s___m_g_r_gab85aa9ce377050505124af5e9549e445.html#ggab85aa9ce377050505124af5e9549e445a6fcfe54d64bd8cf6b24361bf326f6c49">UCS_MGR_REP_IGNORED_UNKNOWN</a> = 0,
 119 <br/>
 120 &#160;&#160;<a class="el" href="group___g___u_c_s___m_g_r_gab85aa9ce377050505124af5e9549e445.html#ggab85aa9ce377050505124af5e9549e445afe4f1822be465b7a8891dccf0af36945">UCS_MGR_REP_IGNORED_DUPLICATE</a> = 1,
 121 <br/>
 122 &#160;&#160;<a class="el" href="group___g___u_c_s___m_g_r_gab85aa9ce377050505124af5e9549e445.html#ggab85aa9ce377050505124af5e9549e445ac7d7f8d978224660f4c6b94f2651d19e">UCS_MGR_REP_AVAILABLE</a> = 2,
 123 <br/>
 124 &#160;&#160;<a class="el" href="group___g___u_c_s___m_g_r_gab85aa9ce377050505124af5e9549e445.html#ggab85aa9ce377050505124af5e9549e445a8c94fd8dfa39ea4a65b30a9ebfb5a38b">UCS_MGR_REP_NOT_AVAILABLE</a> = 3
 125 <br/>
 126  }</td></tr>
 127 <tr class="memdesc:gab85aa9ce377050505124af5e9549e445"><td class="mdescLeft">&#160;</td><td class="mdescRight">Manager report codes.  <a href="group___g___u_c_s___m_g_r_gab85aa9ce377050505124af5e9549e445.html#gab85aa9ce377050505124af5e9549e445">More...</a><br/></td></tr>
 128 <tr class="separator:gab85aa9ce377050505124af5e9549e445"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 </table>
 130 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 131 <p>The Manager is responsible to force the network to available and handle NodeDiscovery and RoutingManagement by a default logic. </p>
 132 </div><!-- contents -->
 133 </div><!-- doc-content -->
 134 <!-- start footer part -->
 135 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 136   <ul>
 137     <li class="footer">&copy; 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li>
 138   </ul>
 139 </div>
 140 </body>
 141 <!--
 142 Generated on Mon Apr 3 2017 13:53:00 for UNICENS by
 143 Doxygen 1.8.2
 144 -->
 145 <script language="javascript">
 146 <!--
 147 $('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');
 148 -->
 149 </script>
 150 </html>