📄 tos.interfaces.routecontrol.nc.html
字号:
<html><head><title>Interface: RouteControl</title></head><body><table BORDER="0" CELLPADDING="3" CELLSPACING="0" width="100%"><tr><td><font size="-1"><b><font color="blue"><a href="apps_p.html">Apps</a></font></b> <b><a href="components_p.html">Components</a></b> <b><a href="interfaces_p.html">Interfaces</a></b> <b><a href="allfiles_p.html">All Files</a></b> <b><a href="index.html">Source Tree</a></b> </font></td><td align="right"><font size="-1">source: <b><a href="tos.interfaces.RouteControl.nc.source">tos.interfaces.RouteControl.nc</a></b></font></td></tr></table><hr><h1 align="center">Interface: RouteControl</h1><p> Control/Monitor interface to a routing component <table border="0" cellpadding="0"><tr valign="top"><td><b>Author:</b><td> Phil Buonadonna </td></tr></table><p><dl><dt>Components providing this interface:<dd> <a href="apps.last.MultihopM.nc.html">apps.last.MultihopM</a><br> <a href="apps.newtopo.MultihopM.nc.html">apps.newtopo.MultihopM</a><br> <a href="apps.topo.MultihopM.nc.html">apps.topo.MultihopM</a><br> <a href="tos.lib.Route.MultiHopEngineM.nc.html">tos.lib.Route.MultiHopEngineM</a><br> <a href="tos.lib.Route.MultiHopLEPSM.nc.html">tos.lib.Route.MultiHopLEPSM</a><br> <a href="tos.lib.Route.MultiHopRouter.nc.html">tos.lib.Route.MultiHopRouter</a><br></dl><p><dl><dt>Components requiring this interface:<dd> <a href="apps.surge.SurgeM.nc.html">apps.surge.SurgeM</a><br> <a href="tos.lib.Route.MultiHopEngineM.nc.html">tos.lib.Route.MultiHopEngineM</a><br></dl><p><table BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><tr BGCOLOR="#CCCCFF"><td><h3>Commands</h3></td></tr></table><ul><li> uint16_t <a href="# uint16_t getParent(void)"><b>getParent</b> </a>(void)<menu> Get this node's present parent address. </menu><p><li> uint8_t <a href="# uint8_t getDepth(void)"><b>getDepth</b> </a>(void)<menu> Get this node's depth in the network </menu><p><li> uint16_t <a href="# uint16_t getSender(TOS_MsgPtr msg)"><b>getSender</b> </a>(TOS_MsgPtr msg)<menu> Get the previous hop sender for the given TOS_Msg</menu><p><li> uint8_t <a href="# uint8_t getOccupancy(void)"><b>getOccupancy</b> </a>(void)<menu> Return length of the routing forwarding queue </menu><p><li> uint8_t <b>getQuality</b>(void)<menu> Get a measure of goodness for the current parent <table border="0" cellpadding="0"><tr valign="top"><td><b>Returns:</b></td><td> A value between 0-256 where 256 represent the best goodness</td></tr></table></menu><p><li> result_t <a href="# result_t setUpdateInterval(uint16_t Interval)"><b>setUpdateInterval</b> </a>(uint16_t Interval)<menu> Set the routing componenets internal update interval.</menu><p><li> result_t <a href="# result_t manualUpdate(void)"><b>manualUpdate</b> </a>(void)<menu> Queue a manual update of the routing state. </menu><p></ul><table BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><tr BGCOLOR="#CCCCFF"><td><h3>Commands - Details</h3></td></tr></table> <a name=" uint16_t getParent(void)"></a> <h4>getParent</h4> uint16_t <b>getParent</b>(void)<P><menu> Get this node's present parent address. <table border="0" cellpadding="0"><tr valign="top"><td><b>Returns:</b></td><td> The address of the parent</td></tr></table></menu><hr> <a name=" uint8_t getDepth(void)"></a> <h4>getDepth</h4> uint8_t <b>getDepth</b>(void)<P><menu> Get this node's depth in the network <table border="0" cellpadding="0"><tr valign="top"><td><b>Returns:</b></td><td> The network depth.</td></tr></table></menu><hr> <a name=" uint16_t getSender(TOS_MsgPtr msg)"></a> <h4>getSender</h4> uint16_t <b>getSender</b>(TOS_MsgPtr msg)<P><menu> Get the previous hop sender for the given TOS_Msg <table border="0" cellpadding="0"></td></tr><tr valign="top"><td><br><b>Parameters:</b></td><td><menu><p STYLE="text-indent: -1cm"><b>A</b> - pointer to the TOS_Msg of interest </menu></td></tr><tr valign="top"><td><b>Returns:</b></td><td> The address of the sender.</td></tr></table></menu><hr> <a name=" uint8_t getOccupancy(void)"></a> <h4>getOccupancy</h4> uint8_t <b>getOccupancy</b>(void)<P><menu> Return length of the routing forwarding queue <table border="0" cellpadding="0"><tr valign="top"><td><b>Returns:</b></td><td> The number of outstanding entries in the queue.</td></tr></table></menu><hr> <a name=" result_t setUpdateInterval(uint16_t Interval)"></a> <h4>setUpdateInterval</h4> result_t <b>setUpdateInterval</b>(uint16_t Interval)<P><menu> Set the routing componenets internal update interval. <table border="0" cellpadding="0"></td></tr><tr valign="top"><td><br><b>Parameters:</b></td><td><menu><p STYLE="text-indent: -1cm"><b>The</b> - duration, in seconds, of successive routing updates. </menu></td></tr><tr valign="top"><td><b>Returns:</b></td><td> SUCCESS if the operation succeeded.</td></tr></table></menu><hr> <a name=" result_t manualUpdate(void)"></a> <h4>manualUpdate</h4> result_t <b>manualUpdate</b>(void)<P><menu> Queue a manual update of the routing state. This may or may not include the transmission of a message. <table border="0" cellpadding="0"><tr valign="top"><td><b>Returns:</b></td><td> SUCCESS if a route update was queued.</td></tr></table></menu>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -