]> oss.titaniummirror.com Git - tinyos-2.x.git/blobdiff - tos/interfaces/Packet.nc
The big interface switchover for Packet, Send, Receive, and AMSend.
[tinyos-2.x.git] / tos / interfaces / Packet.nc
index 14d4e3e642728099044b5c28e01a1bcf5c51c1d4..2e61a5fb1b7cca08d1cbc04bd289c86805a79888 100644 (file)
@@ -95,16 +95,14 @@ interface Packet {
   command uint8_t maxPayloadLength();
 
  /**
-   * Return a pointer to a protocol's payload region in a packet.  If
-   * len is not NULL, getPayload will return the length of the payload
-   * in it, which is the same as the return value from
-   * payloadLength(). If a protocol does not support variable length
-   * packets, then *len is equal to maxPayloadLength().
+   * 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.
    *
    * @param msg   the packet
-   * @param len   pointer to where the current payload length should be stored.
+   * @param len   the length of payload required
    * @return      a pointer to the packet's data payload for this layer
    */
-  command void* getPayload(message_t* msg, uint8_t* len);
+  command void* getPayload(message_t* msg, uint8_t len);
 
 }