src_frescan/frescan_bwres_requests.h

   1 /*!
   2  * @file frescan_bwres_requests.h
   3  *
   4  * @brief FRESCAN bandwith reservation layer: requests
   5  *
   6  * This module contains the request type definition and queues. They are used
   7  * to ask negotiation, renegotiation or cancel contracts.
   8  *
   9  * @version 0.01
  10  *
  11  * @date 1-Apr-2008
  12  *
  13  * @author Daniel Sangorrin <daniel.sangorrin@unican.es>
  14  *
  15  * @license
  16  *
  17  * -----------------------------------------------------------------------
  18  *  Copyright (C) 2006 - 2008 FRESCOR consortium partners:
  19  *
  20  *    Universidad de Cantabria,              SPAIN
  21  *    University of York,                    UK
  22  *    Scuola Superiore Sant'Anna,            ITALY
  23  *    Kaiserslautern University,             GERMANY
  24  *    Univ. Politécnica  Valencia,           SPAIN
  25  *    Czech Technical University in Prague,  CZECH REPUBLIC
  26  *    ENEA                                   SWEDEN
  27  *    Thales Communication S.A.              FRANCE
  28  *    Visual Tools S.A.                      SPAIN
  29  *    Rapita Systems Ltd                     UK
  30  *    Evidence                               ITALY
  31  *
  32  *    See http://www.frescor.org for a link to partners' websites
  33  *
  34  *           FRESCOR project (FP6/2005/IST/5-034026) is funded
  35  *        in part by the European Union Sixth Framework Programme
  36  *        The European Union is not liable of any use that may be
  37  *        made of this code.
  38  *
  39  *  This file is part of FRESCAN
  40  *
  41  *  FRESCAN is free software; you can  redistribute it and/or  modify
  42  *  it under the terms of  the GNU General Public License as published by
  43  *  the Free Software Foundation;  either  version 2, or (at  your option)
  44  *  any later version.
  45  *
  46  *  FRESCAN  is distributed  in  the hope  that  it  will  be useful,  but
  47  *  WITHOUT  ANY  WARRANTY;     without  even the   implied   warranty  of
  48  *  MERCHANTABILITY  or  FITNESS FOR  A  PARTICULAR PURPOSE. See  the  GNU
  49  *  General Public License for more details.
  50  *
  51  *  You should have  received a  copy of  the  GNU  General Public License
  52  *  distributed  with  FRESCAN;  see file COPYING.   If not,  write to the
  53  *  Free Software  Foundation,  59 Temple Place  -  Suite 330,  Boston, MA
  54  *  02111-1307, USA.
  55  *
  56  * As a special exception, including FRESCAN header files in a file,
  57  * instantiating FRESCAN generics or templates, or linking other files
  58  * with FRESCAN objects to produce an executable application, does not
  59  * by itself cause the resulting executable application to be covered
  60  * by the GNU General Public License. This exception does not
  61  * however invalidate any other reasons why the executable file might be
  62  * covered by the GNU Public License.
  63  * -----------------------------------------------------------------------
  64  *
  65  */
  66
  67 #ifndef _FRESCAN_BWRES_REQUESTS_H_
  68 #define _FRESCAN_BWRES_REQUESTS_H_
  69
  70 #include "frescan_types.h"
  71
  72 extern int frescan_bwres_requests_init(int max_ceiling);
  73 extern int frescan_bwres_requests_alloc(frescan_bwres_request_id_t *req);
  74 extern int frescan_bwres_requests_free(frescan_bwres_request_id_t req);
  75 extern int frescan_bwres_requests_enqueue(frescan_bwres_request_id_t req);
  76 extern int frescan_bwres_requests_dequeue(frescan_bwres_request_id_t *req);
  77
  78 /**
  79  * frescan_bwres_requests_get_data() - gets the data of the request
  80  *
  81  * @data: the data is obtained as a pointer an manipulated directly
  82  *        accesing to the members of the structure. Note that this is
  83  *        just an internal API so instead of using get/set functions we
  84  *        will just access to the members of the struc directly
  85  */
  86
  87 extern int frescan_bwres_requests_get_data(frescan_bwres_request_id_t   req,
  88                                            frescan_bwres_request_data_t **data);
  89
  90 #endif // _FRESCAN_BWRES_REQUESTS_H_