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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/*
* Copyright (c) 2007, Vanderbilt University
* 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 copyright holders 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.
*/
/**
* @author Philip Levis
* @author Miklos Maroti
*
* @see TimeSyncPacket
*/
#include <TinyError.h>
#include <message.h>
#include <AM.h>
interface TimeSyncAMSend<precision_tag, size_type>
{
/**
* This command sends a regular message just like <tt>AMSend.send</tt>, but
* it also performs sender-receiver time synchronization. The <tt>event_time</tt>
* parameter holds the time of some event as expressed in the local clock of
* the sender. The receiver can obtain the time of this event (expressed in its
* own local time) via the <tt>TimeSyncPacket</tt> interface.
*
* @param addr address to which to send the packet
* @param msg the packet
* @param len the length of the data in the packet payload
* @param event_time the synchronization point to be transfered with the message
* @return SUCCESS if the request to send succeeded and a
* sendDone will be signaled later, EBUSY if the
* abstraction cannot send now but will be able to
* later, or FAIL if the communication layer is not
* in a state that can send (e.g., off).
* @see sendDone
*/
command error_t send(am_addr_t addr, message_t* msg, uint8_t len, size_type event_time);
/**
* Cancel a requested transmission. Returns SUCCESS if the
* transmission was canceled properly (not sent in its
* entirety). Note that the component may not know
* if the send was successfully canceled, if the radio is
* handling much of the logic; in this case, a component
* should be conservative and return an appropriate error code.
* A successful call to cancel must always result in a
* sendFailed event, and never a sendSucceeded event.
*
* @param msg the packet whose transmission should be cancelled.
* @return SUCCESS if the transmission was cancelled, FAIL otherwise.
* @see sendDone
*/
command error_t cancel(message_t* msg);
/**
* Signaled in response to an accepted send request. <tt>msg</tt> is
* the message buffer sent, and <tt>error</tt> indicates whether
* the send was successful.
*
* @param msg the packet which was submitted as a send request
* @param error SUCCESS if it was sent successfully, FAIL if it was not,
* ECANCEL if it was cancelled
* @see send
* @see cancel
*/
event void sendDone(message_t* msg, error_t error);
/**
* Return the maximum payload length that this communication layer
* can provide. This command behaves identically to
* <tt>Packet.maxPayloadLength</tt> and is included in this
* interface as a convenience.
*
* @return the maximum payload length
*/
command uint8_t maxPayloadLength();
/**
* Return a pointer to a protocol's payload region in a packet.
* This command behaves identically to <tt>Packet.getPayload</tt>
* (minus the length parameter) and is included in this interface
* as a convenience.
*
* @param msg the packet
* @return the payload of the packet
*/
command void* getPayload(message_t* msg, uint8_t len);
}
|
