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 FORB (Frescor Object Request Broker) */
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. */
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 /**************************************************************************/
49 * @author Michal Sojka <sojkam1@fel.cvut.cz>
50 * @date Sun Oct 12 17:36:39 2008
52 * @brief Declarations of port types and functions.
60 #include <forb/forb-internal.h>
61 #include <forb/syncobj.h>
66 * Description of a port. Needs to be filled for forb_register_port().
68 struct forb_port_desc {
69 const struct forb_proto *proto; /**< Protocol used on this port */
70 void *proto_priv; /**< Protocol specific data */
71 void *addr; /**< Port's address in a protocol specific format. */
75 * Represents one (of possibly multiple) ports using a specific
76 * FORB transport protocol (see ::forb_proto).
78 * Every port runs its own thread for receiving messages
79 * (forb_iop_receiver_thread()) and another thread
80 * (forb_iop_discovery_thread()) for periodic broadcasting of HELLO
81 * messages to discover peers connected to the same network.
83 typedef struct forb_port {
84 struct forb_port_desc desc; /**< Description of the port */
85 forb_t *forb; /**< FORB, this port is registered in. */
86 fosa_thread_id_t receiver_thread; /**< The thread running forb_port_receiver_thread() */
87 fosa_thread_id_t discovery_thread;/**< The thread for periodic sending HELLO messages */
88 forb_syncobj_t hello; /**< Synchronization object for signaling the discovery thread to send the hello messages now. */
89 forb_syncobj_t reply_processed; /**< Synchronization object for signaling the receiver thread to continue processing after the reply is processed by a stub. */
90 FORB_CDR_Codec codec; /**< Receiving buffer for receiver thread */
91 ul_list_node_t node; /**< Node in forb's port list */
92 ul_list_head_t peers; /**< Peers discovered on this port by discovery protocol */
93 bool finish; /**< True when the threads should finish their execution, false otherwise. */
96 UL_LIST_CUST_DEC(forb_port, /* cust_prefix */
97 forb_t, /* cust_head_t */
98 forb_port_t, /* cust_item_t */
99 ports, /* cust_head_field */
100 node) /* cust_node_field */
102 int forb_register_port(forb_t *forb, forb_port_t *port);
103 void forb_destroy_port(forb_port_t *port);