Updated files.

[tinyos-2.x.git] / tos / lib / net / ctp / CtpInfo.nc

diff --git a/tos/lib/net/ctp/CtpInfo.nc b/tos/lib/net/ctp/CtpInfo.nc
new file mode 100644 (file)
index 0000000..57c275e
--- /dev/null
+++ b/tos/lib/net/ctp/CtpInfo.nc
@@ -0,0 +1,86 @@
+/* $Id$ */
+/*
+ * "Copyright (c) 2005 The Regents of the University  of California.  
+ * All rights reserved.
+ *
+ * Permission to use, copy, modify, and distribute this software and its
+ * documentation for any purpose, without fee, and without written agreement is
+ * hereby granted, provided that the above copyright notice, the following
+ * two paragraphs and the author appear in all copies of this software.
+ * 
+ * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
+ * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
+ * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
+ * CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
+ * ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
+ * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
+ *
+ */
+
+/*
+ *  @author Rodrigo Fonseca
+ *  @author Philip Levis
+ *  @date   $Date$
+ *  @see Net2-WG
+ */
+
+
+interface CtpInfo {
+
+  /**
+   * 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.
+   */
+  
+  command error_t getParent(am_addr_t* parent);
+  
+  /**
+   * 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.
+   */
+  
+  command error_t getEtx(uint16_t* etx);
+
+  /**
+   * This informs the routing engine that sending a beacon soon is
+   * advisable, e.g., in response to a pull bit.
+   */
+  
+  command void triggerRouteUpdate();
+
+  /**
+   * 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 triggerImmediateRouteUpdate();
+
+  /** 
+   * Tell the routing engine it might want to recompute its routes.
+   */
+  command void recomputeRoutes();
+
+  /**
+   * Informs the routing engine that a neighbor is congested
+   */
+  command void setNeighborCongested(am_addr_t n, bool congested);
+
+  /**
+   *  Returns the currently known state about a neighbor's congestion state
+   */
+  command bool isNeighborCongested(am_addr_t n);
+
+  command uint8_t numNeighbors();
+  command uint16_t getNeighborLinkQuality(uint8_t neighbor);
+  command uint16_t getNeighborRouteQuality(uint8_t neighbor);
+  command am_addr_t getNeighborAddr(uint8_t neighbor);
+}