Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / tos / chips / rf2xx / layers / RandomCollisionConfig.nc

diff --git a/tos/chips/rf2xx/layers/RandomCollisionConfig.nc b/tos/chips/rf2xx/layers/RandomCollisionConfig.nc
new file mode 100755 (executable)
index 0000000..b12cc69
--- /dev/null
+++ b/tos/chips/rf2xx/layers/RandomCollisionConfig.nc
@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2007, Vanderbilt University
+ * 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 VANDERBILT UNIVERSITY 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 VANDERBILT
+ * UNIVERSITY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * THE VANDERBILT UNIVERSITY 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 VANDERBILT UNIVERSITY HAS NO OBLIGATION TO
+ * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+ *
+ * Author: Miklos Maroti
+ */
+
+interface RandomCollisionConfig
+{
+       /**
+        * Returns the initial amount of maximum backoff for this message.
+        */
+       async command uint16_t getInitialBackoff(message_t* msg);
+
+       /**
+        * Returns the amount of maximum backoff when there is congestion
+        * (the channel was busy for the first try)
+        */
+       async command uint16_t getCongestionBackoff(message_t* msg);
+
+       /**
+        * Returns the minimum ticks before the message could be sent.
+        */
+       async command uint16_t getMinimumBackoff();
+
+       /**
+        * The provided message was just received, and this command should return 
+        * the time till no transmission should be initiated.
+        */
+       async command uint16_t getTransmitBarrier(message_t* msg);
+}