frsh_distributed_types.h

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2009 FRESCOR consortium partners:
   3 //
   4 //    Universidad de Cantabria,              SPAIN
   5 //    University of York,                    UK
   6 //    Scuola Superiore Sant'Anna,            ITALY
   7 //    Kaiserslautern University,             GERMANY
   8 //    Univ. Politécnica  Valencia,           SPAIN
   9 //    Czech Technical University in Prague,  CZECH REPUBLIC
  10 //    ENEA                                   SWEDEN
  11 //    Thales Communication S.A.              FRANCE
  12 //    Visual Tools S.A.                      SPAIN
  13 //    Rapita Systems Ltd                     UK
  14 //    Evidence                               ITALY
  15 //
  16 //    See http://www.frescor.org for a link to partners' websites
  17 //
  18 //           FRESCOR project (FP6/2005/IST/5-034026) is funded
  19 //        in part by the European Union Sixth Framework Programme
  20 //        The European Union is not liable of any use that may be
  21 //        made of this code.
  22 //
  23 //
  24 //  based on previous work (FSF) done in the FIRST project
  25 //
  26 //   Copyright (C) 2005  Mälardalen University, SWEDEN
  27 //                       Scuola Superiore S.Anna, ITALY
  28 //                       Universidad de Cantabria, SPAIN
  29 //                       University of York, UK
  30 //
  31 //   FSF API web pages: http://marte.unican.es/fsf/docs
  32 //                      http://shark.sssup.it/contrib/first/docs/
  33 //
  34 //   This file is part of FRSH (FRescor ScHeduler)
  35 //
  36 //  FRSH is free software; you can redistribute it and/or modify it
  37 //  under terms of the GNU General Public License as published by the
  38 //  Free Software Foundation; either version 2, or (at your option) any
  39 //  later version.  FRSH is distributed in the hope that it will be
  40 //  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  41 //  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  42 //  General Public License for more details. You should have received a
  43 //  copy of the GNU General Public License along with FRSH; see file
  44 //  COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
  45 //  Cambridge, MA 02139, USA.
  46 //
  47 //  As a special exception, including FRSH header files in a file,
  48 //  instantiating FRSH generics or templates, or linking other files
  49 //  with FRSH objects to produce an executable application, does not
  50 //  by itself cause the resulting executable application to be covered
  51 //  by the GNU General Public License. This exception does not
  52 //  however invalidate any other reasons why the executable file might be
  53 //  covered by the GNU Public License.
  54 // -----------------------------------------------------------------------
  55
  56 //==============================================
  57 //  ******** *******    ********  **      **
  58 //  **///// /**////**  **//////  /**     /**
  59 //  **      /**   /** /**        /**     /**
  60 //  ******* /*******  /********* /**********
  61 //  **////  /**///**  ////////** /**//////**
  62 //  **      /**  //**        /** /**     /**
  63 //  **      /**   //** ********  /**     /**
  64 //  //       //     // ////////   //      //
  65 //
  66 // FRSH(FRescor ScHeduler), pronounced "fresh"
  67 //==============================================
  68
  69 #ifndef   FRSH_DISTRIBUTED_TYPES_H_
  70 #define   FRSH_DISTRIBUTED_TYPES_H_
  71
  72 /**
  73  * @file frsh_distributed_types.h
  74  **/
  75
  76 #include "frsh_opaque_types.h"
  77
  78 FRSH_CPP_BEGIN_DECLS
  79
  80 /**
  81  * @addtogroup distributed
  82  *
  83  * @{
  84  **/
  85
  86 //opaque types for frsh endpoints
  87 typedef FRSH_SEND_ENDPOINT_T_OPAQUE frsh_send_endpoint_t;
  88 typedef FRSH_RECEIVE_ENDPOINT_T_OPAQUE frsh_receive_endpoint_t;
  89
  90 /**
  91  * The network_address type specifies the node or multicast address in
  92  * a communication-protocol-independent way. The actual address is
  93  * obtained via a configuration dependent mapping function
  94  **/
  95 typedef unsigned int frsh_network_address_t;
  96
  97 /**
  98  * The port type specifies the information that is
  99  * necessary to get in contact with the thread in the
 100  * receiving node, in a protocol-independent way.
 101  * The actual port number is obtained via a configuration
 102  * dependent mapping function
 103  **/
 104 typedef unsigned int frsh_stream_id_t;
 105
 106 /**
 107  * Extra information protocol dependent opaque for the application.
 108  * It can be used in different places: contract negotiation, extra
 109  * endpoint info, extra status info...
 110  **/
 111 typedef struct {
 112     void *body;
 113     int size;
 114 } frsh_protocol_info_t;
 115
 116 /**
 117  * Protocol dependent information about the status of an endpoint
 118  **/
 119 typedef struct {
 120    void *body;
 121    int size;
 122 } frsh_protocol_status_t;
 123
 124 /**
 125  * Protocol dependent information about extra parameters for
 126  * send_endpoint definition.
 127  **/
 128 typedef struct {
 129    void *body;
 130    int size;
 131 } frsh_send_endpoint_protocol_info_t;
 132
 133 /**
 134  * Protocol dependent information about extra parameters for
 135  * receive_endpoint definition.
 136  **/
 137 typedef struct {
 138    void *body;
 139    int size;
 140 } frsh_receive_endpoint_protocol_info_t;
 141
 142 /**
 143  * Algorithm used when the queue is full to choose the message to reject
 144  **/
 145 typedef enum {
 146     /** A new message is admitted rejecting the oldest message in the
 147         queue to make room for the newcomer **/
 148     FRSH_QRP_OLDEST,
 149
 150     /** Incoming messages are rejected if the queue is full **/
 151     FRSH_QRP_NEWCOMER
 152 } frsh_queue_rejection_policy_t;
 153
 154 /**
 155  * Queing information for endpoints
 156  **/
 157 typedef struct {
 158     int queue_size;  /** Size 0 means that there is no queue **/
 159     frsh_queue_rejection_policy_t queue_policy;
 160 } frsh_endpoint_queueing_info_t;
 161
 162
 163 typedef enum {
 164     /** Network works OK **/
 165     FRSH_ENS_UP,
 166
 167     /** Network is down **/
 168     FRSH_ENS_DOWN
 169 } frsh_endpoint_network_status_t;
 170
 171 /*@}*/
 172
 173 FRSH_CPP_END_DECLS
 174
 175 #endif  /* !FRSH_DISTRIBUTED_TYPES_H_ */