fwp/lib/fwp/fwp_vres.h

   1 /**************************************************************************/
   2 /* ---------------------------------------------------------------------- */
   3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners:                 */
   4 /*                                                                        */
   5 /*   Universidad de Cantabria,              SPAIN                         */
   6 /*   University of York,                    UK                            */
   7 /*   Scuola Superiore Sant'Anna,            ITALY                         */
   8 /*   Kaiserslautern University,             GERMANY                       */
   9 /*   Univ. Politécnica  Valencia,           SPAIN                        */
  10 /*   Czech Technical University in Prague,  CZECH REPUBLIC                */
  11 /*   ENEA                                   SWEDEN                        */
  12 /*   Thales Communication S.A.              FRANCE                        */
  13 /*   Visual Tools S.A.                      SPAIN                         */
  14 /*   Rapita Systems Ltd                     UK                            */
  15 /*   Evidence                               ITALY                         */
  16 /*                                                                        */
  17 /*   See http://www.frescor.org for a link to partners' websites          */
  18 /*                                                                        */
  19 /*          FRESCOR project (FP6/2005/IST/5-034026) is funded             */
  20 /*       in part by the European Union Sixth Framework Programme          */
  21 /*       The European Union is not liable of any use that may be          */
  22 /*       made of this code.                                               */
  23 /*                                                                        */
  24 /*                                                                        */
  25 /*  This file is part of FWP (Frescor WLAN Protocol)                      */
  26 /*                                                                        */
  27 /* FWP is free software; you can redistribute it and/or modify it         */
  28 /* under terms of the GNU General Public License as published by the      */
  29 /* Free Software Foundation; either version 2, or (at your option) any    */
  30 /* later version.  FWP is distributed in the hope that it will be         */
  31 /* useful, but WITHOUT ANY WARRANTY; without even the implied warranty    */
  32 /* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU    */
  33 /* General Public License for more details. You should have received a    */
  34 /* copy of the GNU General Public License along with FWP; see file        */
  35 /* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,  */
  36 /* Cambridge, MA 02139, USA.                                              */
  37 /*                                                                        */
  38 /* As a special exception, including FWP header files in a file,          */
  39 /* instantiating FWP generics or templates, or linking other files        */
  40 /* with FWP objects to produce an executable application, does not        */
  41 /* by itself cause the resulting executable application to be covered     */
  42 /* by the GNU General Public License. This exception does not             */
  43 /* however invalidate any other reasons why the executable file might be  */
  44 /* covered by the GNU Public License.                                     */
  45 /**************************************************************************/
  46 #ifndef _FWP_VRES_H
  47 #define _FWP_VRES_H
  48
  49 #include <netinet/in.h>
  50
  51 struct fwp_vres;
  52 typedef struct fwp_vres fwp_vres_t;
  53
  54 /** WMM defines 4 queues */
  55 typedef enum  {
  56         FWP_AC_VO = 0,
  57         FWP_AC_VI = 1,
  58         FWP_AC_BE = 2,
  59         FWP_AC_BK = 3
  60 } fwp_ac_t;
  61
  62 fwp_ac_t fwp_vres_get_ac(fwp_vres_t *vres);
  63
  64
  65 #ifdef _FWP_INTERNALS_
  66
  67 #include "fwp_msgb.h"
  68
  69 typedef unsigned int fwp_vres_id_t;
  70 typedef unsigned int fwp_vparam_id_t;
  71 typedef unsigned long int fwp_budget_t;
  72 typedef struct timespec  fwp_period_t;
  73
  74 /**
  75  * FWP vres parameters
  76  *
  77  */
  78 typedef
  79 struct fwp_vres_params {
  80         fwp_budget_t    budget;         /**< bytes per period */
  81         /** all time units are in microseconds */
  82         fwp_period_t    period;
  83         fwp_ac_t        ac_id;          /**< AC id ~ priority of vres */
  84         /** Forced source address. If non-zero, packets are sent over
  85          * the specified interface. */
  86         struct in_addr  src;
  87 } fwp_vres_params_t;
  88
  89 int fwp_vres_table_init(unsigned int max_vres);
  90
  91 fwp_vres_t *fwp_vres_alloc();
  92 fwp_vres_id_t fwp_vres_get_id(fwp_vres_t *vres);
  93 int fwp_vres_set_params(fwp_vres_t *vres, fwp_vres_params_t *params);
  94 int fwp_vres_create(fwp_vres_params_t *params, fwp_vres_t **vresp);
  95 int fwp_vres_destroy(fwp_vres_t *vres);
  96
  97 int fwp_vres_send(fwp_vres_t *vres, struct fwp_msgb* msgb);
  98 int fwp_vres_bind(fwp_vres_t *vres, int sockd);
  99 int fwp_vres_unbind(fwp_vres_t *vres);
 100
 101 extern fwp_vres_params_t fwp_vres_params_default;
 102
 103 #endif /* _FWP_INTERNALS_ */
 104 #endif /* _FWP_VRES_H */