Interface: tos.interfaces.RouteControl
interface RouteControl
Control/Monitor interface to a routing component
- Author:
-
Phil Buonadonna
Commands
command uint8_t getDepth()
command uint8_t getOccupancy()
command uint16_t getParent()
command uint8_t getQuality()
command uint16_t getSender(TOS_MsgPtr msg)
command result_t manualUpdate()
command result_t setUpdateInterval(uint16_t Interval)
Commands - Details
getDepth
command uint8_t getDepth()
- Returns:
-
The network depth.
getOccupancy
command uint8_t getOccupancy()
- Returns:
-
The number of outstanding entries in the queue.
getParent
command uint16_t getParent()
- Returns:
-
The address of the parent
getQuality
command uint8_t getQuality()
- Returns:
-
A value between 0-256 where 256 represent the best
goodness
getSender
command uint16_t getSender(TOS_MsgPtr msg)
- Parameters:
-
A
- pointer to the TOS_Msg of interest
- Returns:
-
The address of the sender.
manualUpdate
command result_t manualUpdate()
- Returns:
-
SUCCESS if a route update was queued.
setUpdateInterval
command result_t setUpdateInterval(uint16_t Interval)
- Parameters:
-
The
- duration, in seconds, of successive routing
updates.
- Returns:
-
SUCCESS if the operation succeeded.