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 /**************************************************************************/
48 * @author Michal Sojka <sojkam1@fel.cvut.cz>
49 * @date Sun Oct 12 16:19:24 2008
51 * @brief Executor type and prototypes.
61 #include <forb/object_type.h>
62 #include <forb/syncobj.h>
68 * Executors provide a way for applications to determine which thread
69 * will execute requests for a particular object. After the executor
70 * structure is initialized by forb_executor_init(), several objects
71 * can be registered to it by forb_executor_register_object(). Then a
72 * loop which waits for requests and executes them by calling object
73 * implementations is started by forb_executor_run().
75 typedef struct forb_executor {
76 fosa_mutex_t mutex; /**< Mutex for protecting forb_executor_t::requests. */
77 fosa_cond_t new_request_in_empty_list; /**< Signaled when a request was added to the empty list. */
78 ul_list_head_t requests; /**< List of pending requests for this executor. */
79 forb_syncobj_t reply_processed; /**< Synchronization object for signaling the receiver thread to continue processing after the reply is processed by a stub. */
80 bool finish; /**< Signals the executor to finish */
85 int forb_executor_prepare(void);
86 int forb_executor_init(forb_executor_t *executor);
87 void forb_executor_destroy(forb_executor_t *executor);
88 int forb_executor_register_object(forb_executor_t *executor, forb_object obj);
89 void forb_executor_unregister_object(forb_executor_t *executor, forb_object obj);
90 int forb_executor_run(forb_executor_t *executor);
91 void forb_executor_synchronize(forb_executor_t *executor);
93 int forb_execute_object(forb_object obj);
94 forb_executor_t *forb_get_current_executor(void);