Interface: tos.interfaces.RouteControl

interface RouteControl

Control/Monitor interface to a routing component

Author:
Phil Buonadonna

Commands
command uint8_t getDepth() Get this node's depth in the network
command uint8_t getOccupancy() Return length of the routing forwarding queue
command uint16_t getParent() Get this node's present parent address.
command uint8_t getQuality() Get a measure of goodness for the current parent
command uint16_t getSender(TOS_MsgPtr msg) Get the previous hop sender for the given TOS_Msg
command result_t manualUpdate() Queue a manual update of the routing state.
command result_t setUpdateInterval(uint16_t Interval) Set the routing componenets internal update interval.

Commands - Details

getDepth

command uint8_t getDepth()

Get this node's depth in the network

Returns:
The network depth.

getOccupancy

command uint8_t getOccupancy()

Return length of the routing forwarding queue

Returns:
The number of outstanding entries in the queue.

getParent

command uint16_t getParent()

Get this node's present parent address.

Returns:
The address of the parent

getQuality

command uint8_t getQuality()

Get a measure of goodness for the current parent

Returns:
A value between 0-256 where 256 represent the best goodness

getSender

command 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.

manualUpdate

command result_t manualUpdate()

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.

setUpdateInterval

command 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.