/** * This file is part of license combination gpl version 3 license and eCos. * The corresponding license terms are below. * * gpl version 3 Licence: * * The file were developed during the student thesis "Datensammlung in Wireless * Sensor Networks fuer Autonomic Home NetworkingÒ of Thomas Kothmayr and is * included in the dissertation "Secure Data Transmission in Wireless * Sensor Networks" by Corinna Schmitt during employment at the Technische * UniversitŠt MŸnchen, Department Computer Science, Chair Network * Architectures and Services (Germany). * Copyright (C) 2013 * Authors: Thomas Kothmayr and Corinna Schmitt (schmitt[at]net.in.tum.de) * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, version 3 of the License * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * * * eCos Licence: (http://ecos.sourceware.org) * * This file is part of eCos, the Embedded Configurable Operating System. * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, * 2007, 2008, 2009 Free Software Foundation, Inc. * * eCos is free software; you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free * Software Foundation; either version 3 any later version. * * eCos is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * * You should have received a copy of the GNU General Public License along * with eCos; if not, write to the Free Software Foundation, Inc., 51 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * As a special exception, if other files instantiate templates or use * macros or inline functions from this file, or you compile this file and * link it with other works to produce a work based on this file, this file * does not by itself cause the resulting work to be covered by the GNU * General Public License. However the source code for this file must still * be made available in accordance with section (3) of the GNU General * Public License v2. * * This exception does not invalidate any other reasons why a work based on * this file might be covered by the GNU General Public License. * */ Interface: tos.lib.net.ctp.CtpInfo

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.