The big interface switchover for Packet, Send, Receive, and AMSend.

[tinyos-2.x.git] / tos / interfaces / Send.nc

diff --git a/tos/interfaces/Send.nc b/tos/interfaces/Send.nc
index 897f1dac3c688e5e3170d7dd051ed4138289ad88..a211460c298a68550af4b06d5bcab4b4f6e6aaef 100644 (file)
--- a/tos/interfaces/Send.nc
+++ b/tos/interfaces/Send.nc
@@ -102,15 +102,15 @@ interface Send {
 
 
    /**
-    * Return a pointer to a protocol's payload region in a packet.
-    * The length of this region is maxPayloadLength(). This command
-    * behaves similarly to <tt>Packet.getPayload</tt> (minus the
-    * length parameter) and is included in this interface
-    * as a convenience.
+    * Return a pointer to a protocol's payload region in a packet which
+    * at least a certain length.  If the payload region is smaller than
+    * the len parameter, then getPayload returns NULL. This command
+    * behaves identicallt to <tt>Packet.getPayload</tt> and is
+    * included in this interface as a convenience.
     *
     * @param   msg    the packet
     * @return         a pointer to the packet's payload
     */
-  command void* getPayload(message_t* msg);
+  command void* getPayload(message_t* msg, uint8_t len);
 
 }