diff options
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g.html')
| -rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g.html | 169 |
1 files changed, 169 insertions, 0 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g.html b/ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g.html new file mode 100644 index 0000000..8a4b169 --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g.html @@ -0,0 +1,169 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/> +<title>UNICENS: Routing Management</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link rel="shortcut icon" type="image/x-icon" href="favicon.ico"> +<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="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="style_html.css" rel="stylesheet" type="text/css" /> +<link href="inic.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<div class="GlobalWrapper"> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr> + <td><a href="index.html"><img alt="Logo" src="logo.png"/></a></td> + <td> + <div id="projectname">UNICENS <span id="projectnumber">V2.1.0-3491</span></div> + <div id="projectbrief">User Manual and API Reference</div> + <div id="searchbox"> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> +</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.2 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +</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"> +$(document).ready(function(){initNavTree('group___g___u_c_s___r_o_u_t_i_n_g.html','');}); +</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)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></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="#groups">Topics</a> | +<a href="#nested-classes">Data Structures</a> | +<a href="#typedef-members">Callback Functions</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Routing Management</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Provides service functions to handle connection routes. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> +Topics</h2></td></tr> +<tr class="memitem:group___g___u_c_s___i_r_m"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___i_r_m.html">Extended Resources Management</a></td></tr> +<tr class="memdesc:group___g___u_c_s___i_r_m"><td class="mdescLeft"> </td><td class="mdescRight">Provides data type to manage MOST data resources. <br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group___g___u_c_s___r_o_u_t_i_n_g___t_y_p_e_s"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g___t_y_p_e_s.html">Referred Types</a></td></tr> +<tr class="memdesc:group___g___u_c_s___r_o_u_t_i_n_g___t_y_p_e_s"><td class="mdescLeft"> </td><td class="mdescRight">Referred types used by Routing service functions. <br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Data Structures</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___rm___init_data__t.html">Ucs_Rm_InitData_t</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The initialization structure of the Routing Management. <a href="struct_ucs___rm___init_data__t.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Callback Functions</h2></td></tr> +<tr class="memitem:ga91d851f4665839e2aac982565b007805"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g_ga91d851f4665839e2aac982565b007805.html#ga91d851f4665839e2aac982565b007805">Ucs_Rm_ReportCb_t</a> )(<a class="el" href="struct_ucs___rm___route__t.html">Ucs_Rm_Route_t</a> *route_ptr, <a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g___t_y_p_e_s_ga75ffbf28e4afc99a6abdbff0887baf9b.html#ga75ffbf28e4afc99a6abdbff0887baf9b">Ucs_Rm_RouteInfos_t</a> route_infos, void *user_ptr)</td></tr> +<tr class="memdesc:ga91d851f4665839e2aac982565b007805"><td class="mdescLeft"> </td><td class="mdescRight">Function signature used for the results and reports of the Routing Manager. <a href="#ga91d851f4665839e2aac982565b007805"></a><br/></td></tr> +<tr class="separator:ga91d851f4665839e2aac982565b007805"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaefde5a8fbaeb6e5937e94b9e74ae70cb"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g_gaefde5a8fbaeb6e5937e94b9e74ae70cb.html#gaefde5a8fbaeb6e5937e94b9e74ae70cb">Ucs_Rm_XrmResDebugCb_t</a> )(<a class="el" href="group___g___u_c_s___x_r_m___t_y_p_e_s_gac238d98be8f9df6340eb4ee72de36ccc.html#gac238d98be8f9df6340eb4ee72de36ccc">Ucs_Xrm_ResourceType_t</a> resource_type, <a class="el" href="group___g___u_c_s___x_r_m___t_y_p_e_s_ga74e06fedcde6bc971088b2cb21405173.html#ga74e06fedcde6bc971088b2cb21405173">Ucs_Xrm_ResObject_t</a> *resource_ptr, <a class="el" href="group___g___u_c_s___x_r_m___t_y_p_e_s_ga5299ac232aaeba37eb6fceb53e32b2ea.html#ga5299ac232aaeba37eb6fceb53e32b2ea">Ucs_Xrm_ResourceInfos_t</a> resource_infos, <a class="el" href="struct_ucs___rm___end_point__t.html">Ucs_Rm_EndPoint_t</a> *endpoint_inst_ptr, void *user_ptr)</td></tr> +<tr class="memdesc:gaefde5a8fbaeb6e5937e94b9e74ae70cb"><td class="mdescLeft"> </td><td class="mdescRight">Function signature used for monitoring the XRM resources. <a href="#gaefde5a8fbaeb6e5937e94b9e74ae70cb"></a><br/></td></tr> +<tr class="separator:gaefde5a8fbaeb6e5937e94b9e74ae70cb"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:gaaa23aca8279da197192210fe11889452"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#ga886138f5d13e84ffaa3df5769830e1cd">Ucs_Return_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g_gaaa23aca8279da197192210fe11889452.html#gaaa23aca8279da197192210fe11889452">Ucs_Rm_Start</a> (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *self, <a class="el" href="struct_ucs___rm___route__t.html">Ucs_Rm_Route_t</a> *routes_list, uint16_t list_size)</td></tr> +<tr class="memdesc:gaaa23aca8279da197192210fe11889452"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the routing process with the given routes list information and starts the process to handle the route(s). <a href="#gaaa23aca8279da197192210fe11889452"></a><br/></td></tr> +<tr class="separator:gaaa23aca8279da197192210fe11889452"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabb9185254132bb29ee0af137c36f50b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#ga886138f5d13e84ffaa3df5769830e1cd">Ucs_Return_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g_gabb9185254132bb29ee0af137c36f50b8.html#gabb9185254132bb29ee0af137c36f50b8">Ucs_Rm_SetRouteActive</a> (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *self, <a class="el" href="struct_ucs___rm___route__t.html">Ucs_Rm_Route_t</a> *route_ptr, bool active)</td></tr> +<tr class="memdesc:gabb9185254132bb29ee0af137c36f50b8"><td class="mdescLeft"> </td><td class="mdescRight">Sets the given route to <code>active</code> respectively <code>inactive</code> and triggers the routing process to handle the route. <a href="#gabb9185254132bb29ee0af137c36f50b8"></a><br/></td></tr> +<tr class="separator:gabb9185254132bb29ee0af137c36f50b8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga57ca34a488f06d57f2219be23fa0259f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#ga886138f5d13e84ffaa3df5769830e1cd">Ucs_Return_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g_ga57ca34a488f06d57f2219be23fa0259f.html#ga57ca34a488f06d57f2219be23fa0259f">Ucs_Rm_SetNodeAvailable</a> (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *self, <a class="el" href="struct_ucs___rm___node__t.html">Ucs_Rm_Node_t</a> *node_ptr, bool available)</td></tr> +<tr class="memdesc:ga57ca34a488f06d57f2219be23fa0259f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the availability attribute (<code>available</code> or <code>not</code> <code>available</code>) of the given node and triggers the routing process to handle attached route(s). <a href="#ga57ca34a488f06d57f2219be23fa0259f"></a><br/></td></tr> +<tr class="separator:ga57ca34a488f06d57f2219be23fa0259f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga32d004eb96f434f379614b29fe2a486a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g_ga32d004eb96f434f379614b29fe2a486a.html#ga32d004eb96f434f379614b29fe2a486a">Ucs_Rm_GetNodeAvailable</a> (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *self, <a class="el" href="struct_ucs___rm___node__t.html">Ucs_Rm_Node_t</a> *node_ptr)</td></tr> +<tr class="memdesc:ga32d004eb96f434f379614b29fe2a486a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the <code>"available"</code> flag information of the given node. <a href="#ga32d004eb96f434f379614b29fe2a486a"></a><br/></td></tr> +<tr class="separator:ga32d004eb96f434f379614b29fe2a486a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf34398118f6a683a7e295f2fb89c5940"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#ga886138f5d13e84ffaa3df5769830e1cd">Ucs_Return_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g_gaf34398118f6a683a7e295f2fb89c5940.html#gaf34398118f6a683a7e295f2fb89c5940">Ucs_Rm_GetAttachedRoutes</a> (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *self, <a class="el" href="struct_ucs___rm___end_point__t.html">Ucs_Rm_EndPoint_t</a> *ep_inst, <a class="el" href="struct_ucs___rm___route__t.html">Ucs_Rm_Route_t</a> *ls_found_routes[], uint16_t ls_size)</td></tr> +<tr class="memdesc:gaf34398118f6a683a7e295f2fb89c5940"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the reference(s) of the route(s) currently attached to the given endpoint and stores It into the (external) table provided by user application. <a href="#gaf34398118f6a683a7e295f2fb89c5940"></a><br/></td></tr> +<tr class="separator:gaf34398118f6a683a7e295f2fb89c5940"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga87a46a3aa0657e13f5884e5a04d16e17"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g_ga87a46a3aa0657e13f5884e5a04d16e17.html#ga87a46a3aa0657e13f5884e5a04d16e17">Ucs_Rm_GetConnectionLabel</a> (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *self, <a class="el" href="struct_ucs___rm___route__t.html">Ucs_Rm_Route_t</a> *route_ptr)</td></tr> +<tr class="memdesc:ga87a46a3aa0657e13f5884e5a04d16e17"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the <code>ConnectionLabel</code> of the given route. <a href="#ga87a46a3aa0657e13f5884e5a04d16e17"></a><br/></td></tr> +<tr class="separator:ga87a46a3aa0657e13f5884e5a04d16e17"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>Provides service functions to handle connection routes. </p> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">© 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li> + </ul> +</div> +</body> +<!-- +Generated on Mon Apr 3 2017 13:53:00 for UNICENS by +Doxygen 1.8.2 +--> +<script language="javascript"> +<!-- +$('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>'); +--> +</script> +</html> |