]> rtime.felk.cvut.cz Git - frescor/fwp.git/blobdiff - fwp/lib/fwp/fwp.h
Added licence at the begining of file.
[frescor/fwp.git] / fwp / lib / fwp / fwp.h
index bb4bd720512b6a704100042ce00885a57b8c73be..7d671afee578840370c152438e05b2fafefffb16 100644 (file)
@@ -1,3 +1,68 @@
+/**************************************************************************/
+/* ---------------------------------------------------------------------- */
+/* Copyright (C) 2006 - 2008 FRESCOR consortium partners:                */
+/*                                                                       */
+/*   Universidad de Cantabria,              SPAIN                        */
+/*   University of York,                    UK                           */
+/*   Scuola Superiore Sant'Anna,            ITALY                        */
+/*   Kaiserslautern University,             GERMANY                      */
+/*   Univ. Politécnica  Valencia,           SPAIN                       */
+/*   Czech Technical University in Prague,  CZECH REPUBLIC               */
+/*   ENEA                                   SWEDEN                       */
+/*   Thales Communication S.A.              FRANCE                       */
+/*   Visual Tools S.A.                      SPAIN                        */
+/*   Rapita Systems Ltd                     UK                           */
+/*   Evidence                               ITALY                        */
+/*                                                                       */
+/*   See http://www.frescor.org for a link to partners' websites         */
+/*                                                                       */
+/*          FRESCOR project (FP6/2005/IST/5-034026) is funded            */
+/*       in part by the European Union Sixth Framework Programme         */
+/*       The European Union is not liable of any use that may be         */
+/*       made of this code.                                              */
+/*                                                                       */
+/*                                                                       */
+/*  This file is part of FWP (Frescor WLAN Protocol)                     */
+/*                                                                       */
+/* FWP is free software; you can redistribute it and/or modify it        */
+/* under terms of the GNU General Public License as published by the     */
+/* Free Software Foundation; either version 2, or (at your option) any   */
+/* later version.  FWP is distributed in the hope that it will be        */
+/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty   */
+/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU   */
+/* General Public License for more details. You should have received a   */
+/* copy of the GNU General Public License along with FWP; see file       */
+/* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,  */
+/* Cambridge, MA 02139, USA.                                             */
+/*                                                                       */
+/* As a special exception, including FWP header files in a file,         */
+/* instantiating FWP generics or templates, or linking other files       */
+/* with FWP objects to produce an executable application, does not       */
+/* by itself cause the resulting executable application to be covered    */
+/* by the GNU General Public License. This exception does not            */
+/* however invalidate any other reasons why the executable file might be  */
+/* covered by the GNU Public License.                                    */
+/**************************************************************************/
+
+/**
+@mainpage
+
+@section Introduction
+
+FRESCOR WLAN protocol (FWP) allows the application to specify its requirements 
+(number of bytes transmitted per period, deadline, etc.) for communication over 
+IEEE 802.11 WLAN network and proides the mechanism that tries to fulfill them if 
+they are feasible.
+
+FWP’s goal is to adapt applications to the current conditions on WLAN network 
+rather than guaranteeing realtime behavior. FWP is designed to work on 
+hardware conforming to WMM specification which defines EDCA medium access 
+mechanism. EDCA extends legacy DCF function by prioritized medium access so 
+that the packets in higher priority queue have higher probability to access 
+the medium first.
+
+*/
+
 #ifndef _FWP_H
 #define _FWP_H
 
@@ -9,8 +74,6 @@
 #include "fwp_conf.h"
 #include "fwp_vres.h"
 #include "fwp_endpoint.h"
-//#include "fwp_contract.h"
-//#include "fwp_mngt.h"
 
 int fwp_init(void);
 int fwp_done(void);