src/port.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 FORB (Frescor Object Request Broker)             */
  26 /*                                                                        */
  27 /* FORB 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.  FORB 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 FORB; 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 FORB header files in a file,         */
  39 /* instantiating FORB generics or templates, or linking other files       */
  40 /* with FORB 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 #ifndef FORB_PORT_H
  48 #define FORB_PORT_H
  49
  50 #include <forb/forb-internal.h>
  51 #include <forb/syncobj.h>
  52
  53 struct forb_proto;
  54
  55 /**
  56  * Represents one (of possibly multiple) ports using a specific
  57  * FORB transport protocol (see ::forb_proto).
  58  */
  59 struct forb_port {
  60         const struct forb_proto *proto;   /**< Protocol used on this port */
  61         void *proto_priv;                 /**< Protocol specific data */
  62         forb_t *forb;                     /**< FORB, this port is registered in. */
  63         fosa_thread_id_t receiver_thread; /**< The thread running forb_port_receiver_thread() */
  64         fosa_thread_id_t discovery_thread;/**< The thread for periodic sending HELLO messages */
  65         forb_syncobj_t hello;             /**< Synchronization object for signaling the discovery thread to send the hello messages now. */
  66         forb_syncobj_t reply_processed;   /**< Synchronization object for signaling the receiver thread to continue processing after the reply is processed by a stub. */
  67         CDR_Codec codec;                  /**< Receiving buffer for receiver thread */
  68         void *addr;                       /**< Port's address in a protocol specific format. */
  69         ul_list_node_t node;              /**< Node in forb's port list */
  70         gavl_cust_root_field_t peers;     /**< Peers discovered on this port by discovery protocol */
  71         bool finish;                      /**< True when the threads should finish their execution, false otherwise. */
  72 };
  73
  74 typedef struct forb_port forb_port_t;
  75
  76 UL_LIST_CUST_DEC(forb_port,     /* cust_prefix */
  77                  forb_t,        /* cust_head_t */
  78                  forb_port_t,   /* cust_item_t */
  79                  ports,         /* cust_head_field */
  80                  node)          /* cust_node_field */
  81
  82 int forb_register_port(forb_t *forb, forb_port_t *port);
  83 void forb_destroy_port(forb_port_t *port);
  84
  85
  86 #endif