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

Interface: tos.interfaces.ResourceQueue

interface ResourceQueue

A queue interface for managing client ids when performing resource arbitration. A single slot in the queue is guaranteed to each resource client, with the actual queing policy determined by the implementation of the interface.

Author:
Kevin Klues <klueska@cs.wustl.edu>
Date:
$Date: 2006/12/12 18:23:15 $

Commands
command resource_client_id_t dequeue() Retreive the cleint id of the next resource in the queue.
command error_t enqueue(resource_client_id_t id) Enqueue a cleint id
command bool isEmpty() Check to see if the queue is empty.
command bool isEnqueued(resource_client_id_t id) Check to see if a given cleint id has already been enqueued and is waiting to be processed.

Commands - Details

dequeue

command resource_client_id_t dequeue()

Retreive the cleint id of the next resource in the queue. If the queue is empty, the return value is undefined.

Returns:
The cleint id at the head of the queue.

enqueue

command error_t enqueue(resource_client_id_t id)

Enqueue a cleint id

Parameters:
cleintId - - the cleint id to enqueue
Returns:
SUCCESS if the client id was enqueued successfully
EBUSY if it has already been enqueued.

isEmpty

command bool isEmpty()

Check to see if the queue is empty.

Returns:
TRUE if the queue is empty.
FALSE if there is at least one entry in the queue

isEnqueued

command bool isEnqueued(resource_client_id_t id)

Check to see if a given cleint id has already been enqueued and is waiting to be processed.

Returns:
TRUE if the client id is in the queue.
FALSE if it does not