src/executor.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  * @file   executor.h
  48  * @author Michal Sojka <sojkam1@fel.cvut.cz>
  49  * @date   Sun Oct 12 16:19:24 2008
  50  *
  51  * @brief  Executor type and prototypes.
  52  *
  53  *
  54  */
  55
  56 #ifndef EXECUTOR_H
  57 #define EXECUTOR_H
  58
  59 #include <fosa.h>
  60 #include <ul_list.h>
  61 #include <forb/object_type.h>
  62
  63 /**
  64  * Executor structure.
  65  *
  66  * Executors provide a way for applications to determine which thread
  67  * will execute requests for a particular object. After the executor
  68  * structure is initialized by forb_executor_init(), several objects
  69  * can be registered to it by forb_executor_register_object(). Then a
  70  * loop which waits for requests and executes them by calling object
  71  * implementations is started by forb_executor_run().
  72  */
  73 typedef struct forb_executor {
  74         fosa_mutex_t mutex;     /**< Mutex for protecting forb_executor_t::requests. */
  75         fosa_cond_t new_request_in_empty_list; /**< Signaled when a request was added to the empty list. */
  76         ul_list_head_t requests; /**< List of pending requests for this executor. */
  77 } forb_executor_t;
  78
  79
  80 int forb_executor_prepare(void);
  81 int forb_executor_init(forb_executor_t *executor);
  82 void forb_executor_destroy(forb_executor_t *executor);
  83 int forb_executor_register_object(forb_executor_t *executor, forb_object obj);
  84 void forb_executor_unregister_object(forb_executor_t *executor, forb_object obj);
  85 int forb_executor_run(forb_executor_t *executor);
  86
  87 int forb_execute_object(forb_object obj);
  88 forb_executor_t *forb_get_current_executor(void);
  89
  90 #endif