fwp/lib/fwp/fwp_endpoint.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_ENDPOINT_H
  47 #define _FWP_ENDPOINT_H
  48
  49 #define FWP_ANY_NODE INADDR_ANY
  50
  51 typedef enum {
  52         FWP_EPOINT_BESTEFFORT   = 0,
  53         FWP_EPOINT_RELIABLE     = 1,
  54 } fwp_endpoint_reliability_t;
  55
  56 struct fwp_endpoint;
  57
  58 typedef unsigned int fwp_addr_t;
  59
  60 /**
  61  * Endpoint attributes
  62  */
  63 typedef
  64 struct fwp_endpoint_attr {
  65         /** Specifies whether fwp endpoint is reliable (TCP) or not (UDP)*/
  66         unsigned int reliability;
  67         /** Specifies max number of allowed connections (for TCP only) */
  68         unsigned int max_connections;
  69 } fwp_endpoint_attr_t;
  70
  71 #include "fwp_vres.h"
  72
  73 int fwp_endpoint_get_params(struct fwp_endpoint *ep, unsigned int *node,
  74                                 unsigned int *port, fwp_endpoint_attr_t *attr);
  75 int fwp_send_endpoint_create(unsigned int node, unsigned int port,
  76                                 fwp_endpoint_attr_t *attr,
  77                                 struct fwp_endpoint **epoint);
  78 int fwp_receive_endpoint_create(/*unsigned int node,*/ unsigned int port,
  79                                 fwp_endpoint_attr_t *attr,
  80                                 struct fwp_endpoint **epoint);
  81 int fwp_endpoint_destroy(struct fwp_endpoint *ep);
  82
  83 int fwp_send_endpoint_bind(struct fwp_endpoint *ep, fwp_vres_t *vres);
  84 int fwp_send_endpoint_unbind(struct fwp_endpoint *ep);
  85
  86 ssize_t fwp_recv(struct fwp_endpoint *ep,
  87                         void *buffer, const size_t buffer_size,
  88                         unsigned int *from, int flags);
  89 int fwp_send_sync(struct fwp_endpoint *ep, void *msg, const size_t size);
  90 int fwp_send_async(struct fwp_endpoint *ep, void *msg, const size_t size);
  91 ssize_t fwp_endpoint_do_send(struct fwp_endpoint *ep,
  92                              void *data, const size_t size);
  93 int fwp_endpoint_attr_init(fwp_endpoint_attr_t *attr);
  94
  95 static inline int fwp_endpoint_attr_setreliability(fwp_endpoint_attr_t *attr,
  96                                                         int reliability)
  97 {
  98         attr->reliability = reliability;
  99         return 0;
 100 }
 101
 102 /* Sets queueing policy */
 103 /*int fwp_endpoint_attr_setqpolicy(fwp_endpoint_attr_t *attr);*/
 104 #ifdef _FWP_INTERNALS_
 105
 106 int fwp_endpoint_table_init(unsigned int nr_endpoints);
 107
 108 #endif /*_FWP_INTERNALS_*/
 109 #endif /*_FWP_ENDPOINT_H */