/** * 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.BigQueue

Interface: tos.interfaces.BigQueue

interface BigQueue<typedef t>

Interface to a FIFO list (queue) that contains items of a specific type. The queue has a maximum size.

Author:
Philip Levis
Kyle Jamieson
Date:
$Date: 2007/09/19 17:29:17 $

Commands
command t dequeue() Remove the head of the queue.
command t element(uint16_t idx) Return the nth element of the queue without dequeueing it, where 0 is the head of the queue and (size - 1) is the tail.
command bool empty() Returns if the queue is empty.
command error_t enqueue(t newVal) Enqueue an element to the tail of the queue.
command t head() Get the head of the queue without removing it.
command uint16_t maxSize() The maximum number of elements the queue can hold.
command uint16_t size() The number of elements currently in the queue.

Commands - Details

dequeue

command t dequeue()

Remove the head of the queue. If the queue is empty, the return value is undefined.

Returns:
The head of the queue.

element

command t element(uint16_t idx)

Return the nth element of the queue without dequeueing it, where 0 is the head of the queue and (size - 1) is the tail. If the element requested is larger than the current queue size, the return value is undefined.

Parameters:
index - - the index of the element to return
Returns:
the requested element in the queue.

empty

command bool empty()

Returns if the queue is empty.

Returns:
Whether the queue is empty.

enqueue

command error_t enqueue(t newVal)

Enqueue an element to the tail of the queue.

Parameters:
newVal - - the element to enqueue
Returns:
SUCCESS if the element was enqueued successfully, FAIL if it was not enqueued.

head

command t head()

Get the head of the queue without removing it. If the queue is empty, the return value is undefined.

Returns:
The head of the queue.

maxSize

command uint16_t maxSize()

The maximum number of elements the queue can hold.

Returns:
The maximum queue size.

size

command uint16_t size()

The number of elements currently in the queue. Always less than or equal to maxSize().

Returns:
The number of elements in the queue.