fwp/lib/fwp/fwp.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
  47 /**
  48 @mainpage
  49
  50 @section Introduction
  51
  52 FRESCOR WLAN protocol (FWP) allows the application to specify its requirements
  53 (number of bytes transmitted per period, deadline, etc.) for communication over
  54 IEEE 802.11 WLAN network and proides the mechanism that tries to fulﬁll them if
  55 they are feasible.
  56
  57 FWP’s goal is to adapt applications to the current conditions on WLAN network
  58 rather than guaranteeing realtime behavior. FWP is designed to work on
  59 hardware conforming to WMM speciﬁcation which deﬁnes EDCA medium access
  60 mechanism. EDCA extends legacy DCF function by prioritized medium access so
  61 that the packets in higher priority queue have higher probability to access
  62 the medium ﬁrst.
  63
  64 */
  65
  66 #ifndef _FWP_H
  67 #define _FWP_H
  68
  69 #ifndef _FWP_CONFDEFS_H
  70 //#error fwp_confdefs.h not included
  71 #endif
  72
  73
  74 #include "fwp_conf.h"
  75 #include "fwp_vres.h"
  76 #include "fwp_endpoint.h"
  77
  78 int fwp_init(void);
  79 int fwp_done(void);
  80
  81 #endif /* _FWP_H */