1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
// $Id: Receive.nc,v 1.8 2010-06-29 22:07:46 scipio Exp $
/*
* Copyright (c) 2004-2005 The Regents of the University of California.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the
* distribution.
* - Neither the name of the University of California nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Copyright (c) 2004 Intel Corporation
* All rights reserved.
*
* This file is distributed under the terms in the attached INTEL-LICENSE
* file. If you do not find these files, copies can be found by writing to
* Intel Research Berkeley, 2150 Shattuck Avenue, Suite 1300, Berkeley, CA,
* 94704. Attention: Intel License Inquiry.
*/
/**
* The basic message reception interface.
*
* @author Philip Levis
* @date November 16, 2004
* @see Packet
* @see Send
* @see TEP 116: Packet Protocols
*/
#include <TinyError.h>
#include <message.h>
interface Receive {
/**
* Receive a packet buffer, returning a buffer for the signaling
* component to use for the next reception. The return value
* can be the same as <tt>msg</tt>, as long as the handling
* component copies out the data it needs.
*
* <b>Note</b> that misuse of this interface is one of the most
* common bugs in TinyOS code. For example, if a component both calls a
* send on the passed message and returns it, then it is possible
* the buffer will be reused before the send occurs, overwriting
* the component's data. This would cause the mote to possibly
* instead send a packet it most recently received.
*
* @param 'message_t* ONE msg' the receied packet
* @param 'void* COUNT(len) payload' a pointer to the packet's payload
* @param len the length of the data region pointed to by payload
* @return 'message_t* ONE' a packet buffer for the stack to use for the next
* received packet.
*/
event message_t* receive(message_t* msg, void* payload, uint8_t len);
}
|
