Interface: tos.lib.net.ctp.CtpInfo

interface CtpInfo

Commands
command error_t getEtx(uint16_t *etx) Get the path quality metric for the current path to the root through the current parent.
command am_addr_t getNeighborAddr(uint8_t neighbor)
command uint16_t getNeighborLinkQuality(uint8_t neighbor)
command uint16_t getNeighborRouteQuality(uint8_t neighbor)
command error_t getParent(am_addr_t *parent) Get the parent of the node in the tree.
command bool isNeighborCongested(am_addr_t n) Returns the currently known state about a neighbor's congestion state
command uint8_t numNeighbors()
command void recomputeRoutes() Tell the routing engine it might want to recompute its routes.
command void setNeighborCongested(am_addr_t n, bool congested) Informs the routing engine that a neighbor is congested
command void triggerImmediateRouteUpdate() This informs the routing engine that sending a beacon as soon as possible is advisable, e.g., due to queue overflow or a detected loop.
command void triggerRouteUpdate() This informs the routing engine that sending a beacon soon is advisable, e.g., in response to a pull bit.

Commands - Details

getEtx

command error_t getEtx(uint16_t *etx)

Get the path quality metric for the current path to the root through the current parent. The pointer is allocated by the caller. If the parent is invalid, return FAIL (no info). The caller MUST NOT use the value in parent if the return is not SUCCESS. Calling getEtx at the root will set the etx argument to 0.

getNeighborAddr

command am_addr_t getNeighborAddr(uint8_t neighbor)

getNeighborLinkQuality

command uint16_t getNeighborLinkQuality(uint8_t neighbor)

getNeighborRouteQuality

command uint16_t getNeighborRouteQuality(uint8_t neighbor)

getParent

command error_t getParent(am_addr_t *parent)

Get the parent of the node in the tree. The pointer is allocated by the caller. If the parent is invalid, return FAIL. The caller MUST NOT use the value in parent if the return is not SUCCESS.

isNeighborCongested

command bool isNeighborCongested(am_addr_t n)

Returns the currently known state about a neighbor's congestion state

numNeighbors

command uint8_t numNeighbors()

recomputeRoutes

command void recomputeRoutes()

Tell the routing engine it might want to recompute its routes.

setNeighborCongested

command void setNeighborCongested(am_addr_t n, bool congested)

Informs the routing engine that a neighbor is congested

triggerImmediateRouteUpdate

command void triggerImmediateRouteUpdate()

This informs the routing engine that sending a beacon as soon as possible is advisable, e.g., due to queue overflow or a detected loop.

triggerRouteUpdate

command void triggerRouteUpdate()

This informs the routing engine that sending a beacon soon is advisable, e.g., in response to a pull bit.