1 /**************************************************************************/
2 /* ---------------------------------------------------------------------- */
3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners: */
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 */
12 /* Thales Communication S.A. FRANCE */
13 /* Visual Tools S.A. SPAIN */
14 /* Rapita Systems Ltd UK */
17 /* See http://www.frescor.org for a link to partners' websites */
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. */
25 /* This file is part of FWP (Frescor WLAN Protocol) */
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. */
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 /**************************************************************************/
49 #include <netinet/in.h>
53 typedef struct fwp_vres fwp_vres_t;
55 /** WMM defines 4 queues */
63 fwp_ac_t fwp_vres_get_ac(fwp_vres_t *vres);
66 #ifdef _FWP_INTERNALS_
70 typedef unsigned int fwp_vres_id_t;
71 typedef unsigned int fwp_vparam_id_t;
72 typedef unsigned long int fwp_budget_t;
73 typedef struct timespec fwp_period_t;
80 struct fwp_vres_params {
81 fwp_budget_t budget; /**< bytes per period */
82 /** all time units are in microseconds */
84 fwp_ac_t ac_id; /**< AC id ~ priority of vres */
88 fwp_vres_t *fwp_vres_alloc();
89 int fwp_vres_set_params(fwp_vres_t *vres, fwp_vres_params_t *params);
90 int fwp_vres_create(fwp_vres_params_t *params, fwp_vres_t **vresp);
91 int fwp_vres_destroy(fwp_vres_t *vres);
93 int fwp_vres_consume_budget(struct fwp_vres *vres, size_t size, bool can_block);
95 int fwp_vres_enqueue(struct fwp_vres *vres, struct fwp_endpoint *ep,
96 const void *msg, size_t size);
97 int fwp_vres_bind(fwp_vres_t *vres, struct fwp_endpoint *ep, int sockd, struct in_addr *src);
98 int fwp_vres_unbind(fwp_vres_t *vres);
100 extern fwp_vres_params_t fwp_vres_params_default;
102 #endif /* _FWP_INTERNALS_ */
103 #endif /* _FWP_VRES_H */