/** * This file is part of license combination gpl version 3 license and eCos. * The corresponding license terms are below. * * gpl version 3 Licence: * * The file were developed during the student thesis "Datensammlung in Wireless * Sensor Networks fuer Autonomic Home NetworkingÒ of Thomas Kothmayr and is * included in the dissertation "Secure Data Transmission in Wireless * Sensor Networks" by Corinna Schmitt during employment at the Technische * UniversitŠt MŸnchen, Department Computer Science, Chair Network * Architectures and Services (Germany). * Copyright (C) 2013 * Authors: Thomas Kothmayr and Corinna Schmitt (schmitt[at]net.in.tum.de) * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, version 3 of the License * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * * * eCos Licence: (http://ecos.sourceware.org) * * This file is part of eCos, the Embedded Configurable Operating System. * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, * 2007, 2008, 2009 Free Software Foundation, Inc. * * eCos is free software; you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free * Software Foundation; either version 3 any later version. * * eCos is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * * You should have received a copy of the GNU General Public License along * with eCos; if not, write to the Free Software Foundation, Inc., 51 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * As a special exception, if other files instantiate templates or use * macros or inline functions from this file, or you compile this file and * link it with other works to produce a work based on this file, this file * does not by itself cause the resulting work to be covered by the GNU * General Public License. However the source code for this file must still * be made available in accordance with section (3) of the GNU General * Public License v2. * * This exception does not invalidate any other reasons why a work based on * this file might be covered by the GNU General Public License. * */ Interface: tos.interfaces.PacketTimeStamp

Interface: tos.interfaces.PacketTimeStamp

interface PacketTimeStamp<typedef precision_tag, typedef size_type>

Commands
command void clear(message_t *msg)
command bool isValid(message_t *msg)
command void set(message_t *msg, size_type value)
command size_type timestamp(message_t *msg)

Commands - Details

clear

command void clear(message_t *msg)

Parameters:
'message_t *ONE msg' Message to modify. Sets the isValid flag to FALSE.

isValid

command bool isValid(message_t *msg)

Parameters:
'message_t *ONE msg' Message to examine. Returns TRUE if the time stamp of the message is valid. Under special circumstances the radio chip might not be able to correctly assign a precise time value to an incoming packet (e.g. under very heavy traffic multiple interrupts can occur before they could be serviced, and even if capture registers are used, it is not possible to get the time stamp for the first or last unserviced event), in which case the time stamp value should not be used. It is recommended that the isValid command be called from the receive or sendDone event handler.

set

command void set(message_t *msg, size_type value)

Parameters:
'message_t *ONE msg' Message to modify. Sets the isValid flag to TRUE and the time stamp value to the specified value.

timestamp

command size_type timestamp(message_t *msg)

Parameters:
'message_t *ONE msg' Message to get timestamp from. Return the time stamp for the given message. Please check with the isValid command if this value can be relied upon. If this command is called after transmission, then the transmit time of the packet is returned (the time when the frame synchronization byte was transmitted). If this command is called after the message is received, the tne receive time of the message is returned. It is recommended that the timestamp command be called only from the receive or sendDone event handler.