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 - 2008 FRESCOR consortium partners:
  20  *
  21  *    Universidad de Cantabria,              SPAIN
  22  *    University of York,                    UK
  23  *    Scuola Superiore Sant'Anna,            ITALY
  24  *    Kaiserslautern University,             GERMANY
  25  *    Univ. Politécnica  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 for a link to partners' websites
  34  *
  35  *           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  *  This file is part of FRESCAN
  41  *
  42  *  FRESCAN is free software; you can  redistribute it and/or  modify
  43  *  it under the terms of  the GNU General Public License as published by
  44  *  the Free Software Foundation;  either  version 2, or (at  your option)
  45  *  any later version.
  46  *
  47  *  FRESCAN  is distributed  in  the hope  that  it  will  be useful,  but
  48  *  WITHOUT  ANY  WARRANTY;     without  even the   implied   warranty  of
  49  *  MERCHANTABILITY  or  FITNESS FOR  A  PARTICULAR PURPOSE. See  the  GNU
  50  *  General Public License for more details.
  51  *
  52  *  You should have  received a  copy of  the  GNU  General Public License
  53  *  distributed  with  FRESCAN;  see file COPYING.   If not,  write to the
  54  *  Free Software  Foundation,  59 Temple Place  -  Suite 330,  Boston, MA
  55  *  02111-1307, USA.
  56  *
  57  * As a special exception, including FRESCAN header files in a file,
  58  * instantiating FRESCAN generics or templates, or linking other files
  59  * with FRESCAN objects to produce an executable application, does not
  60  * by itself cause the resulting executable application to be covered
  61  * by the GNU General Public License. This exception does not
  62  * however invalidate any other reasons why the executable file might be
  63  * covered by the GNU Public License.
  64  * -----------------------------------------------------------------------
  65  *
  66  */
  67
  68 #ifndef _FRESCAN_BWRES_ROBJS_H_
  69 #define _FRESCAN_BWRES_ROBJS_H_
  70
  71 #include <time.h> /* for timespec */
  72 #include "fosa_opaque_types.h" /* for FOSA_ETIMEDOUT */
  73
  74 typedef unsigned int frescan_robj_id_t; /* 0 .. MX_REPLY_OBJECTS-1 */
  75 #define FRESCAN_ETIMEDOUT FOSA_ETIMEDOUT
  76
  77 extern int frescan_bwres_robjs_init(int max_ceiling);
  78 extern int frescan_bwres_robjs_alloc(frescan_robj_id_t *id, int ceiling);
  79 extern int frescan_bwres_robjs_free(frescan_robj_id_t id);
  80 extern int frescan_bwres_robjs_signal(frescan_robj_id_t id);
  81 extern int frescan_bwres_robjs_wait(frescan_robj_id_t id);
  82 extern int frescan_bwres_robjs_timedwait(frescan_robj_id_t id,
  83                                          const struct timespec *abstime);
  84
  85 #endif // _FRESCAN_BWRES_ROBJS_H_