Interface: RouteControl

Control/Monitor interface to a routing component

Author: Phil Buonadonna

Components providing this interface:: tos.lib.Route.MultiHopEngineM
tos.lib.Route.MultiHopLEPSM
tos.lib.Route.MultiHopRouter
tos.lib.TinyDB.NetworkMultiHop

Components requiring this interface:: apps.Surge.SurgeM
tos.lib.Route.MultiHopEngineM
tos.lib.TinyDB.NetworkMultiHopM
tos.lib.TinyDB.TupleRouterM

Commands

uint16_t getParent (void) Get this node's present parent address.
uint8_t getDepth (void) Get this node's depth in the network
uint16_t getSender (TOS_MsgPtr msg) Get the previous hop sender for the given TOS_Msg
uint8_t getOccupancy (void) Return length of the routing forwarding queue
uint8_t getQuality(void) Get a measure of goodness for the current parent

Returns: A value between 0-256 where 256 represent the best goodness
result_t setUpdateInterval (uint16_t Interval) Set the routing componenets internal update interval.
result_t manualUpdate (void) Queue a manual update of the routing state.

uint16_t getParent(void)

Get this node's present parent address.

Returns:

The address of the parent

uint8_t getDepth(void)

Get this node's depth in the network

Returns:

The network depth.

uint16_t getSender(TOS_MsgPtr msg)

Get the previous hop sender for the given TOS_Msg

Parameters:	A - pointer to the TOS_Msg of interest
Returns:	The address of the sender.

uint8_t getOccupancy(void)

Return length of the routing forwarding queue

Returns:

The number of outstanding entries in the queue.

result_t setUpdateInterval(uint16_t Interval)

Set the routing componenets internal update interval.

Parameters:	The - duration, in seconds, of successive routing updates.
Returns:	SUCCESS if the operation succeeded.

result_t manualUpdate(void)

Queue a manual update of the routing state. This may or may not include the transmission of a message.

Returns:

SUCCESS if a route update was queued.