src/fna/src_frescan/frescan_bwres_robjs.h

   1 /*!
   2  * @file frescan_bwres_robjs.h
   3  *
   4  * @brief FRESCAN bandwith reservation layer: reply objects
   5  *
   6  * This module contains the definition of the data object and operations to
   7  * create a pool of objects, obtain the id of an unused object, wait upon it,
   8  * signal it, and finish using it.
   9  *
  10  * @version 0.01
  11  *
  12  * @date 1-Apr-2008
  13  *
  14  * @author Daniel Sangorrin <daniel.sangorrin@unican.es>
  15  *
  16  * @license
  17  *
  18 //----------------------------------------------------------------------
  19 //  Copyright (C) 2006 - 2009 by the FRESCOR consortium:
  20 //
  21 //    Universidad de Cantabria,              SPAIN
  22 //    University of York,                    UK
  23 //    Scuola Superiore Sant'Anna,            ITALY
  24 //    Kaiserslautern University,             GERMANY
  25 //    Univ. Politecnica  Valencia,           SPAIN
  26 //    Czech Technical University in Prague,  CZECH REPUBLIC
  27 //    ENEA                                   SWEDEN
  28 //    Thales Communication S.A.              FRANCE
  29 //    Visual Tools S.A.                      SPAIN
  30 //    Rapita Systems Ltd                     UK
  31 //    Evidence                               ITALY
  32 //
  33 //    See http://www.frescor.org
  34 //
  35 //        The FRESCOR project (FP6/2005/IST/5-034026) is funded
  36 //        in part by the European Union Sixth Framework Programme
  37 //        The European Union is not liable of any use that may be
  38 //        made of this code.
  39 //
  40 //
  41 //  based on previous work (FSF) done in the FIRST project
  42 //
  43 //   Copyright (C) 2005  Mälardalen University, SWEDEN
  44 //                       Scuola Superiore S.Anna, ITALY
  45 //                       Universidad de Cantabria, SPAIN
  46 //                       University of York, UK
  47 //
  48 // This file is part of FNA (Frescor Network Adaptation)
  49 //
  50 // FNA is free software; you can redistribute it and/or modify it
  51 // under terms of the GNU General Public License as published by the
  52 // Free Software Foundation; either version 2, or (at your option) any
  53 // later version.  FNA is distributed in the hope that it will be
  54 // useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  55 // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  56 // General Public License for more details. You should have received a
  57 // copy of the GNU General Public License along with FNA; see file
  58 // COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
  59 // Cambridge, MA 02139, USA.
  60 //
  61 // As a special exception, including FNA header files in a file,
  62 // instantiating FNA generics or templates, or linking other files
  63 // with FNA objects to produce an executable application, does not
  64 // by itself cause the resulting executable application to be covered
  65 // by the GNU General Public License. This exception does not
  66 // however invalidate any other reasons why the executable file might be
  67 // covered by the GNU Public License.
  68 // -----------------------------------------------------------------------
  69  *
  70  */
  71
  72 #ifndef _FRESCAN_BWRES_ROBJS_H_
  73 #define _FRESCAN_BWRES_ROBJS_H_
  74
  75 #include "frescan_types.h"
  76
  77 extern int frescan_bwres_robjs_init(int max_ceiling);
  78 extern int frescan_bwres_robjs_alloc(frescan_bwres_robj_id_t *id, int ceiling);
  79 extern int frescan_bwres_robjs_free(frescan_bwres_robj_id_t id);
  80 extern int frescan_bwres_robjs_signal(frescan_bwres_robj_id_t id);
  81 extern int frescan_bwres_robjs_wait(frescan_bwres_robj_id_t id);
  82 extern int frescan_bwres_robjs_timedwait(frescan_bwres_robj_id_t id,
  83                                          const struct timespec *abstime);
  84
  85 #endif // _FRESCAN_BWRES_ROBJS_H_